How to register middlewares in OctoberCMS plugin?

Question

Registering middlewares in Laravel is easy:

simply list the middleware class in the $middleware property of your app/Http/Kernel.php class

or

If you would like to assign middleware to specific routes, you should first assign the middleware a short-hand key in your app/Http/Kernel.php file

But how can this be done in an OctoberCMS plugin? Is the " Routing and initialization " meant to be used in place of Kernel.php to register middlewares? If not, where can a plugin register its own middlewares?

Answer 1

As mentioned in the Documentation you can extend the controller class inside the the boot method of your plugin.php ;

public function boot()
{

    // Extend Controller Class
    \Cms\Classes\CmsController::extend(function($controller) {
        $controller->middleware('Middleware\Path..');
    });


    // OR Push it directly to the Kernel

      // prependMiddleware : Add a new middleware to beginning of the stack.
     $this->app['Illuminate\Contracts\Http\Kernel']
        ->prependMiddleware('Middleware\Path..');

     // pushMiddleware : Add a new middleware to end of the stack.
     $this->app['Illuminate\Contracts\Http\Kernel']
        ->pushMiddleware('Middleware\Path..');

}

Also you can add it in your plugin's routes.php file :

Route::group(['prefix' => 'foo'], function () {

        Route::get('{slug}', function($slug){

           ....

        })->where('slug', '(.*)?')->middleware('Path\To\Middleware');
});

Answer 2

我使用'middleware'选项在我的插件routes.php中使用带有Route组的完全限定类名来实现它

Route::group(['middleware' => '\Namespace\ABC123\AuthMiddleware'], function(){

Answer 3

Use this

Cms\Classes\CmsController::extend(function($controller) {
$controller->middleware('your middleware here');
});

Answer 4

Actually you can push a middleware on your plugin register callback because it's registered before middleware happen.

class YourPlugin extends PluginBase
{
   public function register()
   {
    $kernel = app()->make('Illuminate\Contracts\Http\Kernel');
    $kernel->pushMiddleware(YourMiddleWare::class);
   }
}

Answer 5

You have to list the middleware class

$middleware property

of the Kernel.php class.