OctoberCMS：插件擴(kuò)展性深度探索及軟刪除插件實(shí)戰(zhàn)

開發(fā)者通常青睞易用且可擴(kuò)展的CMS。 OctoberCMS 秉持簡(jiǎn)潔至上的理念，為開發(fā)者和用戶帶來(lái)愉悅的體驗(yàn)。本文將演示OctoberCMS 的一些可擴(kuò)展特性，並通過(guò)一個(gè)簡(jiǎn)單的插件擴(kuò)展另一個(gè)插件的功能。

關(guān)鍵要點(diǎn)

• OctoberCMS 提供了一個(gè)簡(jiǎn)潔易用的CMS，同時(shí)允許通過(guò)插件進(jìn)行擴(kuò)展。這種擴(kuò)展性體現(xiàn)在開發(fā)者可以深入CMS內(nèi)部機(jī)制的程度，包括修改其他開發(fā)者插件的功能。
• Rainlab Blog 插件允許創(chuàng)建文章並將其分配到不同的類別。本教程演示如何擴(kuò)展此插件，添加軟刪除功能，防止文章被永久刪除，而是標(biāo)記為“已刪除”並記錄時(shí)間戳。
• 要?jiǎng)?chuàng)建軟刪除功能，需要?jiǎng)?chuàng)建一個(gè)新插件，並在數(shù)據(jù)庫(kù)中添加一個(gè) deleted_at 字段。此字段將保存文章刪除的時(shí)間戳。然後，插件擴(kuò)展文章列表以包含此新字段作為列，並添加一個(gè)過(guò)濾器來(lái)顯示或隱藏已刪除的文章。
• 創(chuàng)建軟刪除功能的最後一步是攔截文章的刪除操作，並更新 deleted_at 列。這是通過(guò)掛接到 Eloquent 觸發(fā)的 deleting 事件來(lái)實(shí)現(xiàn)的，阻止記錄的刪除。取而代之的是，deleted_at 字段將更新為當(dāng)前時(shí)間戳，並保存記錄。

引言

每個(gè)CMS都有一個(gè)插件系統(tǒng)來(lái)擴(kuò)展平臺(tái)的功能，我們通過(guò)可以深入CMS內(nèi)部機(jī)制的程度來(lái)衡量其擴(kuò)展性。然而，我們這裡討論的不僅僅是CMS本身，也包括插件！

如果您構(gòu)建一個(gè)插件，您需要確保其他開發(fā)者可以修改您的部分功能。例如，我們有一個(gè)博客插件，用戶可以通過(guò)選擇列表中的文章來(lái)發(fā)布文章。最好觸發(fā)一個(gè)事件來(lái)表明已發(fā)布新文章，另一個(gè)開發(fā)者可以掛接到此事件，並通過(guò)電子郵件通知訂閱的用戶！

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();
    }
}

其他開發(fā)者可以監(jiān)聽此事件來(lái)處理已發(fā)布的文章。

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);
        });
    });
});

我們將主要使用事件來(lái)掛接到請(qǐng)求週期的不同部分。讓我們從一個(gè)具體的例子開始，以便更好地理解。

Rainlab Blog 插件

如果您使用過(guò)OctoberCMS一段時(shí)間，您一定知道Rainlab Blog插件。它允許您在後端添加文章並將其附加到類別，並且您可以使用組件在前端顯示它們。

在文章列表頁(yè)面，我們可以刪除文章。但是，如果我們想軟刪除它們呢？讓我們看看我們能否做到這一點(diǎn)，並了解更多關(guān)於OctoberCMS擴(kuò)展性的知識(shí)。

創(chuàng)建新插件

使用腳手架助手命令創(chuàng)建一個(gè)新的插件用於我們的演示，並在Plugin.php文件中更新插件詳細(xì)信息。

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();
    }
}

擴(kuò)展數(shù)據(jù)庫(kù)模式

談到軟刪除時(shí)，首先想到的是數(shù)據(jù)庫(kù)中需要存在的 deleted_at 字段列。

在 blogplus/updates 文件夾下創(chuàng)建一個(gè)名為 create_posts_deleted_at_field.php 的新文件，並更新 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

遷移類將更改 rainlab_blog_posts 表並添加我們的 deleted_at 列，其默認(rèn)值為 null。不要忘記運(yùn)行 php artisan plugin:refresh rafie.blogplus 命令才能使更改生效。

擴(kuò)展文章列表

接下來(lái)，我們必須將我們的字段作為列添加到列表中以進(jìn)行顯示。 OctoberCMS 為我們提供了一個(gè)事件來(lái)掛接，並更改當(dāng)前顯示的小部件（後端列表被認(rèn)為是小部件）。

# updates/version.yaml

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

注意：以上代碼應(yīng)放在 Plugin@boot 方法中。

我們有一個(gè) if 語(yǔ)句來(lái)防止我們的代碼在每個(gè)頁(yè)面上執(zhí)行，然後我們將一個(gè)新列添加到列表小部件中，我們還可以使用 removeColumn 方法刪除任何現(xiàn)有的列。查看文檔以了解可用的列選項(xiàng)列表。

擴(kuò)展過(guò)濾器

文章列表頂部的欄允許用戶使用日期、類別等過(guò)濾列表。在我們的例子中，我們需要一個(gè)過(guò)濾器來(lái)顯示/隱藏已刪除的文章。

# 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');
        });
    }
}

您可以在文檔中閱讀更多關(guān)於列表過(guò)濾器的信息。上面的代碼相當(dāng)簡(jiǎn)單，只包含幾個(gè)選項(xiàng)。但是，scope 屬性應(yīng)該是 Models\Post 模型實(shí)例中定義的查詢範(fàn)圍方法的名稱。

可擴(kuò)展類

OctoberRainExtensionExtendableTrait trait 提供了一種神奇的方法來(lái)動(dòng)態(tài)擴(kuò)展現(xiàn)有類，方法是添加新的方法、屬性、行為等。在我們的示例中，我們需要向文章模型添加一個(gè)新方法來(lái)處理我們的範(fàn)圍過(guò)濾器。

// 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',
        ],
    ]);
});

我們可以對(duì) addDynamicProperty、asExtension 等做同樣的事情。讓我們刷新我們的文章列表，看看我們的更改是否有效。

當(dāng)然，我們還沒有任何已刪除的文章，因?yàn)槲覀冃枰瓿勺钺嵋徊糠郑簲r截文章的刪除操作，只更新 deleted_at 列。

提示：與其使用 scope 屬性，您可以使用條件來(lái)指定一個(gè)簡(jiǎn)單的 where 條件。下面的代碼與使用模型範(fàn)圍的效果相同。

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();
    }
}

Eloquent 事件

Eloquent 在每個(gè)操作（創(chuàng)建、更新、刪除等）上都會(huì)觸發(fā)一系列事件。在這種情況下，我們需要掛接到刪除事件並阻止記錄的刪除。

刪除記錄時(shí)，在執(zhí)行實(shí)際刪除操作之前會(huì)觸發(fā) deleting 事件，之後會(huì)觸發(fā) deleted 事件。如果您在 deleting 事件中返回 false，則操作將中止。

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);
        });
    });
});

現(xiàn)在我們準(zhǔn)備測(cè)試最終結(jié)果！繼續(xù)刪除一些記錄，然後轉(zhuǎn)到文章列表頁(yè)面，看看是否可以切換列表中的已刪除項(xiàng)目。

結(jié)論

本文快速概述瞭如何擴(kuò)展 OctoberCMS 平臺(tái)的不同部分。您可以在文檔的擴(kuò)展插件部分閱讀更多相關(guān)信息。如果您有任何問題或意見，請(qǐng)?jiān)谙路搅粞裕?

關(guān)於擴(kuò)展 OctoberCMS 和構(gòu)建軟刪除插件的常見問題

OctoberCMS 中軟刪除插件的用途是什麼？

OctoberCMS 中的軟刪除插件旨在防止永久性數(shù)據(jù)丟失。當(dāng)您刪除記錄時(shí)，它不會(huì)從數(shù)據(jù)庫(kù)中完全刪除。相反，會(huì)為該記錄設(shè)置一個(gè) deleted_at 時(shí)間戳。這意味著從應(yīng)用程序的角度來(lái)看，該記錄被認(rèn)為是“已刪除”的，但如果需要，仍然可以檢索到它。這在可能意外刪除數(shù)據(jù)的場(chǎng)景中特別有用，因?yàn)樗试S輕鬆恢復(fù)。

軟刪除功能與硬刪除有何不同？

硬刪除會(huì)永久地從數(shù)據(jù)庫(kù)中刪除記錄，除非您有備份，否則無(wú)法恢復(fù)。另一方面，軟刪除只是將記錄標(biāo)記為已刪除，而不會(huì)實(shí)際將其從數(shù)據(jù)庫(kù)中刪除。這允許您在需要時(shí)恢復(fù)記錄。

如何在 OctoberCMS 中實(shí)現(xiàn)軟刪除功能？

要在 OctoberCMS 中實(shí)現(xiàn)軟刪除功能，您需要?jiǎng)?chuàng)建一個(gè)插件。這包括創(chuàng)建一個(gè)新插件，向數(shù)據(jù)庫(kù)表添加 deleted_at 列，並更新您的模型以使用 SoftDeletes trait。然後，您可以使用模型上的 delete 方法來(lái)軟刪除記錄，並使用 restore 方法來(lái)恢復(fù)它。

如何測(cè)試 OctoberCMS 中的軟刪除功能？

您可以通過(guò)創(chuàng)建單元測(cè)試來(lái)測(cè)試軟刪除功能。這包括創(chuàng)建一個(gè)新的測(cè)試用例，在數(shù)據(jù)庫(kù)中創(chuàng)建一個(gè)新記錄，軟刪除它，然後斷言它仍然存在於數(shù)據(jù)庫(kù)中，但被標(biāo)記為已刪除。

我可以將軟刪除功能與現(xiàn)有記錄一起使用嗎？

是的，您可以將軟刪除功能與現(xiàn)有記錄一起使用。您只需要向現(xiàn)有的數(shù)據(jù)庫(kù)表添加 deleted_at 列。所有現(xiàn)有記錄的此列都將具有 null 值，表示它們尚未被刪除。

如何在 OctoberCMS 中恢復(fù)軟刪除的記錄？

要恢復(fù)軟刪除的記錄，您可以使用模型上的 restore 方法。這將從記錄中刪除 deleted_at 時(shí)間戳，有效地“取消刪除”它。

我可以在 OctoberCMS 中永久刪除軟刪除的記錄嗎？

是的，您可以使用模型上的 forceDelete 方法永久刪除軟刪除的記錄。這將像硬刪除一樣從數(shù)據(jù)庫(kù)中刪除記錄。

如何在 OctoberCMS 中查看所有記錄，包括軟刪除的記錄？

要查看所有記錄，包括軟刪除的記錄，您可以使用模型上的 withTrashed 方法。這將返回所有記錄，無(wú)論它們是否已被軟刪除。

我可以在 OctoberCMS 中自定義 deleted_at 列的名稱嗎？

是的，您可以通過(guò)覆蓋模型中的 getDeletedAtColumn 方法來(lái)自定義 deleted_at 列的名稱。如果 deleted_at 不適合您的需求，這允許您使用不同的列名。

我可以在 OctoberCMS 中為某些記錄禁用軟刪除功能嗎？

是的，您可以使用模型上的 withoutGlobalScope 方法為某些記錄禁用軟刪除功能。這允許您從軟刪除功能中排除某些記錄。

以上是延長(zhǎng)10月CMS-構(gòu)建軟耗盡插件的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！