拡張機能パッケージを確認する

Laravel アプリケーションの config/app.php 構成ファイルで、providers オプションは、拡張機能を利用できるサービス プロバイダーのリストを定義します。 Laravel によってロードされます。誰かが拡張機能をインストールするときは、サービス プロバイダーをこのリストに含める必要があります。ユーザーがサービス プロバイダーをリストに手動で追加する代わりに、拡張機能パッケージの composer.json ファイルの extra セクションにサービス プロバイダーを定義できます。サービスプロバイダーに加えて、登録したいすべてのファサードをリストすることもできます:

"extra": {
    "laravel": {     
       "providers": [          
         "Barryvdh\Debugbar\ServiceProvider"     
          ],       
        "aliases": {          
          "Debugbar": "Barryvdh\Debugbar\Facade"      
            }   
          }
     },

拡張パッケージが検出可能に設定されると、Laravel はインストール中にサービスプロバイダーと拡張パッケージのファサードを自動的に登録します。拡張パック ユーザーに使いやすいインストール エクスペリエンスを提供します。

拡張パッケージの選択的検出

拡張パッケージ ユーザーで、拡張パッケージが検出されないようにしたい場合は、アプリケーションの ## で実行できます。 #composer .json ファイルの extra セクションには、次の拡張子がリストされています:

"extra": { 
   "laravel": {      
     "dont-discover": [          
       "barryvdh/laravel-debugbar"       
      ]  
    }
},

アプリケーションの

dont-discover ディレクティブで ## を使用することもできます # * 文字、拡張機能パッケージ検出機能を無効にします:

"extra": {
    "laravel": {     
       "dont-discover": [     
            "*"   
          ] 
       }
    },

##サービス プロバイダーサービス プロバイダー 拡張機能を接続します。ララベルで。サービスプロバイダーは、Laravel のサービスコンテナに何かをバインドし、ビュー、設定ファイル、言語パックなどの拡張パッケージのリソースファイルをロードする場所を Laravel に指示する責任があります。

サービス プロバイダーは、

Illuminate\Support\ServiceProvider

クラスを継承し、2 つのメソッド:

register と boot を含みます。基本クラス ServiceProvider は、illuminate/support という名前の Composer 拡張機能パッケージにあり、これを拡張機能パッケージの依存関係に追加する必要があります。サービス プロバイダーの構造と目的の詳細については、そのドキュメントを参照してください。

リソース ファイル

構成拡張パック構成ファイルをアプリケーション自体の

config

ディレクトリに公開する必要がある場合があります。このようにして、拡張機能パッケージを使用するユーザーは、デフォルトの構成項目を簡単にオーバーライドできます。拡張パッケージ構成ファイルを公開するには、サービス プロバイダーの

boot メソッドで publishes メソッドを呼び出すだけです。 package Laravelのvendor:publishコマンドを実行すると、指定したディレクトリに拡張機能パッケージファイルがコピーされます。もちろん、設定ファイルが公開されると、他の設定と同様にアクセスできます。

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){
     $this->publishes([    
         __DIR__.'/path/to/config/courier.php' => config_path('courier.php'),  
        ]);
    }

{note} 設定ファイル内でクロージャ関数を定義しないでください。ユーザーが config:cache Artisan コマンドを実行すると、構成ファイルが正しくシリアル化されないためです。

拡張パッケージのデフォルト構成

拡張パッケージのデフォルト構成をアプリケーションのコピー構成とマージすることもできます。これにより、拡張パック ユーザーは、レプリカ構成ファイル内でオーバーライドする構成オプションを定義できるようになります。構成をマージするには、サービス プロバイダーの register メソッドで mergeConfigFrom メソッドを呼び出すだけです。

$value = config('courier.option');

{note} このメソッドは、最初のディメンションの構成のみをマージします。配列。拡張機能ユーザーが多次元構成配列を定義する場合、欠落しているオプションはマージされません。

ルーティング

拡張パッケージにルーティング ファイルが含まれている場合は、 を使用する必要があります。 loadRoutesFrom メソッドによってそれらがロードされます。このメソッドは、適用されたルートがキャッシュされているかどうかを自動的に判断します。ルートがキャッシュされている場合、ルート ファイルはロードされません:

/**
 * 在容器中注册绑定。
 *
 * @return void
 */
 public function register(){
     $this->mergeConfigFrom(    
         __DIR__.'/path/to/config/courier.php', 'courier'   
       );
  }

##データベース移行

拡張パッケージにデータベース移行が含まれている場合は、

loadMigrationsFrom メソッドを使用して、データベース移行のロード方法を Laravel に指示する必要があります。 loadMigrationsFrom メソッドには、唯一のパラメーターとして拡張パック移行ファイルのパスのみが必要です:

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){ 
    $this->loadRoutesFrom(__DIR__.'/routes.php');
  }

拡張パック移行ファイルが登録されると、それらは

php 職人の実行時に使用されます。移行 コマンドが自動的に実行されます。これらをアプリケーションの database/migrations ディレクトリにインポートする必要はありません。

言語パック

拡張パッケージに言語パック ファイルが含まれている場合は、

loadTranslationsFrom #を使用する必要があります。 ## メソッドは、Laravel にそれらをロードする方法を指示します。たとえば、拡張パッケージの名前が courier である場合、次の内容をサービス プロバイダーの boot メソッドに追加する必要があります。

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){ 
    $this->loadMigrationsFrom(__DIR__.'/path/to/migrations');
   }

拡張パッケージの変換規則

package::file.line

参照する構文。したがって、courier 拡張パッケージの messages ファイルの welcome 行を次のようにロードできます。

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){
     $this->loadTranslationsFrom(__DIR__.'/path/to/translations', 'courier');
 }

#言語パックの発行

拡張パッケージ内の言語パックをアプリケーションの

resources/lang/vendor

ディレクトリに発行する場合は、サービス プロバイダーの

publishes# # ＃ 方法。 publishes このメソッドは、言語パックのパスと対応する発行場所を含む配列を受け取ります。たとえば、courier 拡張パッケージの言語パック ファイルを公開するには、操作は次のようになります。

echo trans('courier::messages.welcome');

ここで、拡張パッケージのユーザーが Laravel の vendor を実行すると、次のようになります。 public アーティザン コマンド、言語 パッケージは指定されたディレクトリに公開されます。

View

拡張機能パッケージのビューを Laravel に登録したい場合は、Laravel にビュー ファイルの場所を伝える必要があります。これは、サービス プロバイダーの loadViewsFrom メソッドを使用して実行できます。 loadViewsFrom メソッドでは、ビュー テンプレートのパスと拡張機能パッケージ名という 2 つのパラメーターを受け取ることができます。たとえば、拡張パッケージの名前が courier である場合、次の内容をサービス プロバイダーの boot メソッドに追加する必要があります。

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){
     $this->loadTranslationsFrom(__DIR__.'/path/to/translations', 'courier');    
     $this->publishes([    
         __DIR__.'/path/to/translations' => resource_path('lang/vendor/courier'),   
       ]);
  }

拡張パッケージの表示規則package::view 参照する構文。したがって、ビュー パスがサービス プロバイダーに正常に登録されたら、次のメソッドを使用して、courier 拡張パッケージに admin ビューをロードできます:

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){
     $this->loadViewsFrom(__DIR__.'/path/to/views', 'courier');
   }

拡張パッケージのビューをオーバーライドする

loadViewsFrom メソッドを使用すると、Laravel は実際に 2 つの場所にビューを登録します: アプリケーションの resources/views/vendorディレクトリとカスタム ディレクトリ。したがって、courier 拡張パッケージを例にとると、Laravel はまず、開発者が resources/views/vendor/courier にカスタマイズされたバージョンのビューを提供しているかどうかを確認します。次に、ビューがまだ定義されていない場合、Laravel は loadViewsFrom で定義されたビュー ディレクトリを検索します。このアプローチにより、ユーザーは拡張機能パッケージのビューを簡単にカスタマイズまたはオーバーライドできます。

ビューの公開

ビューをアプリケーションの resources/views/vendor ディレクトリに公開したい場合は、サービス プロバイダーを使用できます。 パブリッシュメソッド。 publishes メソッドは、ビュー パスと対応する公開場所を含む配列を受け取ります。

Route::get('admin', function () { 
   return view('courier::admin');
});

さて、拡張パッケージのユーザーが Laravel の vendor:publish Artisan を実行すると、コマンドを実行すると、ビューがカスタム ディレクトリに公開されます。

コマンド

Laravel で拡張パッケージの Artisan コマンドを登録したい場合は、次のようにする必要があります。 コマンドメソッド。このメソッドはコマンド クラスの配列を受け取ります。これらのコマンドが正常に登録されると、Artisan コマンド ラインを使用して実行できます:

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){ 
    $this->loadViewsFrom(__DIR__.'/path/to/views', 'courier');    
    $this->publishes([     
       __DIR__.'/path/to/views' => resource_path('views/vendor/courier'), 
      ]);
  }

Public Resource File

yours 拡張機能パッケージには、JavaScript、CSS、画像などのリソース ファイルが含まれる場合があります。これらのリソース ファイルをアプリケーションの public ディレクトリに公開するには、サービス プロバイダーの publishes メソッドを使用できます。次の例では、public リソース分類タグを追加することもできます。これを使用して、関連する公開リソースを分類することができます。

/**
 * 引导应用服务。
 *
 * @return void
 */
 public function boot(){  
   if ($this->app->runningInConsole()) {      
     $this->commands([         
        FooCommand::class,            
        BarCommand::class,       
      ]);  
    }
  }

今、拡張パッケージのユーザーが ## を実行すると、 #vendor:publish コマンドを実行すると、リソース ファイルが指定されたディレクトリにコピーされます。通常、リソース ファイルは拡張パックが更新されるたびに上書きする必要があるため、--force タグが必要です:

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){ 
    $this->publishes([     
       __DIR__.'/path/to/assets' => public_path('vendor/courier'),  
     ], 'public');
 }

##

グループ ファイルの公開

拡張パックのリソース ファイルまたはリソースを個別にパッケージ化して公開したい場合があります。たとえば、ユーザーが拡張機能パッケージ内のすべてのリソース ファイルを強制的に公開するのではなく、拡張機能パッケージ内の構成ファイルを個別に公開できるようにしたい場合があります。拡張パッケージ サービス プロバイダーの publishes メソッドを呼び出すことで、さまざまなファイルに「タグを付ける」ことができます。たとえば、拡張パッケージ サービス プロバイダーの boot メソッドを使用して、2 つの公開グループを定義してみましょう。

php artisan vendor:publish --tag=public --force

これで、ユーザーは vendor:publish を実行することでこれを行うことができます。定義されたタグに基づいてさまざまなグループ ファイルを公開するコマンド:

/**
 * 在注册后启动服务。
 *
 * @return void
 */
 public function boot(){
     $this->publishes([    
         __DIR__.'/../config/package.php' => config_path('package.php')  
       ], 'config'); 
      $this->publishes([    
          __DIR__.'/../database/migrations/' => database_path('migrations')  
        ], 'migrations');
       }

この記事は、LearnKu.com Web サイトで初めて公開されました。