プラグインを作る。回避策ではなく。

一つのプラグインで複数のサーフェスを組み合わせ可能 — acelle/ai は 14 のうち 7 を 1 パッケージで使用しています。

1. 1

   プラグインを scaffold

   標準フォルダ構造と inactive 状態の DB 行を生成します。

   bash

   $ php artisan plugin:init myvendor/loyalty
     ✓ Created storage/app/plugins/myvendor/loyalty/
     ✓ DB row inserted  (status: inactive)
     ✓ index.json + ServiceProvider autoloaded

2. 2

   composer.json を編集

   namespace と ServiceProvider を Composer に伝えます。

   json

   {
     "name": "myvendor/loyalty",
     "description": "Award points on signup",
     "version": "1.0.0",
     "autoload":  { "psr-4": { "MyVendor\\Loyalty\\": "src/" } },
     "extra":     { "laravel": { "providers": [
       "MyVendor\\Loyalty\\ServiceProvider"
     ] } }
   }

3. 3

   migration を記述

   プラグイン専用テーブル、vendor 接頭辞付きの名前。activate 時に実行、delete 時にロールバックします。

   php

   Schema::create('myvendor_loyalty_accounts', function (Blueprint $t) {
       $t->id();
       $t->foreignId('customer_id')->constrained()->cascadeOnDelete();
       $t->integer('points')->default(0);
       $t->timestamps();
   });

4. 4

   モデルを定義

   あなたの namespace 配下の標準的な Eloquent モデルです。

   php

   namespace MyVendor\Loyalty\Models;
   
   use Illuminate\Database\Eloquent\Model;
   
   class Account extends Model
   {
       protected $table    = 'myvendor_loyalty_accounts';
       protected $fillable = ['customer_id', 'points'];
   }

5. 5

   controller と view を追加

   普通の Laravel controller — view namespace はプラグイン名です。

   php

   namespace MyVendor\Loyalty\Controllers;
   
   use Acelle\Http\Controllers\Controller;
   
   class DashboardController extends Controller
   {
       public function index()
       {
           return view('loyalty::dashboard', [
               'accounts' => \MyVendor\Loyalty\Models\Account::orderByDesc('points')->take(10)->get(),
           ]);
       }
   }

6. 6

   routes を宣言

   いつも使っている Route::group と同じ。ServiceProvider::boot() で読み込みます。

   php

   Route::group([
       'middleware' => ['web', 'auth'],
       'namespace'  => '\MyVendor\Loyalty\Controllers',
       'prefix'     => 'plugins/myvendor/loyalty',
   ], function () {
       Route::get('/',          'DashboardController@index')->name('lp.dashboard');
       Route::get('/{account}', 'DashboardController@show');
   });

7. 7

   ServiceProvider::boot() で配線

   views と routes をロードし、activate_plugin_… にフックして有効化時に migration を実行します。

   php

   public function boot(): void
   {
       $this->loadViewsFrom (__DIR__.'/../resources/views', 'loyalty');
       $this->loadRoutesFrom(__DIR__.'/../routes.php');
   
       Hook::on('activate_plugin_myvendor/loyalty', fn () =>
           \Artisan::call('migrate', [
               '--path'  => 'storage/app/plugins/myvendor/loyalty/database/migrations',
               '--force' => true,
           ])
       );
   
       Hook::on('customer_added', fn ($customer) =>
           Models\Account::create(['customer_id' => $customer->id, 'points' => 100])
       );
   }

8. 8

   管理画面から有効化

   /rui/admin/plugins にアクセス。migration が自動実行され、プラグインは指定の prefix で動作します。

   bash

   ✓ activated  myvendor/loyalty  v1.0.0
     → migrations: 1 ran (myvendor_loyalty_accounts)
     → routes:     2 registered under /plugins/myvendor/loyalty
     → hooks:      2 listening (activate, customer_added)
     → status:     active
   
   → visit /plugins/myvendor/loyalty/  ← live

動くプラグインが完成しました。あとは機能に応じて models / controllers / hooks を好きなだけ追加してください。テストは tests/ に置き、php artisan test --testsuite='Plugin: myvendor/loyalty' で実行できます。正式な仕様はナレッジベースを参照してください。