Extension package development

• Introduction
  • Facades Notes
• Discover expansion pack
• Service provider
• Resource file
  • Configuration
  • Database Migration
  • Routing
  • Language Pack
  • View
• Command
• Public resource file
• Publish group file

Introduction

Extension packages are the main way to add functionality to Laravel. Extension packages can contain many useful features, such as the time processing extension package Carbon, or the extension package Behat that provides a complete BDD testing framework.

Of course, there are many types of expansion packs. Some extensions are standalone, meaning they can be used with any PHP framework. Carbon and Behat are such standalone expansion packs. To use this extension package in Laravel, you only need to introduce them in the composer.json file.

On the other hand, some extension packages can only be used in Laravel. These extension packages may contain files specifically designed to enhance your Laravel application's routes, controllers, views, and configuration. This guide mainly introduces the development of Laravel extension packages.

Facades Notes

When developing Laravel applications, there is usually no difference between using contracts or facades. Because they all provide essentially the same testability capabilities. However, when developing extension packages, the extension package does not have access to all test helper functions provided by Laravel. If you want to write test cases for an extension package like you would in a Laravel application, you can use the extension package Orchestral Testbench.

Discover the extension package

In the config/app.php configuration file of the Laravel application, the providers option defines the list of service providers that can be loaded by Laravel . When someone installs your extension, you need to include your service provider in this list. Instead of having users manually add your service providers to the list, you can define your service providers into the extra section of your extension package's composer.json file. In addition to service providers, you can also list all the facades you want to register:

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

Once your extension package is configured to be discoverable, Laravel will automatically register the service providers and facades of the extension package during installation. Provide a user-friendly installation experience for extension pack users.

Selective discovery of extension packages

If you are an extension package user and want to prevent an extension package from being discovered, you can do so in the application's composer The extra section of the .json file lists this extension:

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

You can also use ## in your application's dont-discover directive #* characters, disable the extension package discovery function:

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

Service Provider Connect your extension with Laravel. The service provider is responsible for binding something to Laravel's service container and telling Laravel where to load the resource files of the extension package, such as views, configuration files, language packs, etc.

The service provider inherits the

class and contains two methods: register and boot. The base class ServiceProvider is located in the Composer extension package named illuminate/support, and you must add it to your extension package dependencies. To learn more about the structure and purpose of a service provider, consult its documentation.

Sometimes you need to publish the extension pack configuration file to the

directory of the application itself . In this way, users using the extension package can easily override the default configuration items. To publish the expansion package configuration file, you only need to call the publishes method in the service provider's boot method:

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

command, and the extension package file will be copied to the specified directory. Of course, once your configuration file is published, it can be accessed like any other configuration:

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

config:cache

Artisan command, the configuration file will not be serialized correctly.

Extension package default configuration

You can also merge the extension package default configuration with the application's copy configuration. This allows extension pack users to define the configuration options they want to override in the replica configuration file. To merge configurations, just call the mergeConfigFrom method in the service provider's register method:

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

{note} This method only merges Configure the first dimension of the array. If the extension user defines a multidimensional configuration array, missing options will not be merged.

Routing

If your extension package contains routing files, you need to use The loadRoutesFrom method loads them. This method will automatically determine whether the applied route has been cached. If the route has been cached, your route file will not be loaded:

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

loadMigrationsFrom method to tell Laravel how to load them. The loadMigrationsFrom method only requires the extension pack migration file path as the only parameter:

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

php artisan migrate command will be executed automatically. You do not need to import them into your application's database/migrations directory.

loadTranslationsFrom method tells Laravel how to load them. For example, if your extension package is named courier, you need to add the following content to the service provider's boot method:

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

package::file.line syntax to reference. Therefore, you can load the welcome line of the messages file in the courier extension package as follows:

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

resources/lang/vendor directory, you can use the service provider's publishes method. publishes The method receives an array containing the language pack path and the corresponding publishing location. For example, to publish the language pack file of the courier extension package, the operation is as follows:

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

vendor:publish Artisan command, the language The package will be published to the specified directory.

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

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

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

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

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

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

/**
 * 在注册后启动服务。
 *
 * @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');
       }

php artisan vendor:publish --tag=config