updated docs, workflow

.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/docs-build.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 }}

README.md

@@ -13,7 +13,6 @@
 
 [![SymfonyInsight](https://insight.symfony.com/projects/f6038340-d76b-4da8-9016-0472d4899f0a/big.svg)](https://insight.symfony.com/projects/f6038340-d76b-4da8-9016-0472d4899f0a)
 
-
 DotKernel session component extending and customizing [laminas-session](https://github.com/laminas/laminas-session)
 
 ## Installation
@@ -22,22 +21,22 @@ Run the following command in your project folder
 
     composer require dotkernel/dot-session
 
-
 ## Configuration
+
 Register `SessionMiddleware` in your application's pipeline by adding the following line to `config/pipeline.php`:
 
     $app->pipe(Dot\Session\SessionMiddleware::class);
 
-
 Register `dot-session`'s ConfigProvider in your application's configurations by adding the following line to `config/config.php`:
 
     \Dot\Session\ConfigProvider::class,
 
-
 ## Usage
+
 Basic usage to access and use the session object in your services:
 
 ### Method #1 - Factory
+
 #### Step 1: Create a factory that retrieves the SessionManger from the container
 
 ```php
@@ -69,11 +68,12 @@ class ExampleService
         $this->session = $session;
     }
 
-     //you methods
+     //your methods
 }
 ```
 
-### Method 2 - Injection
+### Method #2 - Injection
+
 If you use annotated injection you can inject the Session Manager in your services.
 
 ```php

SECURITY.md

@@ -0,0 +1,36 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          | PHP Version                                                                                                 |
+|---------|--------------------|-------------------------------------------------------------------------------------------------------------|
+| 5.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-session/5.4.2) |
+| <= 4.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.

composer.json

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

docs/book/index.md

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

docs/book/v5/configuration.md

@@ -0,0 +1,8 @@
+# Configuration
+Register `SessionMiddleware` in your application's pipeline by adding the following line to `config/pipeline.php`:
+
+    $app->pipe(Dot\Session\SessionMiddleware::class);
+
+Register `dot-session`'s ConfigProvider in your application's configurations by adding the following line to `config/config.php`:
+
+    \Dot\Session\ConfigProvider::class,

docs/book/v5/installation.md

@@ -0,0 +1,5 @@
+# Installation
+
+Run the following command in your project folder
+
+    composer require dotkernel/dot-session

docs/book/v5/usage.md

@@ -0,0 +1,6 @@
+# Usage
+
+Basic usage to access and use the session object in your services:
+
+* [Method #1 - Factory](usage/factory.md)
+* [Method #2 - Injection](usage/injection.md)

docs/book/v5/usage/factory.md

@@ -0,0 +1,36 @@
+# Method #1 - Factory
+
+## Step 1: Create a factory that retrieves the SessionManger from the container
+
+```php
+class ExampleFactory
+{
+    // code
+
+    public function __invoke(ContainerInterface $container)
+    {
+        return new ExampleService(
+            $container->get(SessionManager::class)
+        )
+    }
+}
+```
+
+Register the factory in any mode you register factories on your project.
+
+## Step 2: Access through your Service
+
+```php
+
+class ExampleService
+{
+    private SessionManager $session;
+
+    public function __construct(SessionManager $session) 
+    {
+        $this->session = $session;
+    }
+
+     //your methods
+}
+```

docs/book/v5/usage/injection.md

@@ -0,0 +1,23 @@
+# Method #2 - Injection
+
+If you use annotated injection you can inject the Session Manager in your services.
+
+```php
+use Dot\AnnotatedServices\Annotation\Inject;
+use Laminas\Session\SessionManager;
+
+class ExampleService
+{
+    private SessionManager $session;
+
+     /**
+     * @Inject({SessionManager::class})
+     */
+    public function __construct(SessionManager $session) 
+    {
+        $this->session = $session;
+    }
+
+     //your methods
+}
+```

mkdocs.yml

@@ -0,0 +1,21 @@
+docs_dir: docs/book
+site_dir: docs/html
+extra:
+  project: Packages
+  current_version: v5
+  versions:
+    - v5
+nav:
+  - Home: index.md
+  - v5:
+      - Overview: v5/installation.md
+      - Installation: v5/configuration.md
+      - Usage: v5/usage.md
+      - Reference:
+          - "Inject class dependencies": v5/usage/factory.md
+          - "Inject entity repositories": v5/usage/injection.md
+site_name: dot-session
+site_description: "DotKernel's session component"
+repo_url: "https://github.com/dotkernel/dot-session"
+plugins:
+  - search