fixing issues from review

Author: claurospace

README.md

@@ -20,7 +20,7 @@ It provides base classes for action based controllers similar to Laminas control
 
 Install `dot-controller` by executing the following Composer command:
 
-```bash 
+```bash
 $ composer require dotkernel/dot-controller
 ```
 
@@ -35,6 +35,7 @@ Middleware controllers act as a handler for multiple routes. Some conventions we
 In order to create your action based controllers, you must extend the abstract class `DotKernel\DotController\AbstractActionController`
 
 ### Example
+
 Creating a UserController with default action and a register action. Will handle routes `/user` and `/user/register`
 
 ```php

composer.json

@@ -55,7 +55,8 @@
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "laminas/laminas-dependency-plugin": true
         }
     }
 }

docs/book/v3/configuration.md

@@ -1,5 +1,5 @@
 # Configuration
 
 After installation, the package can be used immediately but if you want to use all features of the package, like plugins and events you need to register the `ConfigProvider` in your project by adding the below line to your configuration aggregator (usually: `config/config.php`):
-    
+
     \Dot\Controller\ConfigProvider::class

docs/book/v3/events.md

@@ -4,12 +4,11 @@ DotKernel's controller package supports events and those events can be of 2 type
 
 ## Getting started
 
-- Every event listener that is triggered from a controller 
+- Every event listener that is triggered from a controller
 needs to implement `Dot\Controller\Event\ControllerEventListenerInterface` which actually extends `Laminas\EventManager\ListenerAggregateInterface`.
 - You can add the trait `Dot\Controller\Event\ControllerEventListenerTrait` to override the method of the interface.
 - Every event listener needs to be registered under the `['dot_controller']['event_listenenrs]` key in the ConfigProvider, and every key must be the class that you want to attach the events
 
- 
 ## Usage
 
 The events in a controller can be done in 2 different ways, a global way where an event is attached automatically to all the controllers action and works in the same way the middlewares works
@@ -43,6 +42,7 @@ class UserController extends AbstractActionController
 ### Example 1 - Global way
 
 First we will create the event listener
+
 ```php
 use Dot\Controller\Event\ControllerEvent;
 use Dot\Controller\Event\ControllerEventListenerInterface;
@@ -84,9 +84,9 @@ after the controller is dispatched.
 
 With this it doesn't matter what action is accessed, the event it will run before and after the action.
 
-In addition, you can make use of the `event` variable to access information about the event. 
+In addition, you can make use of the `event` variable to access information about the event.
 
-For example: 
+For example:
 
 ```php
 // UserUpdatedListener
@@ -101,8 +101,10 @@ public function onAfterDispatch(ControllerEvent $e): void
     }
 ```
 
-So every time the `updateAction` is accessed and the method is post, right after the action is dispatched, we can log that the user was updated. <br>
-We can use the `onBeforeDispatch` in the same way, to log right before the user is updated. 
+So every time the `updateAction` is accessed and the method is post, 
+right after the action is dispatched, we can log that the user was updated.
+
+We can use the `onBeforeDispatch` in the same way, to log right before the user is updated.
 
 ### Example 2 - Manually triggered way
 
@@ -134,8 +136,10 @@ class UserUpdatedListener implements ControllerEventListenerInterface
 }
 ```
 
-The `attach` method is from the `ListenerAggregateInterface` which `ControllerEventListenerTrait` already is overriding it so can be used in a global way
-with `onBeforeDispatch` and `onAfterDispatch` methods, but we can make our custom event and bind it to our method. <br>
+The `attach` method is from the `ListenerAggregateInterface` which `ControllerEventListenerTrait` 
+already is overriding it so can be used in a global way with `onBeforeDispatch` and `onAfterDispatch` 
+methods, but we can make our custom event and bind it to our method.
+
 In this case we create attach an event called `user.profile.update` and bind it to the `userProfileUpdated`  method.
 
 Next we need to register the event

docs/book/v3/plugins.md

@@ -4,15 +4,22 @@ DotKernel's controller support plugins, much like controllers in a Laminas Appli
 The package comes packed with a few built in plugins, but you can extend controller functionality with your own plugins.
 
 ## Usage
-Any controller plugins must implement `Dot\Controller\Plugin\PluginInterface`. 
-You need to create a factory in addition to the plugin and register it under the `['dot_controller']['plugin_manager']['factories']` with the plugin name. <br>
 
-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) <br>
-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 unnecessary plugins.
+Any controller plugins must implement `Dot\Controller\Plugin\PluginInterface`.
+You need to create a factory in addition to the plugin and register it
+under the `['dot_controller']['plugin_manager']['factories']` with the plugin name.
+
+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)
+
+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 unnecessary plugins.
 
 ### Example
 
-First we create our desired plugin, for our example a string helper 
+First we create our desired plugin, for our example a string helper
 
 ```php
 class StringPlugin implements PluginInterface
@@ -54,7 +61,8 @@ Register the factory under the `['dot_controller']['plugin_manager']['factories'
 ]
 ```
 
-You don't need to register the plugin factory to a regular dependencies in a configuration because `AbstractPluginManager` actually extends `ServiceManager`
+You don't need to register the plugin factory to a regular dependencies in a configuration
+because `AbstractPluginManager` actually extends `ServiceManager`
 
 Access it in a controller.
 
@@ -66,11 +74,10 @@ $this->string()->toUpper("test") // will return TEST
 
 ## Build-in plugins
 
-The package comes in with 2 default plugins ``template`` and `url`. You can use 
+The package comes in with 2 default plugins ``template`` and `url`. You can use
 them in the same way as our example above.
 
-- Url plugin
-- - the plugin is an instance of `Mezzio\Helper\UrlHelper`
+- `url` - the plugin is an instance of `Mezzio\Helper\UrlHelper`
 
 ```php
     //in a controller action 
@@ -79,8 +86,7 @@ them in the same way as our example above.
     echo $url->generate('account', ['action' => 'foo', 'hash' => 'bar'])
 ```
 
-- Template plugin
-- - the plugin is an instance of `Mezzio\Template\TemplateRendererInterface`
+- `template` - the plugin is an instance of `Mezzio\Template\TemplateRendererInterface`
 
 ```php
     // in a controller action

docs/book/v3/usage.md

@@ -9,6 +9,7 @@ Middleware controllers act as a handler for multiple routes. Some conventions we
 In order to create your action based controllers, you must extend the abstract class `DotKernel\DotController\AbstractActionController`
 
 ## Example
+
 Creating a UserController with default action and a register action. Will handle routes `/user` and `/user/register`
 
 ```php

mkdocs.yml

@@ -17,3 +17,5 @@ nav:
 site_name: dot-controller
 site_description: "DotKernel's controller package"
 repo_url: "https://github.com/dotkernel/dot-controller"
+plugins:
+  - search