From f2e9ee9db6c6884b5e6c2217373b0680265f2229 Mon Sep 17 00:00:00 2001 From: alexmerlin Date: Wed, 15 Jan 2025 09:07:37 +0000 Subject: [PATCH] Automated deployment: Wed Jan 15 09:07:37 UTC 2025 4.0.0 --- index.html | 213 +++++++++---- pages/404.html | 164 +++++++--- search/search_index.json | 2 +- sitemap.xml | 45 ++- sitemap.xml.gz | Bin 270 -> 274 bytes v3/configuration/index.html | 208 ++++++++---- v3/events/index.html | 208 ++++++++---- v3/installation/index.html | 208 ++++++++---- v3/overview/index.html | 212 +++++++++---- v3/plugins/index.html | 208 ++++++++---- v3/usage/index.html | 208 ++++++++---- v4/configuration/index.html | 467 +++++++++++++++++++++++++++ v4/events/index.html | 613 ++++++++++++++++++++++++++++++++++++ v4/installation/index.html | 467 +++++++++++++++++++++++++++ v4/overview/index.html | 466 +++++++++++++++++++++++++++ v4/plugins/index.html | 547 ++++++++++++++++++++++++++++++++ v4/usage/index.html | 530 +++++++++++++++++++++++++++++++ 17 files changed, 4304 insertions(+), 462 deletions(-) create mode 100644 v4/configuration/index.html create mode 100644 v4/events/index.html create mode 100644 v4/installation/index.html create mode 100644 v4/overview/index.html create mode 100644 v4/plugins/index.html create mode 100644 v4/usage/index.html diff --git a/index.html b/index.html index fde14b3..5295530 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ - + @@ -13,16 +13,14 @@ - + - - - + dot-controller - DotKernel Documentation @@ -40,7 +38,8 @@
- DotKernel Logo + DotKernel Logo
@@ -49,45 +48,67 @@
@@ -111,6 +132,35 @@
  • +
    +
    + +
    + + + + + v4 (latest) + + + + + + + + v3 + + + + +
    +
    +
    +
    • @@ -123,7 +173,7 @@
    1. Overview
      2. -
    2. Packages
      3. +
    3. dot-controller
      4. @@ -153,40 +203,48 @@
      Table of Contents
      -
    4. - Overview -
      5. +
    5. + Overview +
      6. -
    6. - Installation -
      7. +
    7. + Installation +
      8. -
    8. - Configuration -
      9. +
    9. + Configuration +
      10. -
    10. - Usage -
      11. +
    11. + Usage +
      12. -
    12. - Plugins -
      13. +
    13. + Plugins +
      14. -
    14. - Events -
      15. +
    15. + Events +
      16. + + + + + + + + @@ -204,15 +262,14 @@
      Table of Contents
      +

      dot-controller

      -

      DotKernel's controller package

      - - +

      Dotkernel's controller package

      Installation

      Using Composer

               
-        $ composer require dotkernel/dot-controller
+        composer require dotkernel/dot-controller
      @@ -235,7 +292,7 @@

      Support

    16. - @@ -344,6 +421,14 @@

      Support

      let base_url = '.', project = "packages", siteName = 'dot-controller'; + + document.addEventListener("DOMContentLoaded", function() { + document.querySelectorAll('.subnavigation__link').forEach(function(link) { + if (link.getAttribute('href') === './') { + link.parentNode.parentNode.classList.add('show'); + } + }); + }); diff --git a/pages/404.html b/pages/404.html index da795d5..10c2625 100644 --- a/pages/404.html +++ b/pages/404.html @@ -5,7 +5,7 @@ - + @@ -13,14 +13,12 @@ - + - - - + dot-controller - DotKernel Documentation @@ -38,7 +36,8 @@
      - DotKernel Logo + DotKernel Logo
      @@ -47,45 +46,67 @@
      @@ -109,6 +130,35 @@
    17. +
      +
      + +
      + + + + + v4 (latest) + + + + + + + + v3 + + + + +
      +
      +
      +
    @@ -121,7 +171,7 @@
    1. Overview
      2. -
    2. Packages
      3. +
    3. dot-controller
      4. @@ -158,6 +208,14 @@
      Table of Contents
      + + + + + + + + @@ -189,54 +247,74 @@

      Something went wrong!

      @@ -278,6 +356,14 @@

      Something went wrong!

      let base_url = '..', project = "packages", siteName = 'dot-controller'; + + document.addEventListener("DOMContentLoaded", function() { + document.querySelectorAll('.subnavigation__link').forEach(function(link) { + if (link.getAttribute('href') === './') { + link.parentNode.parentNode.classList.add('show'); + } + }); + }); + + + + +
    4. + + + GitHub + +
      5. +
    5. + +
      +
      + +
      + + + + + v4 (latest) + + + + + + + + v3 + + + + +
      +
      +
      + +
      6. + + + + + + +
      + +
      + + +
      +
      +
      + + +
      + + + + +
      Table of Contents
      + + +
      + + + + + + + + + + + + +
      +
      + + + + + + + + + +

      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
+
      + + + + + + + + + +
      +
      +
      + + + + + + + + + diff --git a/v4/events/index.html b/v4/events/index.html new file mode 100644 index 0000000..8339ce0 --- /dev/null +++ b/v4/events/index.html @@ -0,0 +1,613 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Events - dot-controller - DotKernel Documentation + + + + + + + + + + + + + + +
      + +
      + + +
      +
      +
      + + +
      + + + + +
      Table of Contents
      + + +
      + + + + + + + + + + +
      +
      On this page
      + +
      + + + +
      +
      + + + + + + + + + +

      Events

      +

      DotKernel's controller package supports events and those events can be of 2 types: global events (middleware-like) or manually dispatch events.

      +

      Getting started

      +
        +
      • 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 +or a manually dispatchable way, where you can define to which controller the events is attached, and you can trigger the event where you want.

      +

      For our example we have a UserController with some methods in it

      +
      use DotKernel\DotController\AbstractActionController;
+
+class UserController extends AbstractActionController
+{
+    public function indexAction()
+    {
+        //...
+    }
+
+    public function registerAction()
+    {
+        //...
+    }
+
+    // post method for updating the user
+    public function updateAction()
+    {
+
+    }
+}
      +

      Example 1 - Global way

      +

      First we will create the event listener

      +
      use Dot\Controller\Event\ControllerEvent;
+use Dot\Controller\Event\ControllerEventListenerInterface;
+use Dot\Controller\Event\ControllerEventListenerTrait;
+
+// for the logger we assume you will use your own logger and inject it
+
+class UserUpdatedListener implements ControllerEventListenerInterface
+{
+    use ControllerEventListenerTrait;
+
+    public function onBeforeDispatch(ControllerEvent $event): void
+    {
+        $this->logger->info('on before dispatch');
+    }
+
+    public function onAfterDispatch(ControllerEvent $event): void
+    {
+        $this->logger->info('on after dispatch');
+    }
+
+}
      +

      We register the event listener in the configuration key

      +
      'dot_controller' => [
+    'event_listeners' => [
+        AccountController::class => [
+            UserUpdatedListener::class,
+        ]
+    ]
+]
      +

      As you can assume, onBeforeDispatch is triggered right before the controller is dispatched, and onAfterDispatch right +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.

      +

      For example:

      +
      // UserUpdatedListener
+public function onAfterDispatch(ControllerEvent $e): void
+    {
+        $method = $e->getTarget()->getRequest()->getMethod();
+        $action = $e->getParams()['method'];
+        if ($method == 'POST' && $action == 'updateAction') {
+            $this->logger->info('this will trigger ');
+
+        }
+    }
      +

      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

      +
      use Dot\Controller\Event\ControllerEvent;
+use Dot\Controller\Event\ControllerEventListenerInterface;
+use Dot\Controller\Event\ControllerEventListenerTrait;
+
+// for the logger we assume you will use your own logger and inject it
+
+class UserUpdatedListener implements ControllerEventListenerInterface
+{
+    use ControllerEventListenerTrait;
+
+     public function attach(EventManagerInterface $events, $priority = 1): void
+    {
+        $this->listeners[] = $events->attach(
+            'user.profile.update',
+            [$this, 'userProfileUpdated'],
+            $priority
+        );
+    }
+
+    public function userProfileUpdated(ControllerEvent $event): void
+    {
+        $this->logger->info('User profile updated');
+    }
+
+}
      +

      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

      +
      'dot_controller' => [
+    'event_listeners' => [
+        AccountController::class => [
+            'user.profile.update' => UserUpdatedListener::class
+        ]
+    ]
+]
      +

      Now you can manually trigger the event from the controller using build in dispatchEvent method.

      +
      // UserController
+// post method for updating the user
+public function updateAction()
+{
+    // logic
+    $this->dispatchEvent('user.profile.update', ['user' => $user]);
+
+}
      +

      As you can see we attach the user key to the parameters, so we can actually access it.

      +
          public function userProfileUpdated(ControllerEvent $event): void
+    {
+        $user = $event->getParams()['user'];
+        $this->logger->info('User profile updated', $user->toArray());
+    }
      + + + + + + + + + +
      +
      +
      + + + + + + + + + diff --git a/v4/installation/index.html b/v4/installation/index.html new file mode 100644 index 0000000..22f0d80 --- /dev/null +++ b/v4/installation/index.html @@ -0,0 +1,467 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Installation - dot-controller - DotKernel Documentation + + + + + + + + + + + + + + +
      + +
      + + +
      +
      +
      + + +
      + + + + +
      Table of Contents
      + + +
      + + + + + + + + + + + + +
      +
      + + + + + + + + + +

      Installation

      +

      Install dot-controller by executing the following Composer command:

      +
      composer require dotkernel/dot-controller
+
      + + + + + + + + + +
      +
      +
      + + + + + + + + + diff --git a/v4/overview/index.html b/v4/overview/index.html new file mode 100644 index 0000000..9744ff5 --- /dev/null +++ b/v4/overview/index.html @@ -0,0 +1,466 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Overview - dot-controller - DotKernel Documentation + + + + + + + + + + + + + + +
      + +
      + + +
      +
      +
      + + +
      + + + + +
      Table of Contents
      + + +
      + + + + + + + + + + + + +
      +
      + + + + + + + + + +

      Overview

      +

      dot-controller is DotKernel's controller package that can be use like middleware inside DotKernel or Mezzio application. +It provides base classes for action based controllers similar to Laminas controller component. It is more lightweight though, but supports controller plugins and event listeners

      + + + + + + + + + +
      +
      +
      + + + + + + + + + diff --git a/v4/plugins/index.html b/v4/plugins/index.html new file mode 100644 index 0000000..e10a2cc --- /dev/null +++ b/v4/plugins/index.html @@ -0,0 +1,547 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Plugins - dot-controller - DotKernel Documentation + + + + + + + + + + + + + + +
      + +
      + + +
      +
      +
      + + +
      + + + + +
      Table of Contents
      + + +
      + + + + + + + + + + +
      +
      On this page
      + +
      + + + +
      +
      + + + + + + + + + +

      Plugins

      +

      DotKernel's controller support plugins, much like controllers in a Laminas Applications. +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.

      +

      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

      +
      class StringPlugin implements PluginInterface
+{
+
+    // any method inside the plugin needs to be public if you want to access it from a controller
+    public function toUpper(string $string): string
+    {
+        return strtoupper($string);
+    }
+}
      +

      We create a factory for the plugin

      +
      use Psr\Container\ContainerInterface;
+
+class StringPluginFactory
+{
+
+    public function __invoke(ContainerInterface $container): StringPlugin
+    {
+        return new StringPlugin();
+    }
+
+}
      +

      Register the factory under the ['dot_controller']['plugin_manager']['factories'] key.

      +
      'dot_controller' => [
+    'plugin_manager' => [
+        'factories' => [
+            'string' => StringPluginFactory::class
+        ]
+    ]
+]
      +

      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.

      +
      //inside a controller 
+$this->string(); // will return the StringPlugin class, so you can call any public method from it
+$this->string()->toUpper("test") // will return TEST
      +

      Build-in plugins

      +

      The package comes in with 2 default plugins template and url. You can use +them in the same way as our example above.

      +
        +
      • url - the plugin is an instance of Mezzio\Helper\UrlHelper
        • +
      +
          //in a controller action 
+    /** @var UrlHelper $url */
+    $url = $this->url();
+    echo $url->generate('account', ['action' => 'foo', 'hash' => 'bar'])
      +
        +
      • template - the plugin is an instance of Mezzio\Template\TemplateRendererInterface
        • +
      +
          // in a controller action
+    return new HtmlResponse(
+        $this->template->render('page::home', [
+            'foo' => 'bar'
+        ])
+    );
      + + + + + + + + + +
      +
      +
      + + + + + + + + + diff --git a/v4/usage/index.html b/v4/usage/index.html new file mode 100644 index 0000000..faa199d --- /dev/null +++ b/v4/usage/index.html @@ -0,0 +1,530 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Usage - dot-controller - DotKernel Documentation + + + + + + + + + + + + + + +
      + +
      + + +
      +
      +
      + + +
      + + + + +
      Table of Contents
      + + +
      + + + + + + + + + + +
      +
      On this page
      + +
      + + + +
      +
      + + + + + + + + + +

      Usage

      +

      Middleware controllers act as a handler for multiple routes. Some conventions were made:

      +
        +
      • register controllers in the routes array just like any mezzio middleware. The requirement is that you should define an action route parameter(possibly optional) anywhere inside the route(e.g /user[/{action}])
        • +
      • 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.
        • +
      • 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.
        • +
      +

      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

      +
      use DotKernel\DotController\AbstractActionController;
+
+class UserController extends AbstractActionController
+{
+    public function indexAction()
+    {
+        //...
+    }
+
+    public function registerAction()
+    {
+        //...
+    }
+}
      +

      Then register this controller as a routed middleware in file RoutesDelegator.php just like a regular middleware.

      +
      //Example from a DotKernel RoutesDelegator
+$app->route(
+    '/user[/{action}]',
+    UserController::class,
+    [RequestMethodInterface::METHOD_GET, RequestMethodInterface::METHOD_POST],
+    'user'
+);
      +

      Multiple controllers for the same route

      +

      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

      +
        +
      • create your own controller, independent of the package's controller which adds more actions
        • +
      • Mezzio lets you define an array of middleware for a route, so you can register this controller before the package's controller
        • +
      +

      Now when a request for this route comes in, your controller will run first. DotKernel 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(handled by NotFoundDelegate)

      +

      Plugins

      + +

      Events

      + + + + + + + + + + +
      +
      +
      + + + + + + + + +