Merge pull request #51 from bumble-tech/1.x.x

1.3.0

SECURITY.md

@@ -8,9 +8,10 @@ Security updates will be applied to certain versions of our software. Please ref
 
 | Version | Supported          | Notes                                  |
 |---------|--------------------|----------------------------------------|
-| 1.2.x   | :white_check_mark: | Current version, fully supported.      |
-| 1.1.x   | :x:                | Not supported, please upgrade to 1.2.x |
-| 1.0.x   | :x:                | Not supported, please upgrade to 1.2.x |
+| 1.3.x   | :white_check_mark: | Current version, fully supported.      |
+| 1.2.x   | :x:                | Not supported, please upgrade to 1.3.x |
+| 1.1.x   | :x:                | Not supported, please upgrade to 1.3.x |
+| 1.0.x   | :x:                | Not supported, please upgrade to 1.3.x |
 
 ## Reporting a Vulnerability
 

demo/demo6-unified-document-structure/.gitignore

@@ -0,0 +1,2 @@
+/.bumbleDocGenCache/
+/docs/

demo/demo6-unified-document-structure/demo-config.yaml

@@ -0,0 +1,6 @@
+parent_configuration: '%WORKING_DIR%/bumble_doc_gen.yaml'
+demo_dir: '%WORKING_DIR%/demo/demo6-unified-document-structure' # Here I define a template configuration variable
+output_dir: "%demo_dir%/docs"
+cache_dir: '%demo_dir%/.bumbleDocGenCache'
+plugins: # Connecting this built-in plugin will change the structure of the configured document
+  - class: \BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\EntityDocUnifiedPlace\EntityDocUnifiedPlacePlugin

demo/demo6-unified-document-structure/demoScript.php

@@ -0,0 +1,13 @@
+#!/usr/bin/env php
+<?php
+
+ini_set('memory_limit', '-1');
+
+require_once __DIR__ . '/../../vendor/autoload.php';
+
+try {
+    $docGen = (new \BumbleDocGen\DocGeneratorFactory())->create(__DIR__ . '/demo-config.yaml');
+    $docGen->generate();
+} catch (\Exception | \Psr\Cache\InvalidArgumentException $e) {
+    die($e->getMessage());
+}

docs/README.md

@@ -95,4 +95,4 @@ To update this documentation, run the following command:
 
 <div id='page_committer_info'>
 <hr>
-<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b>   Thu Oct 5 17:42:06 2023 +0300<br><b>Page content update date:</b> Fri Oct 06 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
+<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b>   Thu Oct 5 17:42:06 2023 +0300<br><b>Page content update date:</b> Sun Oct 15 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>

docs/tech/1.configuration/classes/DocumentedEntityWrapper.md

@@ -48,12 +48,15 @@ final class DocumentedEntityWrapper
 <li>
     <a href="#mgetfilename">getFileName</a>
     - <i>The name of the file to be generated</i></li>
-<li>
-    <a href="#mgetinitiatorfilepath">getInitiatorFilePath</a>
-    </li>
 <li>
     <a href="#mgetkey">getKey</a>
     - <i>Get document key</i></li>
+<li>
+    <a href="#mgetparentdocfilepath">getParentDocFilePath</a>
+    </li>
+<li>
+    <a href="#msetparentdocfilepath">setParentDocFilePath</a>
+    </li>
 </ol>
 
 
@@ -73,7 +76,7 @@ final class DocumentedEntityWrapper
 </ul>
 
 ```php
-public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface $documentTransformableEntity, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, string $initiatorFilePath);
+public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface $documentTransformableEntity, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, string $parentDocFilePath);
 ```
 
 
@@ -100,7 +103,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor
             <td>-</td>
         </tr>
             <tr>
-            <td>$initiatorFilePath</td>
+            <td>$parentDocFilePath</td>
             <td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
             <td>The file in which the documentation of the entity was requested</td>
         </tr>
@@ -219,16 +222,16 @@ public function getFileName(): string;
 <div class='method_description-block'>
 
 <ul>
-<li><a name="mgetinitiatorfilepath" href="#mgetinitiatorfilepath">#</a>
- <b>getInitiatorFilePath</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L96">source code</a></li>
+<li><a name="mgetkey" href="#mgetkey">#</a>
+ <b>getKey</b>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L35">source code</a></li>
 </ul>
 
 ```php
-public function getInitiatorFilePath(): string;
+public function getKey(): string;
 ```
 
-
+<blockquote>Get document key</blockquote>
 
 <b>Parameters:</b> not specified
 
@@ -240,22 +243,60 @@ public function getInitiatorFilePath(): string;
 <div class='method_description-block'>
 
 <ul>
-<li><a name="mgetkey" href="#mgetkey">#</a>
- <b>getKey</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L35">source code</a></li>
+<li><a name="mgetparentdocfilepath" href="#mgetparentdocfilepath">#</a>
+ <b>getParentDocFilePath</b>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L96">source code</a></li>
 </ul>
 
 ```php
-public function getKey(): string;
+public function getParentDocFilePath(): string;
 ```
 
-<blockquote>Get document key</blockquote>
+
 
 <b>Parameters:</b> not specified
 
 <b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.string.php'>string</a>
 
 
+</div>
+<hr>
+<div class='method_description-block'>
+
+<ul>
+<li><a name="msetparentdocfilepath" href="#msetparentdocfilepath">#</a>
+ <b>setParentDocFilePath</b>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L101">source code</a></li>
+</ul>
+
+```php
+public function setParentDocFilePath(string $parentDocFilePath): void;
+```
+
+
+
+<b>Parameters:</b>
+
+<table>
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Description</th>
+    </tr>
+    </thead>
+    <tbody>
+            <tr>
+            <td>$parentDocFilePath</td>
+            <td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
+            <td>-</td>
+        </tr>
+        </tbody>
+</table>
+
+<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>
+
+
 </div>
 <hr>
 

docs/tech/1.configuration/classes/DocumentedEntityWrappersCollection.md

@@ -2,7 +2,7 @@
 <embed> <a href="/docs/README.md">BumbleDocGen</a> <b>/</b> <a href="/docs/tech/readme.md">Technical description of the project</a> <b>/</b> <a href="/docs/tech/1.configuration/readme.md">Configuration files</a> <b>/</b> DocumentedEntityWrappersCollection<hr> </embed>
 
 <h1>
-    <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L10">DocumentedEntityWrappersCollection</a> class:
+    <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L12">DocumentedEntityWrappersCollection</a> class:
 </h1>
 
 
@@ -60,11 +60,11 @@ final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \T
 <ul>
 <li><a name="m-construct" href="#m-construct">#</a>
  <b>__construct</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L17">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L19">source code</a></li>
 </ul>
 
 ```php
-public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache);
+public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
 ```
 
 
@@ -89,6 +89,11 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
             <td>$localObjectCache</td>
             <td><a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php'>\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache</a></td>
             <td>-</td>
+        </tr>
+            <tr>
+            <td>$pluginEventDispatcher</td>
+            <td><a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php'>\BumbleDocGen\Core\Plugin\PluginEventDispatcher</a></td>
+            <td>-</td>
         </tr>
         </tbody>
 </table>
@@ -102,7 +107,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
 <ul>
 <li><a name="mcount" href="#mcount">#</a>
  <b>count</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L58">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L63">source code</a></li>
 </ul>
 
 ```php
@@ -129,7 +134,7 @@ public function count(): int;
 <ul>
 <li><a name="mcreateandadddocumentedentitywrapper" href="#mcreateandadddocumentedentitywrapper">#</a>
  <b>createAndAddDocumentedEntityWrapper</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L33">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L36">source code</a></li>
 </ul>
 
 ```php
@@ -167,7 +172,7 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En
 <ul>
 <li><a name="mgetdocumentedentitiesrelations" href="#mgetdocumentedentitiesrelations">#</a>
  <b>getDocumentedEntitiesRelations</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L53">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L58">source code</a></li>
 </ul>
 
 ```php
@@ -188,7 +193,7 @@ public function getDocumentedEntitiesRelations(): array;
 <ul>
 <li><a name="mgetiterator" href="#mgetiterator">#</a>
  <b>getIterator</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L23">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L26">source code</a></li>
 </ul>
 
 ```php

docs/tech/1.configuration/classes/GeneratePageBreadcrumbs.md

@@ -2,7 +2,7 @@
 <embed> <a href="/docs/README.md">BumbleDocGen</a> <b>/</b> <a href="/docs/tech/readme.md">Technical description of the project</a> <b>/</b> <a href="/docs/tech/1.configuration/readme.md">Configuration files</a> <b>/</b> GeneratePageBreadcrumbs<hr> </embed>
 
 <h1>
-    <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L18">GeneratePageBreadcrumbs</a> class:
+    <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L20">GeneratePageBreadcrumbs</a> class:
 </h1>
 
 
@@ -67,7 +67,7 @@ final class GeneratePageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\
 <ul>
 <li><a name="m-construct" href="#m-construct">#</a>
  <b>__construct</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L20">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L22">source code</a></li>
 </ul>
 
 ```php
@@ -114,7 +114,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsH
 <ul>
 <li><a name="m-invoke" href="#m-invoke">#</a>
  <b>__invoke</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L53">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L57">source code</a></li>
 </ul>
 
 ```php
@@ -160,14 +160,20 @@ public function __invoke(string $currentPageTitle, string $templatePath, bool $s
 <b>Throws:</b>
 <ul>
 <li>
-    <a href="https://github.com/twigphp/Twig/blob/master/src/Error/SyntaxError.php">\Twig\Error\SyntaxError</a></li>
+    <a href="https://github.com/twigphp/Twig/blob/master/src/Error/RuntimeError.php">\Twig\Error\RuntimeError</a></li>
 
 <li>
-    <a href="https://github.com/twigphp/Twig/blob/master/src/Error/RuntimeError.php">\Twig\Error\RuntimeError</a></li>
+    <a >\DI\DependencyException</a></li>
 
 <li>
     <a href="https://github.com/twigphp/Twig/blob/master/src/Error/LoaderError.php">\Twig\Error\LoaderError</a></li>
 
+<li>
+    <a href="https://github.com/twigphp/Twig/blob/master/src/Error/SyntaxError.php">\Twig\Error\SyntaxError</a></li>
+
+<li>
+    <a >\DI\NotFoundException</a></li>
+
 <li>
     <a href="/docs/tech/1.configuration/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
 
@@ -180,7 +186,7 @@ public function __invoke(string $currentPageTitle, string $templatePath, bool $s
 <ul>
 <li><a name="mgetname" href="#mgetname">#</a>
  <b>getName</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L27">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L29">source code</a></li>
 </ul>
 
 ```php
@@ -201,7 +207,7 @@ public static function getName(): string;
 <ul>
 <li><a name="mgetoptions" href="#mgetoptions">#</a>
  <b>getOptions</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L32">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php#L34">source code</a></li>
 </ul>
 
 ```php

docs/tech/1.configuration/classes/LastPageCommitter.md

@@ -2,7 +2,7 @@
 <embed> <a href="/docs/README.md">BumbleDocGen</a> <b>/</b> <a href="/docs/tech/readme.md">Technical description of the project</a> <b>/</b> <a href="/docs/tech/1.configuration/readme.md">Configuration files</a> <b>/</b> LastPageCommitter<hr> </embed>
 
 <h1>
-    <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L16">LastPageCommitter</a> class:
+    <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L15">LastPageCommitter</a> class:
 </h1>
 
 
@@ -54,7 +54,7 @@ final class LastPageCommitter implements \BumbleDocGen\Core\Plugin\PluginInterfa
 <ul>
 <li><a name="m-construct" href="#m-construct">#</a>
  <b>__construct</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L18">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L17">source code</a></li>
 </ul>
 
 ```php
@@ -96,7 +96,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
 <ul>
 <li><a name="mbeforecreatingdocfile" href="#mbeforecreatingdocfile">#</a>
  <b>beforeCreatingDocFile</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L34">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L30">source code</a></li>
 </ul>
 
 ```php
@@ -127,21 +127,14 @@ public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\B
 <b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>
 
 
-<b>Throws:</b>
-<ul>
-<li>
-    <a href="/docs/tech/1.configuration/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
-
-</ul>
-
 </div>
 <hr>
 <div class='method_description-block'>
 
 <ul>
 <li><a name="mgetsubscribedevents" href="#mgetsubscribedevents">#</a>
  <b>getSubscribedEvents</b>
-    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L24">source code</a></li>
+    <b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L23">source code</a></li>
 </ul>
 
 ```php

docs/tech/1.configuration/readme.md

@@ -222,4 +222,4 @@ The inheritance algorithm is as follows: scalar types can be overwritten by each
 
 <div id='page_committer_info'>
 <hr>
-<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b>   Thu Oct 5 17:42:06 2023 +0300<br><b>Page content update date:</b> Fri Oct 06 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
+<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b>   Thu Oct 5 17:42:06 2023 +0300<br><b>Page content update date:</b> Sun Oct 15 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>