Merge pull request #39 from dotkernel/issue-38

Issue 38

Author: arhimede

.github/workflows/continuous-integration.yml

@@ -0,0 +1,11 @@
+name: "Continuous Integration"
+
+on:
+  pull_request:
+  push:
+    branches:
+    tags:
+
+jobs:
+  ci:
+    uses: laminas/workflow-continuous-integration/.github/workflows/[email protected]

.github/workflows/cs-tests.yml

@@ -0,0 +1,16 @@
+name: docs-build
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Docs
+        uses: dotkernel/documentation-theme/github-actions/docs@main
+        env:
+          DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs-build.yml

@@ -1,6 +1,7 @@
 # dot-controller
 
-This package contains controller like middleware to be used inside a 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.
+This 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
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-controller)
 ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-controller/3.4.3)
@@ -17,27 +18,27 @@ This package contains controller like middleware to be used inside a DotKernel o
 
 ## Installation
 
-Run the following composer command in your project directory
+Install `dot-controller` by executing the following Composer command:
+
 ```bash
 $ composer require dotkernel/dot-controller
 ```
-Merge the `ConfigProvider` to your configuration aggregate.
 
 ## 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 1
+### Example
+
 Creating a UserController with default action and a register action. Will handle routes `/user` and `/user/register`
 
-##### UserController.php
 ```php
-
 use DotKernel\DotController\AbstractActionController;
 
 class UserController extends AbstractActionController
@@ -56,38 +57,22 @@ class UserController extends AbstractActionController
 
 Then register this controller as a routed middleware in file `RoutesDelegator.php` just like a regular middleware.
 
+```php
+//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. 
+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)
-
-## Controller plugins
-
-Controllers support controller plugins, much like controllers in a Laminas application. The module comes packed with a few common plugins, but you can extend controller functionality with your own plugins too.
-
-### Usage
-
-Controller plugins must implement `Dot\Controller\Plugin\PluginInterface`. You can add them to the config file, at key `['dk_controller']['plugin_manager']`. The design pattern uses the `AbstractPluginManager` provided by Laminas service manager component. So, registration of a plugin under the aforementioned config key looks the same as the declaration of regular dependencies, as `AbstractPluginManager` actually extends `ServiceManager`.
-
-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
-```php
-//inside a controller
-//assume we've already registered a plugin called testPlugin
-$this->testPlugin(); //will return the TestPlugin class so you can call any public defined method on it
-$this->testPlugin()->someMethod();
-```
-
-### Built-in plugins
-Note: Each of these plugins requires the associated Mezzio packages to be installed and available in your project.
-Although these are optional, if a package is missing, the controller will not have the associated functionality available
-
-- `template` wraps TemplateInterface provided by Mezzio, to make template engine accessible to any controller
-- `url` wraps the UrlHelper class provided by Laminas helpers package. Used to generate URIs from routes

.github/workflows/static-analysis.yml

@@ -0,0 +1,39 @@
+# Security Policy
+
+## Supported Versions
+
+
+| Version | Supported          | PHP Version                                                                                                    |
+|---------|--------------------|----------------------------------------------------------------------------------------------------------------|
+| 3.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-controller/3.4.3) |
+| <= 2.x  | :x:                |                                                                                                                |
+
+
+## Reporting Potential Security Issues
+
+If you have encountered a potential security vulnerability in this project,
+please report it to us at <[email protected]>. We will work with you to
+verify the vulnerability and patch it.
+
+When reporting issues, please provide the following information:
+
+- Component(s) affected
+- A description indicating how to reproduce the issue
+- A summary of the security vulnerability and impact
+
+We request that you contact us via the email address above and give the
+project contributors a chance to resolve the vulnerability and issue a new
+release prior to any public exposure; this helps protect the project's
+users, and provides them with a chance to upgrade and/or update in order to
+protect their applications.
+
+
+## Policy
+
+If we verify a reported security vulnerability, our policy is:
+
+- We will patch the current release branch, as well as the immediate prior minor
+  release branch.
+
+- After patching the release branches, we will immediately issue new security
+  fix releases for each patched release branch.

.github/workflows/unit-test.yml

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

README.md

@@ -0,0 +1 @@
+../../README.md

SECURITY.md

@@ -0,0 +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