Merge pull request #41 from dotkernel/issue-40

Issue 40

.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

@@ -15,28 +15,30 @@ DotKernel log component extending and customizing
 
 [![SymfonyInsight](https://insight.symfony.com/projects/287e81e8-b4fb-4452-bd8f-4f12c0ab1f76/big.svg)](https://insight.symfony.com/projects/287e81e8-b4fb-4452-bd8f-4f12c0ab1f76)
 
-
 ## Adding The Config Provider
+
 * Enter config/config.php
 * If there is no entry for the config provider below, add it:
 `\Dot\Log\ConfigProvider::class`
 * Make sure it is added before with the Application-Specific components, eg.: \Frontend\App\ConfigProvider.php, `\Admin\App\ConfigProvider::class`, `MyProject\ConfigProvider::class` , etc.
 * Open the `Dot\Log\ConfigProvider`
 * In the dependencies section you will see an absctract factory (LoggerAbstractServiceFactory::class)
 * This class responds to "selectors" instead of class names
-  - Instead of requesting the `Laminas\Log\Logger::class`from the container, dot-log.my_logger should be requested (or just `my_logger` if using laminas-log)
+  Instead of requesting the `Laminas\Log\Logger::class`from the container, dot-log.my_logger should be requested (or just `my_logger` if using laminas-log)
 
 ## Configuring the writer(s)
+
 Loggers must have at least one writer.
 
 A writer is an object that inherits from `Laminas\Log\Writer\AbstractWriter`. A writer's responsibility is to record log data to a storage backend. (from laminas-log's writer documentation)
 
-
 ### Writing to a file (stream)
+
 It is possible separate logs into multiple files using writers and filters.
 For example *warnings.log*, *errors.log*, *all_messages.log*.
 
 The following is the simplest example to write all log messages to `/log/dk.log`
+
 ```php
 return [
     'dot_log' => [
@@ -56,10 +58,10 @@ return [
     ],
 ];
 ```
+
 * The `FileWriter` key is optional, otherwise the writers array would be enumerative instead of associative.
 * The writer name key is a developer-provided name for that writer, the writer name key is **mandatory**.
 
-
 The writer priority key is not affecting the errors that are written, it is a way to organize writers, for example:
 
 1 - FILE
@@ -71,17 +73,17 @@ The writer priority key is optional.
 
 To write into a file the key stream must be present in the writer options array. This is required only if writing into streams/files.
 
-
 ## Grouping log files by date
+
 By default, logs will be written to the same file: `log/dk.log`.
 Optionally, you can use date format specifiers wrapped between curly braces in your FileWriter's `stream` option, automatically grouping your logs by day, week, month, year etc.
 Examples:
+
 * `log/dk-{Y}-{m}-{d}.log` will write every day to a different file (eg: log/dk-2021-01-01.log)
 * `log/dk-{Y}-{W}.log` will write every week to a different file (eg: log/dk-2021-10.log)
 
 The full list of format specifiers is available [here](https://www.php.net/manual/en/datetime.format.php).
 
-
 ## Filtering log messages
 
 As per PSR-3 document.
@@ -90,8 +92,8 @@ The log levels are: emergency (0), alert (1), critical (2), error (3), warn (4),
 
 Although the plain Logger in Laminas Log is not fully compatible with PSR-3, it provides a way to log all of these message types.
 
-
 The following example has three file writers using filters:
+
 * First Example: `FileWriter` - All messages are logged in `/log/dk.log`
 * Second Example: `OnlyWarningsWriter` - Only warnings are logged in `/log/warnings.log`
 * Third Example: `WarningOrHigherWriter` - All important messages (`warnings` or more critical) are logged in `/log/important_messages.log`
@@ -171,8 +173,6 @@ The filter added on the first writer is equal to not setting a filter, but it wa
 
 It was added opposite to the others just to demonstrate the other operator is also an option.
 
-
-
 More examples on filters: https://docs.laminas.dev/laminas-log/filters/
 
 ## Formatting Messages
@@ -183,21 +183,17 @@ For a better readability, these arrays can be serialized.
 
 Laminas Log provides String formatting, XML, JSON and FirePHP formatting.
 
-
-
 The formatter accepts following parameters:
 
 name - the formatter class (it must implement Laminas\Log\Formatter\FormatterInterface)
 options - options to pass to the formatter constructor if required
 
-
 The following formats the message as JSON data:
 
 'formatter' => [
     'name' => \Laminas\Log\Formatter\Json::class,
 ],
 
-
 ### Example with formatter
 
 * The log is used through dot-log
@@ -243,13 +239,17 @@ return [
 ```
 
 ## Usage
+
 Basic usage of the logger is illustraded below.
 
 The messages are written to see which logs are written and which are not written.
+
 ```php
 use Laminas\Log\Logger;
 ```
+
 ...
+
 ```php
 $logger = $container->get('dot-log.my_logger');
 
@@ -266,9 +266,9 @@ $logger->log(Logger::NOTICE, 'NOTICE from log()');
 ```
 
 Sources:
+
 * https://docs.laminas.dev/laminas-log/
 * https://docs.laminas.dev/laminas-log/writers/
 * https://docs.laminas.dev/laminas-log/filters/
 
 Extracted from [this article](https://www.dotkernel.com/dotkernel/logging-with-dot-log-in-mezzio-and-dotkernel)
-

SECURITY.md

@@ -0,0 +1,40 @@
+# 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-log/3.4.7) |
+| <= 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.
+

composer.json

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

docs/book/v3/adding-config-provider.md

@@ -0,0 +1,10 @@
+# Adding The Config Provider
+
+* Enter config/config.php
+* If there is no entry for the config provider below, add it:
+  `\Dot\Log\ConfigProvider::class`
+* Make sure it is added before with the Application-Specific components, eg.: \Frontend\App\ConfigProvider.php, `\Admin\App\ConfigProvider::class`, `MyProject\ConfigProvider::class` , etc.
+* Open the `Dot\Log\ConfigProvider`
+* In the dependencies section you will see an absctract factory (LoggerAbstractServiceFactory::class)
+* This class responds to "selectors" instead of class names
+  Instead of requesting the `Laminas\Log\Logger::class`from the container, dot-log.my_logger should be requested (or just `my_logger` if using laminas-log)