延長10月CMS-構建軟耗盡插件

OctoberCMS：插件擴展性深度探索及軟刪除插件實戰

開發者通常青睞易用且可擴展的CMS。 OctoberCMS 秉持簡潔至上的理念，為開發者和用戶帶來愉悅的體驗。本文將演示OctoberCMS 的一些可擴展特性，並通過一個簡單的插件擴展另一個插件的功能。

關鍵要點

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

引言

每個CMS都有一個插件系統來擴展平台的功能，我們通過可以深入CMS內部機制的程度來衡量其擴展性。然而，我們這裡討論的不僅僅是CMS本身，也包括插件！

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

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

其他開發者可以監聽此事件來處理已發布的文章。

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

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

Rainlab Blog 插件

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

在文章列表頁面，我們可以刪除文章。但是，如果我們想軟刪除它們呢？讓我們看看我們能否做到這一點，並了解更多關於OctoberCMS擴展性的知識。

創建新插件

使用腳手架助手命令創建一個新的插件用於我們的演示，並在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();
    }
}

擴展數據庫模式

談到軟刪除時，首先想到的是數據庫中需要存在的 deleted_at 字段列。

在 blogplus/updates 文件夾下創建一個名為 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 列，其默認值為 null。不要忘記運行 php artisan plugin:refresh rafie.blogplus 命令才能使更改生效。

擴展文章列表

接下來，我們必須將我們的字段作為列添加到列表中以進行顯示。 OctoberCMS 為我們提供了一個事件來掛接，並更改當前顯示的小部件（後端列表被認為是小部件）。

# updates/version.yaml

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

注意：以上代碼應放在 Plugin@boot 方法中。

我們有一個 if 語句來防止我們的代碼在每個頁面上執行，然後我們將一個新列添加到列表小部件中，我們還可以使用 removeColumn 方法刪除任何現有的列。查看文檔以了解可用的列選項列表。

擴展過濾器

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

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

您可以在文檔中閱讀更多關於列表過濾器的信息。上面的代碼相當簡單，只包含幾個選項。但是，scope 屬性應該是 Models\Post 模型實例中定義的查詢範圍方法的名稱。

可擴展類

OctoberRainExtensionExtendableTrait trait 提供了一種神奇的方法來動態擴展現有類，方法是添加新的方法、屬性、行為等。在我們的示例中，我們需要向文章模型添加一個新方法來處理我們的範圍過濾器。

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

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

當然，我們還沒有任何已刪除的文章，因為我們需要完成最後一部分：攔截文章的刪除操作，只更新 deleted_at 列。

提示：與其使用 scope 屬性，您可以使用條件來指定一個簡單的 where 條件。下面的代碼與使用模型範圍的效果相同。

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 在每個操作（創建、更新、刪除等）上都會觸發一系列事件。在這種情況下，我們需要掛接到刪除事件並阻止記錄的刪除。

刪除記錄時，在執行實際刪除操作之前會觸發 deleting 事件，之後會觸發 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);
        });
    });
});

現在我們準備測試最終結果！繼續刪除一些記錄，然後轉到文章列表頁面，看看是否可以切換列表中的已刪除項目。

結論

本文快速概述瞭如何擴展 OctoberCMS 平台的不同部分。您可以在文檔的擴展插件部分閱讀更多相關信息。如果您有任何問題或意見，請在下方留言！

關於擴展 OctoberCMS 和構建軟刪除插件的常見問題

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

OctoberCMS 中的軟刪除插件旨在防止永久性數據丟失。當您刪除記錄時，它不會從數據庫中完全刪除。相反，會為該記錄設置一個 deleted_at 時間戳。這意味著從應用程序的角度來看，該記錄被認為是“已刪除”的，但如果需要，仍然可以檢索到它。這在可能意外刪除數據的場景中特別有用，因為它允許輕鬆恢復。

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

硬刪除會永久地從數據庫中刪除記錄，除非您有備份，否則無法恢復。另一方面，軟刪除只是將記錄標記為已刪除，而不會實際將其從數據庫中刪除。這允許您在需要時恢復記錄。

如何在 OctoberCMS 中實現軟刪除功能？

要在 OctoberCMS 中實現軟刪除功能，您需要創建一個插件。這包括創建一個新插件，向數據庫表添加 deleted_at 列，並更新您的模型以使用 SoftDeletes trait。然後，您可以使用模型上的 delete 方法來軟刪除記錄，並使用 restore 方法來恢復它。

如何測試 OctoberCMS 中的軟刪除功能？

您可以通過創建單元測試來測試軟刪除功能。這包括創建一個新的測試用例，在數據庫中創建一個新記錄，軟刪除它，然後斷言它仍然存在於數據庫中，但被標記為已刪除。

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

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

如何在 OctoberCMS 中恢復軟刪除的記錄？

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

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

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

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

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

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

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

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

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

以上是延長10月CMS-構建軟耗盡插件的詳細內容。更多資訊請關注PHP中文網其他相關文章！