|
| 1 | +# dk-controller |
| 2 | + |
| 3 | +This package contains controller like middleware to be used inside a DotKernel or Expressive application. It provides base classes for action based controllers similar to ZF3 controller component. It is more lightwight though, but supports controller plugins. |
| 4 | + |
| 5 | +## Installation |
| 6 | + |
| 7 | +We use this in our web starter packages, so it will automatically be installed if you use them. For manual installation, just add the appropriate package to your `composer.json` |
| 8 | + |
| 9 | +`composer install n3vrax/dk-controller` |
| 10 | + |
| 11 | +For default module dependencies, you need to merge the ConfigProvider class output to your config. Again, if you are using the web started packages, this is already handled. |
| 12 | + |
| 13 | +By doing this, you "enable" the module to be available functionally for your project |
| 14 | + |
| 15 | +## Usage |
| 16 | + |
| 17 | +Middleware controllers act as a handler for multiple routes. Some conventions were made: |
| 18 | +- register controllers in the routes array just like any expressive middleware. The requirement is you should define an `action` route parameter(possibly optional) anywhere inside the route(e.g `/user[/{action}]`) |
| 19 | +- action parameter value is converted to a method name inside the controller. Underscore, dot and line characters are removed and the action name is converted to camel-case suffixed by the string `Action`. For example a route and action pair like `/user/forgot-password` will be converted to method `forgotPasswordAction` inside a `UserController` class(as defined in routes config) |
| 20 | +- the default action value, if not present in the URI is `index`, so you should always define an `indexAction` within your controllers for displaying a default page or redirecting. |
| 21 | + |
| 22 | +In order to create your action based controllers, you must extend the abstract class `DotKernel\DotController\AbstractActionController` |
| 23 | + |
| 24 | +##### Example 1 |
| 25 | +Creating a UserController with default action and a register action. Will handle routes `/user` and `/user/register` |
| 26 | +##### UserController.php |
| 27 | +```php |
| 28 | + |
| 29 | +use DotKernel\DotController\AbstractActionController; |
| 30 | + |
| 31 | +class UserController extends AbstractActionController |
| 32 | +{ |
| 33 | + public function indexAction() |
| 34 | + { |
| 35 | + //... |
| 36 | + } |
| 37 | + |
| 38 | + public function registerAction() |
| 39 | + { |
| 40 | + //... |
| 41 | + } |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +Then register this controller in the `routes` config(we assume you use FastRouter and ZF3 service manager) |
| 46 | +##### routes.global.php |
| 47 | +```php |
| 48 | +'dependencies' => [ |
| 49 | + //add UserController class as a dependency, in invokable or factories etc. |
| 50 | + //for example |
| 51 | + 'factories' => [ |
| 52 | + \Your\Namespace\UserContoller::class => \Your\Namespace\UserContollerFactory::class, |
| 53 | + ] |
| 54 | +], |
| 55 | + |
| 56 | +'routes' => [ |
| 57 | + [ |
| 58 | + 'name' => 'user', |
| 59 | + 'path' => '/user[/{action}]', |
| 60 | + 'middleware' => Your\Namespace\UserController::class, |
| 61 | + ] |
| 62 | +], |
| 63 | +``` |
| 64 | + |
| 65 | +### Multiple controllers for the same route |
| 66 | + |
| 67 | +Use case: You have defined a controller inside some package, with default actions. You want to add actions that fall into the same controller name(or route name more exactly). You want to do this without extending the controller provided by the package. In this case you can do the following |
| 68 | +- create your own controller, independent of the package's controller which adds or overwrites actions |
| 69 | +- ZE lets you define an array o middleware for a route, so you can register this controller before the package's controller |
| 70 | + |
| 71 | +##### Example |
| 72 | +```php |
| 73 | +'routes' => [ |
| 74 | + [ |
| 75 | + 'name' => 'user', |
| 76 | + 'path' => '/user[/{action}]', |
| 77 | + 'middleware' => [Your\Namespace\UserController::class, Package\UserController::class], |
| 78 | + ] |
| 79 | +] |
| 80 | +``` |
| 81 | + |
| 82 | +Now when a request for this route comes in, your controller will run first. Controllers are designed to ignore requests that cannot be matched to one of its methods, so if no action matches, it will call the next middleware, in our case, the second controller. If this is the last controller, and action does not match here, it will go to the default 404 Not found page. There is a simple middleware defined in dk-base that makes sure any request that does not match will be converted explicitly to a 404 error. |
| 83 | + |
| 84 | +## Controller plugins |
| 85 | + |
| 86 | +Controllers support controller plugins, much like controllers in a ZF3 application. The module comes packed with a few common plugins, but you can extend controller functionality with your own plugins too. |
| 87 | + |
| 88 | +### Usage |
| 89 | + |
| 90 | +Controller plugins must implement `DotKernel\DotController\Plugin\PluginInterface`. You can add them to the cconfig file, at key `['dk_controller']['plugin_manager']`. The design pattern uses the AbstractPluginManager provided by ZF3 service manager component. So, registration of a plugin under the aformentioned config key looks the same as the declaration of regular dependencies, as AbstractPluginManager actually extends ServiceManager. |
| 91 | + |
| 92 | +Once registered, a plugin can be directly accessed in any controller, by calling a method with the plugin's name(the service name or the key at which the plugin is registered inside the manager) |
| 93 | + |
| 94 | +Controller plugins offer the advantage of globally accessible functionality in any controller without to manually inject dependencies. Plugins should be used for functions that are common to any controller. Do not clutter controller's code with unecessary plugins. |
| 95 | + |
| 96 | +##### Example |
| 97 | +```php |
| 98 | +//inside a controller |
| 99 | +//assume we've already registered a plugin called testPlugin |
| 100 | +$this->testPlugin(); //will return the TestPlugin class so you can call any public defined method on it |
| 101 | +$this->testPlugin()->someMethod(); |
| 102 | +``` |
| 103 | + |
| 104 | +### Already provided plugins |
| 105 | +Note: Each of these plugins requires the associated DK3 or ZE packages to be installed and available in your project. |
| 106 | +Although these are optional, if a package is missing, the controller will not have the associated funcionality available |
| 107 | + |
| 108 | +- `authentication` which wraps a AuthenticationInterface and defines methods `hadIdentity()` and `getIentity()` |
| 109 | +- `authorization` which wraps an AuthorizationInterface and defines method `isGranted($permission, array $roles = [], $context = null)` |
| 110 | +- `flashMessenger` wraps FlashMessenger for one time session based messages support |
| 111 | +- `template` wraps TemplateInterface provided by ZE, to make template engine accessible to any controller |
| 112 | +- `urlHelper` wraps the UrlHelper class provided by ZE helpers package. Used to generate URIs from routes |
0 commit comments