Memperluas Oktobercms - Membina Plugin Lembut Delete

Oktobercms: Eksplorasi mendalam mengenai pemanjangan plug-in dan penyingkiran perisian praktikal pemalam

pemaju umumnya lebih suka CMS yang mudah digunakan dan berskala. OktoberCMS mematuhi konsep kesederhanaan terlebih dahulu, membawa pengalaman yang menyenangkan kepada pemaju dan pengguna. Artikel ini menunjukkan beberapa ciri-ciri yang boleh dilanjutkan dari OktoberCMS dan memanjangkan fungsi pemalam yang lain dengan pemalam yang mudah.

mata utama

OktoberCMS menyediakan CMS yang mudah dan mudah digunakan sambil membenarkan sambungan melalui pemalam. Skala ini dicerminkan sejauh mana pemaju dapat menembusi mekanisme dalaman CMS, termasuk mengubahsuai fungsi pemaju pemaju lain.

• Plugin Blog Rainlab membolehkan anda membuat artikel dan memberikannya kepada kategori yang berbeza. Tutorial ini menunjukkan cara memperluaskan plugin ini, menambah ciri -ciri padam lembut, menghalang artikel daripada dipadam secara kekal, tetapi sebaliknya menandakannya sebagai "dipadam" dan merekodkan cap waktu.
3 Bidang ini akan menjimatkan cap waktu untuk penghapusan artikel. Plugin kemudian memanjangkan senarai artikel untuk memasukkan medan baru ini sebagai lajur dan menambah penapis untuk menunjukkan atau menyembunyikan artikel yang dipadam.
Langkah terakhir dalam mewujudkan fungsi padam lembut adalah untuk memintas operasi penghapusan artikel dan mengemas kini lajur
• . Ini dilakukan dengan melampirkan ke acara deleted_at yang dicetuskan oleh fasih, menghalang penghapusan rekod. Sebaliknya, medan
akan dikemas kini ke cap waktu semasa dan rekod akan disimpan.
• deleted_at deleting Pengenalan deleted_at Setiap CMS mempunyai sistem pemalam untuk memperluaskan fungsi platform, dan kami mengukur skalabilitasnya dengan sejauh mana kita dapat menembusi mekanisme dalaman CMS. Walau bagaimanapun, kita bercakap tentang bukan sahaja CMS itu sendiri, tetapi juga pemalam!

Jika anda membina plugin, anda perlu memastikan pemaju lain dapat mengubah beberapa ciri anda. Sebagai contoh, kami mempunyai plugin blog di mana pengguna boleh menerbitkan artikel dengan memilih artikel dalam senarai. Adalah lebih baik untuk mencetuskan acara untuk menunjukkan bahawa artikel baru telah diterbitkan, pemaju lain boleh dipasang ke acara ini dan memberitahu pelanggan melalui e -mel!

pemaju lain boleh mendengar acara ini untuk mengendalikan artikel yang diterbitkan.

kami akan menggunakan peristiwa untuk menyambungkan bahagian -bahagian yang berlainan dari kitaran permintaan. Mari kita mulakan dengan contoh konkrit untuk lebih memahami.

class Posts extends Controller
{
    public function index_onPublish()
    {
        if (($checkedIds = post('checked')) && is_array($checkedIds) && count($checkedIds)) {

            foreach ($checkedIds as $postId) {
                if ((!$post = Post::find($postId)) || !$post->canEdit($this->user))
                    continue;

                $post->publish();
                Event::fire('rainlab.blog.posts.published', [$post]);
            }

            Flash::success('Successfully published those posts.');
        }

        return $this->listRefresh();
    }
}

Rainlab Blog Plugin

Event::listen('rainlab.blog.posts.published', function($post) {
    User::subscribedTo($post)->each(function($user) use($post) {
        Mail::send('emails.notifications.post-published', ['user' => $user, 'post' => $post], function($message) use($user, $post) {
            $message->from('us@example.com', 'New post by ' . $user->name);

            $message->to($user->email);
        });
    });
});

Jika anda telah menggunakan OktoberCMS untuk seketika, anda mesti tahu mengenai plugin Rainlab Blog. Ia membolehkan anda menambah artikel di backend dan melampirkannya ke kategori, dan anda boleh menggunakan komponen untuk memaparkannya di bahagian depan.

Pada halaman senarai artikel, kami boleh memadamkan artikel. Tetapi bagaimana jika kita mahu memadamkannya dengan lembut? Mari kita lihat jika kita boleh melakukan ini dan mengetahui lebih lanjut mengenai skalabiliti OktoberCMS.

Buat plug-in baru

Buat plugin baru untuk demo kami menggunakan perintah pembantu perancah dan kemas kini butiran plugin dalam fail plugin.php.

class Posts extends Controller
{
    public function index_onPublish()
    {
        if (($checkedIds = post('checked')) && is_array($checkedIds) && count($checkedIds)) {

            foreach ($checkedIds as $postId) {
                if ((!$post = Post::find($postId)) || !$post->canEdit($this->user))
                    continue;

                $post->publish();
                Event::fire('rainlab.blog.posts.published', [$post]);
            }

            Flash::success('Successfully published those posts.');
        }

        return $this->listRefresh();
    }
}

mod pangkalan data yang dilanjutkan

Apabila bercakap tentang pemadaman lembut, perkara pertama yang masuk ke dalam fikiran ialah lajur medan deleted_at yang perlu wujud dalam pangkalan data.

Buat fail baru bernama blogplus/updates di bawah folder create_posts_deleted_at_field.php dan kemas kini fail version.yaml.

Event::listen('rainlab.blog.posts.published', function($post) {
    User::subscribedTo($post)->each(function($user) use($post) {
        Mail::send('emails.notifications.post-published', ['user' => $user, 'post' => $post], function($message) use($user, $post) {
            $message->from('us@example.com', 'New post by ' . $user->name);

            $message->to($user->email);
        });
    });
});

php artisan create:plugin rafie.blogplus

Migrasi kelas mengubah jadual rainlab_blog_posts dan menambah lajur deleted_at kami, yang mungkir ke NULL. Jangan lupa untuk menjalankan perintah php artisan plugin:refresh rafie.blogplus untuk membuat perubahan berkuatkuasa.

Senarai Artikel Extended

Seterusnya kita perlu menambah medan kita sebagai lajur ke senarai untuk paparan. OktoberCMS memberikan kami acara untuk melancarkan dan menukar widget yang sedang dipaparkan (senarai backend dianggap sebagai widget).

# updates/version.yaml

1.0.1:
    - First version of blogplus.
    - create_posts_deleted_at_field.php

Nota: Kod di atas harus diletakkan dalam kaedah

. Plugin@boot

Kami mempunyai pernyataan IF untuk mengelakkan kod kami daripada melaksanakan pada setiap halaman, dan kemudian kami menambah lajur baru ke widget senarai, dan kami juga boleh menggunakan kaedah

untuk memadam mana -mana lajur yang ada. Semak dokumentasi untuk senarai pilihan lajur yang tersedia. removeColumn

Penapis lanjutan

lajur di bahagian atas senarai artikel membolehkan pengguna menapis senarai menggunakan tarikh, kategori, dan lain -lain. Dalam kes kita, kita memerlukan penapis untuk menunjukkan/menyembunyikan artikel yang dipadam.

Anda boleh membaca lebih lanjut mengenai penapis senarai dalam dokumentasi. Kod di atas agak mudah dan hanya mengandungi beberapa pilihan. Walau bagaimanapun, atribut

# updates/create_posts_deleted_at_field.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreatePostsDeletedAtField extends Migration
{
    public function up()
    {
        Schema::table('rainlab_blog_posts', function (Blueprint $table) {
            $table->timestamp('deleted_at')->nullable()->default(null);
        });
    }

    public function down()
    {
        Schema::table('rainlab_blog_posts', function (Blueprint $table) {
            $table->dropColumn('deleted_at');
        });
    }
}

hendaklah menjadi nama kaedah skop pertanyaan yang ditakrifkan dalam contoh model

. scope Models\Post kelas extensible

TRAIT OCTORTRAINEXTENETEXTendableTrait menyediakan

Magic

Kaedah untuk melanjutkan kelas sedia ada dengan menambahkan kaedah baru, atribut, tingkah laku, dll. Dalam contoh kami, kami perlu menambah kaedah baru kepada model artikel untuk mengendalikan penapis skop kami.

kita boleh melakukan perkara yang sama untuk

// plugin.php  在Plugin类的boot方法中

Event::listen('backend.list.extendColumns', function ($widget) {
    if (!($widget->getController() instanceof \Rainlab\Blog\Controllers\Posts)) {
        return;
    }

    $widget->addColumns([
        'deleted_at' => [
            'label' => 'Deleted',
            'type' => 'date',
        ],
    ]);
});

,

, dll. Mari menyegarkan senarai artikel kami untuk melihat apakah perubahan kami berfungsi. addDynamicProperty asExtension

Sudah tentu, kita tidak mempunyai artikel yang dipadam lagi, kerana kita perlu melengkapkan bahagian terakhir: memintas operasi penghapusan artikel, dan hanya mengemas kini lajur

.

Petua: Daripada menggunakan harta scope

class Posts extends Controller
{
    public function index_onPublish()
    {
        if (($checkedIds = post('checked')) && is_array($checkedIds) && count($checkedIds)) {

            foreach ($checkedIds as $postId) {
                if ((!$post = Post::find($postId)) || !$post->canEdit($this->user))
                    continue;

                $post->publish();
                Event::fire('rainlab.blog.posts.published', [$post]);
            }

            Flash::success('Successfully published those posts.');
        }

        return $this->listRefresh();
    }
}

peristiwa eloquent

fasih mencetuskan satu siri peristiwa pada setiap operasi (membuat, mengemas kini, memadam, dll.). Dalam kes ini, kita perlu menyambungkan acara padam dan menghalang penghapusan rekod.

Apabila memadam rekod, acara

dicetuskan sebelum operasi penghapusan sebenar dilakukan, dan acara

dicetuskan selepas itu. Jika anda kembali palsu dalam acara deleting, operasi akan dibatalkan. deleted deleting

Sekarang kita sudah bersedia untuk menguji hasil akhir! Teruskan memadam beberapa rekod, kemudian pergi ke halaman senarai artikel untuk melihat sama ada anda boleh menukar item yang dipadam dalam senarai.

Event::listen('rainlab.blog.posts.published', function($post) {
    User::subscribedTo($post)->each(function($user) use($post) {
        Mail::send('emails.notifications.post-published', ['user' => $user, 'post' => $post], function($message) use($user, $post) {
            $message->from('us@example.com', 'New post by ' . $user->name);

            $message->to($user->email);
        });
    });
});

Kesimpulan

Artikel ini memberikan gambaran ringkas tentang bagaimana untuk memperluaskan bahagian -bahagian yang berlainan dari platform OktoberCMS. Anda boleh membaca lebih lanjut mengenainya di bahagian plugin sambungan dokumentasi. Jika anda mempunyai sebarang pertanyaan atau komen, sila tinggalkan mesej di bawah!

Soalan Lazim Mengenai Memperluaskan OktoberCMS dan Membina Plugin Padam Soft

Apakah tujuan pemalam penyingkiran perisian pada bulan OktoberCMS?

Plug-in Padam Lembut di OktoberCMS direka untuk mengelakkan kehilangan data kekal. Apabila anda memadam rekod, ia tidak sepenuhnya dipadam dari pangkalan data. Sebaliknya, timestamp

ditetapkan untuk rekod. Ini bermakna dari sudut pandangan aplikasi, rekod itu dianggap "dipadam", tetapi ia masih boleh diambil jika diperlukan. Ini amat berguna dalam senario di mana data boleh dipadamkan secara tidak sengaja, kerana ia membolehkan pemulihan mudah.

deleted_at Bagaimana perbezaan antara penghapusan lembut dan penghapusan keras?

Penghapusan keras secara kekal memadam rekod dari pangkalan data dan tidak boleh dipulihkan kecuali anda mempunyai sandaran. Sebaliknya, pemadaman lembut hanya menandakan rekod sebagai dipadam dan sebenarnya tidak memadamkannya dari pangkalan data. Ini membolehkan anda memulihkan rekod jika diperlukan.

Bagaimana untuk melaksanakan fungsi padam lembut pada bulan Oktobercms?

Untuk melaksanakan fungsi padam lembut pada OktoberCMS, anda perlu membuat pemalam. Ini termasuk membuat plugin baru, menambah

lajur ke jadual pangkalan data, dan mengemas kini model anda untuk menggunakan sifat

. Anda kemudian boleh menggunakan kaedah deleted_at pada model untuk memadamkan rekod dengan lembut dan menggunakan kaedah SoftDeletes untuk memulihkannya. delete restore Bagaimana untuk menguji fungsi padam lembut pada Oktobercms?

Anda boleh menguji fungsi padam lembut dengan membuat ujian unit. Ini termasuk membuat kes ujian baru, mencipta rekod baru dalam pangkalan data, dengan lembut memadamnya, dan kemudian menegaskan bahawa ia masih wujud dalam pangkalan data, tetapi ditandakan sebagai dipadamkan.

Bolehkah saya menggunakan fungsi padam lembut dengan rekod sedia ada?

Ya, anda boleh menggunakan fungsi padam lembut dengan rekod sedia ada. Anda hanya perlu menambah lajur

ke jadual pangkalan data sedia ada. Lajur ini untuk semua rekod sedia ada akan mempunyai nilai

yang menunjukkan bahawa mereka belum dipadamkan. deleted_at

Bagaimana untuk memulihkan rekod yang dipadam lembut pada bulan Oktobercms?

Untuk memulihkan rekod yang dipadam lembut, anda boleh menggunakan kaedah restore pada model. Ini akan menghilangkan timestamp deleted_at dari rekod, dengan berkesan "undelete" itu.

Bolehkah saya memadam rekod yang dipadam lembut pada bulan Oktobercms?

Ya, anda boleh memadam rekod yang dipadam lembut secara kekal menggunakan kaedah forceDelete pada model. Ini akan memadam rekod dari pangkalan data seperti penghapusan keras.

Bagaimana untuk melihat semua rekod, termasuk rekod yang dipadam lembut di OktoberCMS?

Untuk melihat semua rekod, termasuk rekod yang dipadam lembut, anda boleh menggunakan kaedah withTrashed pada model. Ini akan mengembalikan semua rekod, sama ada mereka telah dipadam lembut atau tidak.

Bolehkah saya menyesuaikan nama lajur deleted_at di OktoberCMS?

Ya, anda boleh menyesuaikan nama lajur getDeletedAtColumn dengan menimpa kaedah deleted_at dalam model. Jika deleted_at tidak sesuai untuk keperluan anda, ini membolehkan anda menggunakan nama lajur yang berbeza.

Bolehkah saya melumpuhkan fungsi padam lembut untuk rekod tertentu pada bulan Oktobercms?

Ya, anda boleh melumpuhkan Soft Delete untuk beberapa rekod menggunakan kaedah withoutGlobalScope pada model. Ini membolehkan anda mengecualikan rekod tertentu dari ciri Padam Lembut.

Atas ialah kandungan terperinci Memperluas Oktobercms - Membina Plugin Lembut Delete. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!