OctureCMS：プラグインの拡張性とプラグインの実用的なソフトウェアの削除の詳細(xì)な調(diào)査

開(kāi)発者は一般に、使いやすくスケーラブルなCMSを好みます。 OctureCmsは、最初にシンプルさの概念を順守し、開(kāi)発者とユーザーに心地よい體験をもたらします。この記事では、10月の拡張機(jī)能のいくつかを示し、単純なプラグインを使用した別のプラグインの機(jī)能を拡張します。

キーポイント

• OctureCMSは、プラグインを介して拡張機(jī)能を許可しながら、シンプルで使いやすいCMSを提供します。このスケーラビリティは、他の開(kāi)発者プラグインの機(jī)能の変更を含む、開(kāi)発者がCMSの內(nèi)部メカニズムに侵入できる程度に反映されます。
• RainLabブログプラグインを使用すると、記事を作成して、さまざまなカテゴリに割り當(dāng)てることができます。このチュートリアルでは、このプラグインを拡張し、ソフト削除機(jī)能を追加し、記事が永続的に削除されないようにする方法を示していますが、代わりに「削除」と記録されたタイムスタンプとしてマークします。
• ソフト削除機(jī)能を作成するには、新しいプラグインを作成し、データベースにフィールドを追加する必要があります。このフィールドは、記事の削除のタイムスタンプを保存します。プラグインは、記事リストを拡張してこの新しいフィールドを列として含めるように拡張し、削除された記事を表示または非表示にするフィルターを追加します。 deleted_at
ソフト削除関數(shù)を作成する最後のステップは、記事の削除操作をインターセプトし、
• 列を更新することです。これは、雄弁さによってトリガーされたdeleted_atイベントに接続し、レコードの削除を妨げることによって行われます。代わりに、deletingフィールドは現(xiàn)在のタイムスタンプに更新され、レコードは保存されます。 deleted_at

はじめに

各CMSには、プラットフォームの機(jī)能を拡張するプラグインシステムがあり、CMSの內(nèi)部メカニズムに侵入できる範(fàn)囲でそのスケーラビリティを測(cè)定します。ただし、CMS自體だけでなく、プラグインについても話(huà)しています！

プラグインを構(gòu)築する場(chǎng)合、他の開(kāi)発者があなたの機(jī)能の一部を変更できることを確認(rèn)する必要があります。たとえば、リスト內(nèi)の記事を選択して記事を公開(kāi)できるブログプラグインがあります。新しい記事が公開(kāi)されたことを示すためにイベントをトリガーするのが最善です。別の開(kāi)発者はこのイベントにマウントし、電子メールで購(gòu)読者に通知できます！

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

他の開(kāi)発者は、このイベントを聴いて、公開(kāi)された記事を処理することができます。

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ブログプラグイン

しばらくの間OctureCMSを使用している場(chǎng)合は、RainLabブログプラグインについて知っておく必要があります。バックエンドに記事を追加してカテゴリに添付することができ、コンポーネントを使用してフロントエンドに表示できます。

記事リストページで、記事を削除できます。しかし、それらをそっと削除したい場(chǎng)合はどうなりますか？これを行うことができるかどうかを見(jiàn)て、10月のスケーラビリティについて詳しく知りましょう。

新しいプラグインを作成

足場(chǎng)アシスタントコマンドを使用してデモ用の新しいプラグインを作成し、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();
    }
}

拡張データベースモード

ソフト削除について話(huà)すとき、最初に思い浮かぶのは、データベースに存在する必要がある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コマンドを?qū)g行することを忘れないでください。 php artisan plugin:refresh rafie.blogplus

拡張記事リスト

次に、ディスプレイのためにリストに列としてフィールドを追加する必要があります。 OctureCMSは、現(xiàn)在表示されているウィジェットをマウントして変更するイベントを提供します（バックエンドリストはウィジェットと見(jiàn)なされます）。

# updates/version.yaml

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

注：上記のコードは

メソッドに配置する必要があります。 Plugin@boot

各ページでコードが実行されないようにするIFステートメントがあり、その後、リストウィジェットに新しい列を追加し、

メソッドを使用して既存の列を削除することもできます。使用可能な列オプションのリストについては、ドキュメントを確認(rèn)してください。 removeColumn

拡張フィルター

記事リストの上部にある列を使用すると、ユーザーは日付、カテゴリなどを使用してリストをフィルタリングできます。私たちの場(chǎng)合、削除された記事を表示/非表示にするためのフィルターが必要です。

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

ドキュメントのリストフィルターの詳細(xì)を読むことができます。上記のコードは非常に簡(jiǎn)単で、いくつかのオプションしか含まれていません。ただし、

屬性は、scopeモデルインスタンスで定義されているクエリスコープメソッドの名前である必要があります。 Models\Post

拡張可能なクラス

OctunRainextensionExtendENDABLETRAIT特性は、新しい方法、屬性、動(dòng)作などを追加して既存のクラスを動(dòng)的に拡張するための

MAGICメソッドを提供します。この例では、スコープフィルターを処理するために記事モデルに新しいメソッドを追加する必要があります。

// plugin.php  在Plugin類(lèi)的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などについても同じことができます。記事リストを更新して、変更が機(jī)能するかどうかを確認(rèn)しましょう。 asExtension

もちろん、最後の部分を完了する必要があるため、削除された記事はまだありません。記事の削除操作を傍受し、

列のみを更新する必要があるためです。

ヒント：scopeプロパティを使用する代わりに、條件を使用して、単純な條件を指定できます。次のコードは、モデルスコープを使用するのと同じように機(jī)能します。

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

雄弁イベント

雄弁さは、各操作に関する一連のイベント（作成、更新、削除など）をトリガーします。この場(chǎng)合、削除イベントにフックし、レコードの削除を防ぐ必要があります。

レコードを削除すると、実際の削除操作が実行される前に

イベントがトリガーされ、その後deletingイベントがトリガーされます。 deletedイベントでfalseを返すと、操作は中止されます。 deleting

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

これで、最終結(jié)果をテストする準(zhǔn)備ができました！いくつかのレコードを削除し続け、記事リストページに移動(dòng)して、リスト內(nèi)の削除されたアイテムを切り替えることができるかどうかを確認(rèn)します。

結(jié)論

この記事では、10月のプラットフォームのさまざまな部分を拡張する方法の簡(jiǎn)単な概要を説明します。詳細(xì)については、ドキュメントの拡張機(jī)能プラグインセクションをご覧ください。ご質(zhì)問(wèn)やコメントがある場(chǎng)合は、以下にメッセージを殘してください！

10月の拡張とソフト削除プラグインの構(gòu)築に関するFAQ

10月のソフトウェア削除プラグインの目的は何ですか？

10月のソフト削除プラグインは、永続的なデータ損失を防ぐように設(shè)計(jì)されています。レコードを削除すると、データベースから完全に削除されるわけではありません。代わりに、a

タイムスタンプがレコード用に設(shè)定されています。これは、アプリケーションの観點(diǎn)から、レコードは「削除」されていると見(jiàn)なされますが、必要に応じて取得できることを意味します。これは、データが誤って削除される可能性があるシナリオで特に役立ちます。これは、簡(jiǎn)単に回復(fù)できるためです。

deleted_atソフト削除とハード削除の違いはどうですか？

ハード削除はデータベースから永久にレコードを削除し、バックアップがない限り復(fù)元できません。一方、ソフト削除は削除されたレコードを単にマークし、実際にはデータベースから削除しません。これにより、必要に応じてレコードを回復(fù)できます。

10月にソフト削除関數(shù)を?qū)g裝する方法は？

10月にソフト削除機(jī)能を?qū)g裝するには、プラグインを作成する必要があります。これには、新しいプラグインの作成、データベーステーブルへの

列の追加、モデルを更新して

特性を使用することが含まれます。その後、モデルのdeleted_atメソッドを使用して、レコードを柔らかく削除し、SoftDeletesメソッドを使用して回復(fù)できます。 delete restore 10月のソフト削除関數(shù)をテストする方法は？

ユニットテストを作成して、ソフト削除関數(shù)をテストできます。これには、新しいテストケースの作成、データベースに新しいレコードの作成、柔らかく削除され、データベースにまだ存在するが、削除されているとマークされていると主張することが含まれます。

既存のレコードでソフト削除関數(shù)を使用できますか？

はい、既存のレコードでソフト削除関數(shù)を使用できます。既存のデータベーステーブルに

列を追加するだけです。既存のすべてのレコードのこの列には、

値が削除されていないことを示します。 deleted_at

10月にソフト削除されたレコードを回復(fù)するにはどうすればよいですか？

ソフト削除されたレコードを回復(fù)するには、モデルでrestoreメソッドを使用できます。これにより、レコードからdeleted_atタイムスタンプが削除され、効果的に「整理」します。

10月のソフト削除レコードを永続的に削除できますか？

はい、モデルのforceDeleteメソッドを使用してソフト削除されたレコードを永続的に削除できます。これにより、ハード削除のようにデータベースからレコードが削除されます。

10月のソフト削除レコードを含むすべてのレコードを表示する方法は？

ソフト削除レコードを含むすべてのレコードを表示するには、モデルでwithTrashedメソッドを使用できます。これにより、ソフト削除されているかどうかにかかわらず、すべてのレコードが返されます。

10月の列の列の名前をカスタマイズできますか？ deleted_at

はい、モデルの

メソッドを上書(shū)きすることにより、getDeletedAtColumn列の名前をカスタマイズできます。 deleted_atがお客様のニーズに適していない場(chǎng)合、これにより、異なる列名を使用できます。 deleted_at

10月の特定のレコードのソフト削除関數(shù)を無(wú)効にできますか？

はい、モデルの

メソッドを使用して、一部のレコードに対してソフト削除を無(wú)効にすることができます。これにより、Soft Delete機(jī)能から特定のレコードを除外できます。 withoutGlobalScope

以上が10月の拡張 - ソフトディレットプラグインを構(gòu)築しますの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。