Merge pull request #23 from AtomicXtreme/3.0

alexmerlin · web-flow · commit 2b4b2480d6ae · 2024-05-03T21:47:14.000+03:00
Documentation for Dot-Navigation
diff --git a/.github/workflows/continuous-integration.yml b/.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/continuous-integration.yml@1.x
diff --git a/.github/workflows/cs-tests.yml b/.github/workflows/cs-tests.yml
diff --git a/.github/workflows/docs-build.yml b/.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 }}
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
diff --git a/README.md b/README.md
@@ -13,7 +13,6 @@
 
 [![SymfonyInsight](https://insight.symfony.com/projects/68b7c728-4cc9-40ac-a3be-cf17f9b2eaf1/big.svg)](https://insight.symfony.com/projects/68b7c728-4cc9-40ac-a3be-cf17f9b2eaf1)
 
-
 Allows you to easily define and parse menus inside templates, configuration based approach.
 
 ## Installation
@@ -33,7 +32,6 @@ Register `NavigationMiddleware` in your middleware pipe between the routing and
 
 Locate dot-navigation's distributable config file `vendor/dotkernel/dot-navigation/config/autoload/navigation.global.php.dist` and duplicate it in your project as `config/autoload/navigation.global.php`
 
-
 ## Components
 
 A menu, or navigation container, is a class implementing the \RecursiveIterator interface. It has a hierarchical structure, with nodes called pages(see the `Page` class) that may have children. It is basically a tree
@@ -48,7 +46,6 @@ Attributes are key value pairs that defines the menu item. They are usually inse
 
 A `NavigationService` class, is the service that handles all defined menu container. It can fetch the container from its provider, check if a page is active or not and get the page's generated URI.
 
-
 ## Container providers
 
 Each menu can be created from different sources. The responsibility of creating a menu container from the source falls on a container provider.
@@ -57,7 +54,6 @@ Each provider must implement the interface `ProviderInterface` and be registered
 
 We offer just one provider for now, `ArrayProvider`, that is able to fetch and create a menu container from a php array that is defined in the configuration file.
 
-
 ## NavigationRenderer
 
 Used to render the navigation container in a displayable format. It can render a simple HTML ul list or use a partial template, to render the menu in a template engine.
@@ -66,14 +62,14 @@ The partial method is usually the more flexible one, custom rules can be defined
 
 If you are using twig, there is already a twig extension provided in package dot-twigrenderer, that you can use to easily parse the menus inside your templates
 
-
 When using the partial method, the template will receive as parameters the container, the navigation service and any extra parameters set by the developer.
 
 Navigation containers are referred, when parsed, by their name, as defined in the configuration file.
 
 ## Required page options and attributes
 
 The following are options that each page should define in the configuration
+
 * `label` - the text of the menu item
 * `route` or `uri` - defines the route or link the menu item will have
 * `permission` - can be used optionally, if authorization service is present, in order to omit menu items that are not authorized to visit.
diff --git a/SECURITY.md b/SECURITY.md
@@ -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-navigation/3.4.2)|
+
+
+## Reporting Potential Security Issues
+
+If you have encountered a potential security vulnerability in this project,
+please report it to us at <security@dotkernel.com>. 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.
+
diff --git a/docs/book/index.md b/docs/book/index.md
@@ -0,0 +1 @@
+../../README.md
diff --git a/docs/book/v3/components.md b/docs/book/v3/components.md
@@ -0,0 +1,13 @@
+# Components
+
+A menu, or navigation container, is a class implementing the \RecursiveIterator interface. It has a hierarchical structure, with nodes called pages(see the `Page` class) that may have children. It is basically a tree
+
+A Page extends the NavigationContainer class. The NavigationContainer is the top most node which represents the entire menu. The children of this node are Page instances that defines each navigation item.
+
+A page has a reference to its parent, and can have options and attributes. There are no limitation on what is accepted as options or attributes.
+
+Options can be any piece of information that describes a page. Some predefined options exists, in order for the navigation module to work seamlessly with other dot modules.
+
+Attributes are key value pairs that defines the menu item. They are usually inserted as html attributes when parsing the menu, but of course, this is implementation specific.
+
+A `NavigationService` class, is the service that handles all defined menu container. It can fetch the container from its provider, check if a page is active or not and get the page's generated URI.
diff --git a/docs/book/v3/configuration.md b/docs/book/v3/configuration.md
@@ -0,0 +1,7 @@
+# Configuration
+
+After installation, register `dot-navigation` in your project by adding the below line to your configuration aggregator (usually: `config/config.php`):
+
+     Dot\Navigation\ConfigProvider::class,
+
+Locate dot-navigation's distributable config file `vendor/dotkernel/dot-navigation/config/autoload/navigation.global.php.dist` and duplicate it in your project as `config/autoload/navigation.global.php`
diff --git a/docs/book/v3/container-providers.md b/docs/book/v3/container-providers.md
@@ -0,0 +1,7 @@
+# Container providers
+
+Each menu can be created from different sources. The responsibility of creating a menu container from the source falls on a container provider.
+
+Each provider must implement the interface `ProviderInterface` and be registered in the ProviderPluginManager.
+
+We offer just one provider for now, `ArrayProvider`, that is able to fetch and create a menu container from a php array that is defined in the configuration file.
diff --git a/docs/book/v3/installation.md b/docs/book/v3/installation.md
@@ -0,0 +1,5 @@
+# Installation
+
+Install `dotkernel/dot-navigation` by executing the following Composer command:
+
+    composer require dotkernel/dot-navigation
diff --git a/docs/book/v3/navigation-renderer.md b/docs/book/v3/navigation-renderer.md
@@ -0,0 +1,11 @@
+# NavigationRenderer
+
+Used to render the navigation container in a displayable format. It can render a simple HTML ul list or use a partial template, to render the menu in a template engine.
+
+The partial method is usually the more flexible one, custom rules can be defined and checked in the template.
+
+If you are using twig, there is already a twig extension provided in package dot-twigrenderer, that you can use to easily parse the menus inside your templates
+
+When using the partial method, the template will receive as parameters the container, the navigation service and any extra parameters set by the developer.
+
+Navigation containers are referred, when parsed, by their name, as defined in the configuration file.
diff --git a/docs/book/v3/overview.md b/docs/book/v3/overview.md
@@ -0,0 +1,3 @@
+# Overview
+
+`dot-navigation` is DotKernel's component that allows you to easily define and parse menus inside templates, using a configuration based approach.
diff --git a/docs/book/v3/required-page-options.md b/docs/book/v3/required-page-options.md
@@ -0,0 +1,7 @@
+# Required page options and attributes
+
+The following are options that each page should define in the configuration
+
+* `label` - the text of the menu item
+* `route` or `uri` - defines the route or link the menu item will have
+* `permission` - can be used optionally, if authorization service is present, in order to omit menu items that are not authorized to visit.
diff --git a/docs/book/v3/usage.md b/docs/book/v3/usage.md
@@ -0,0 +1,58 @@
+# Usage
+
+Below is an example with content of `config/autoload/navigation.global.php`.
+
+Here we can change or modify the menu structure that will be rendered in the application we are building.
+
+```php
+<?php
+
+return [
+    'dot_navigation' => [
+        //enable menu item active if any child is active
+        'active_recursion' => true,
+
+        //map a provider name to its config
+        'containers' => [
+            'default' => [
+                'type' => 'ArrayProvider',
+                'options' => [
+                    'items' => [
+                        [
+                            'options' => [
+                                'label' => 'Menu #1',
+                                'route' => [
+                                    'route_name' => 'home',
+                                    'route_params' => [],
+                                    'query_params' => [],
+                                    'fragment_id' => null,
+                                    'options' => [],
+
+                                    //the below parameters are not used in route generation
+                                    //they are used in finding if a page is active by omitting some parameters from the check
+                                    'ignore_params' => []
+                                ],
+                            ],
+                            'attributes' => [
+                                'name' => 'Menu #1',
+                            ]
+                        ],
+                        [
+                            'options' => [
+                                'label' => 'Menu #2',
+                                'route' => ['route_name' => 'home'],
+                            ],
+                            'attributes' => [
+                                'name' => 'Menu #1',
+                            ]
+                        ]
+                    ],
+                ],
+            ],
+        ],
+
+        //register custom providers here
+        'provider_manager' => [],
+    ],
+];
+```
diff --git a/mkdocs.yml b/mkdocs.yml
