-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
@@ -141,7 +134,7 @@ public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\B
```php
diff --git a/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md b/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md
new file mode 100644
index 00000000..300a593b
--- /dev/null
+++ b/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md
@@ -0,0 +1,160 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Plugin\Event\Renderer;
+
+final class OnCreateDocumentedEntityWrapper extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+```
+
+
The event occurs when an entity is added to the list for documentation
+
+
+
+
+
+
+
Initialization methods:
+
+
+-
+ __construct
+
+
+
+
Methods:
+
+
+-
+ getDocumentedEntityWrapper
+
+-
+ isPropagationStopped
+ - Is propagation stopped?
+-
+ stopPropagation
+ - Stops the propagation of the event to further event listeners.
+
+
+
+
+
+
+
+
+
Method details:
+
+
+
+
+
+```php
+public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $documentedEntityWrapper);
+```
+
+
+
+
Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function isPropagationStopped(): bool;
+```
+
+
Is propagation stopped?
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function stopPropagation(): void;
+```
+
+
Stops the propagation of the event to further event listeners.
+
+
Parameters: not specified
+
+
Return value: void
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md b/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md
new file mode 100644
index 00000000..889c3574
--- /dev/null
+++ b/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Plugin\Event\Renderer;
+
+final class OnGetProjectTemplatesDirs extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+```
+
+
This event occurs when all directories containing document templates are retrieved
+
+
+
+
+
+
+
Initialization methods:
+
+
+-
+ __construct
+
+
+
+
Methods:
+
+
+-
+ addTemplatesDir
+
+-
+ getTemplatesDirs
+
+-
+ isPropagationStopped
+ - Is propagation stopped?
+-
+ stopPropagation
+ - Stops the propagation of the event to further event listeners.
+
+
+
+
+
+
+
+
+
Method details:
+
+
+
+
+
+```php
+public function __construct(array $templatesDirs);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $templatesDirs |
+ array |
+ - |
+
+
+
+
+
+
+
+
+
+
+
+
+```php
+public function addTemplatesDir(string $dirName): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $dirName |
+ string |
+ - |
+
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+
+```php
+public function getTemplatesDirs(): array;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function isPropagationStopped(): bool;
+```
+
+
Is propagation stopped?
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function stopPropagation(): void;
+```
+
+
Stops the propagation of the event to further event listeners.
+
+
Parameters: not specified
+
+
Return value: void
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md b/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md
new file mode 100644
index 00000000..ec4c765d
--- /dev/null
+++ b/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md
@@ -0,0 +1,225 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Plugin\Event\Renderer;
+
+final class OnGetTemplatePathByRelativeDocPath extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+```
+
+
The event occurs when the path to the template file is obtained relative to the path to the document
+
+
+
+
+
+
+
Initialization methods:
+
+
+-
+ __construct
+
+
+
+
Methods:
+
+
+-
+ getCustomTemplateFilePath
+
+-
+ getTemplateName
+
+-
+ isPropagationStopped
+ - Is propagation stopped?
+-
+ setCustomTemplateFilePath
+
+-
+ stopPropagation
+ - Stops the propagation of the event to further event listeners.
+
+
+
+
+
+
+
+
+
Method details:
+
+
+
+
+
+```php
+public function __construct(string $templateName);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $templateName |
+ string |
+ - |
+
+
+
+
+
+
+
+
+
+
+
+
+```php
+public function getCustomTemplateFilePath(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+
+```php
+public function getTemplateName(): string;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function isPropagationStopped(): bool;
+```
+
+
Is propagation stopped?
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+
+```php
+public function setCustomTemplateFilePath(string|null $customTemplateFilePath): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $customTemplateFilePath |
+ string | null |
+ - |
+
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function stopPropagation(): void;
+```
+
+
Stops the propagation of the event to further event listeners.
+
+
Parameters: not specified
+
+
Return value: void
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md b/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md
index ed006392..c8ede590 100644
--- a/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md
+++ b/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md
@@ -2,7 +2,7 @@
@@ -15,7 +15,7 @@ namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
```
-
Event is the base class for classes containing event data.
+
Event occurs when a reference to an entity (resource) is received
@@ -63,7 +63,7 @@ final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Eve
```php
@@ -100,7 +100,7 @@ public function __construct(string $resourceName);
```php
@@ -121,7 +121,7 @@ public function getResourceName(): string;
```php
@@ -165,7 +165,7 @@ public function isPropagationStopped(): bool;
```php
diff --git a/docs/tech/4.pluginSystem/readme.md b/docs/tech/4.pluginSystem/readme.md
index 594b5440..5bc1a94e 100644
--- a/docs/tech/4.pluginSystem/readme.md
+++ b/docs/tech/4.pluginSystem/readme.md
@@ -149,11 +149,25 @@ Plugins for any programming languages work regardless of which language handler
Adding links to the documentation of PHP classes in the \Twig namespace |
+
+ | EntityDocUnifiedPlacePlugin |
+ PHP |
+
+
+ |
+ This plugin changes the algorithm for saving entity documents. The standard system stores each file
+in a directory next to the file where it was requested. This behavior changes and all documents are saved
+in a separate directory structure, so they are not duplicated. |
+
-
+
@@ -192,4 +206,4 @@ plugins:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Oct 15 2023
Made with
Bumble Documentation Generator
-
- \Twig\Error\SyntaxError
+ \Twig\Error\RuntimeError
-
- \Twig\Error\RuntimeError
+ \DI\DependencyException
-
\Twig\Error\LoaderError
+-
+ \Twig\Error\SyntaxError
+
+-
+ \DI\NotFoundException
+
-
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
@@ -180,7 +186,7 @@ public function __invoke(string $currentPageTitle, string $templatePath, bool $s
```php
@@ -201,7 +207,7 @@ public static function getName(): string;
```php
diff --git a/docs/tech/classes/LastPageCommitter.md b/docs/tech/classes/LastPageCommitter.md
index be1a695b..616a0ad5 100644
--- a/docs/tech/classes/LastPageCommitter.md
+++ b/docs/tech/classes/LastPageCommitter.md
@@ -2,7 +2,7 @@
@@ -54,7 +54,7 @@ final class LastPageCommitter implements \BumbleDocGen\Core\Plugin\PluginInterfa
```php
@@ -96,7 +96,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
```php
@@ -127,13 +127,6 @@ public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\B
Return value: void
-Throws:
-
-
@@ -141,7 +134,7 @@ public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\B
```php
diff --git a/docs/tech/classes/LocatedNotInCondition.md b/docs/tech/classes/LocatedNotInCondition.md
new file mode 100644
index 00000000..f8530f07
--- /dev/null
+++ b/docs/tech/classes/LocatedNotInCondition.md
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Parser\FilterCondition\CommonFilterCondition;
+
+final class LocatedNotInCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
+```
+
+
Checking the existence of an entity not in the specified directories
+
+
+
+
+
+
+
Initialization methods:
+
+
+-
+ __construct
+
+
+
+
Methods:
+
+
+-
+ canAddToCollection
+
+
+
+
+
+
+
+
+
+
Method details:
+
+
+
+
+
+```php
+public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = [ ]);
+```
+
+
+
+
Parameters:
+
+
+
+
+
+
+
+
+
+
+
+```php
+public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: bool
+
+
+
Throws:
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/MainTwigEnvironment.md b/docs/tech/classes/MainTwigEnvironment.md
index 1d23e8cb..e358eaee 100644
--- a/docs/tech/classes/MainTwigEnvironment.md
+++ b/docs/tech/classes/MainTwigEnvironment.md
@@ -2,7 +2,7 @@
@@ -55,7 +55,7 @@ final class MainTwigEnvironment
```php
-public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Twig\MainExtension $mainExtension);
+public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Twig\MainExtension $mainExtension, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
@@ -80,19 +80,17 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
$mainExtension |
\BumbleDocGen\Core\Renderer\Twig\MainExtension |
- |
+
+
+ | $pluginEventDispatcher |
+ \BumbleDocGen\Core\Plugin\PluginEventDispatcher |
+ - |
-
Throws:
-
-
diff --git a/docs/tech/classes/OnCreateDocumentedEntityWrapper.md b/docs/tech/classes/OnCreateDocumentedEntityWrapper.md
new file mode 100644
index 00000000..7490327c
--- /dev/null
+++ b/docs/tech/classes/OnCreateDocumentedEntityWrapper.md
@@ -0,0 +1,160 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Plugin\Event\Renderer;
+
+final class OnCreateDocumentedEntityWrapper extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+```
+
+The event occurs when an entity is added to the list for documentation
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ getDocumentedEntityWrapper
+
+-
+ isPropagationStopped
+ - Is propagation stopped?
+-
+ stopPropagation
+ - Stops the propagation of the event to further event listeners.
+
+
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $documentedEntityWrapper);
+```
+
+
+
+
Parameters:
+
+
+
+
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function isPropagationStopped(): bool;
+```
+
+
Is propagation stopped?
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function stopPropagation(): void;
+```
+
+
Stops the propagation of the event to further event listeners.
+
+
Parameters: not specified
+
+
Return value: void
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/OnGetProjectTemplatesDirs.md b/docs/tech/classes/OnGetProjectTemplatesDirs.md
new file mode 100644
index 00000000..dc32725c
--- /dev/null
+++ b/docs/tech/classes/OnGetProjectTemplatesDirs.md
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Plugin\Event\Renderer;
+
+final class OnGetProjectTemplatesDirs extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+```
+
+This event occurs when all directories containing document templates are retrieved
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ addTemplatesDir
+
+-
+ getTemplatesDirs
+
+-
+ isPropagationStopped
+ - Is propagation stopped?
+-
+ stopPropagation
+ - Stops the propagation of the event to further event listeners.
+
+
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+public function __construct(array $templatesDirs);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $templatesDirs |
+ array |
+ - |
+
+
+
+
+
+
+
+
+
+
+
+```php
+public function addTemplatesDir(string $dirName): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $dirName |
+ string |
+ - |
+
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+```php
+public function getTemplatesDirs(): array;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function isPropagationStopped(): bool;
+```
+
+
Is propagation stopped?
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function stopPropagation(): void;
+```
+
+
Stops the propagation of the event to further event listeners.
+
+
Parameters: not specified
+
+
Return value: void
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md b/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md
new file mode 100644
index 00000000..482c6d64
--- /dev/null
+++ b/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md
@@ -0,0 +1,225 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Plugin\Event\Renderer;
+
+final class OnGetTemplatePathByRelativeDocPath extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+```
+
+The event occurs when the path to the template file is obtained relative to the path to the document
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ getCustomTemplateFilePath
+
+-
+ getTemplateName
+
+-
+ isPropagationStopped
+ - Is propagation stopped?
+-
+ setCustomTemplateFilePath
+
+-
+ stopPropagation
+ - Stops the propagation of the event to further event listeners.
+
+
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+public function __construct(string $templateName);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $templateName |
+ string |
+ - |
+
+
+
+
+
+
+
+
+
+
+
+```php
+public function getCustomTemplateFilePath(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+public function getTemplateName(): string;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function isPropagationStopped(): bool;
+```
+
+
Is propagation stopped?
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+public function setCustomTemplateFilePath(string|null $customTemplateFilePath): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $customTemplateFilePath |
+ string | null |
+ - |
+
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Contracts\EventDispatcher\Event
+
+public function stopPropagation(): void;
+```
+
+
Stops the propagation of the event to further event listeners.
+
+
Parameters: not specified
+
+
Return value: void
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/OnGettingResourceLink.md b/docs/tech/classes/OnGettingResourceLink.md
index e8c8d7e3..2b6178f0 100644
--- a/docs/tech/classes/OnGettingResourceLink.md
+++ b/docs/tech/classes/OnGettingResourceLink.md
@@ -2,7 +2,7 @@
@@ -15,7 +15,7 @@ namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
```
-Event is the base class for classes containing event data.
+Event occurs when a reference to an entity (resource) is received
@@ -63,7 +63,7 @@ final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Eve
```php
@@ -100,7 +100,7 @@ public function __construct(string $resourceName);
```php
@@ -121,7 +121,7 @@ public function getResourceName(): string;
```php
@@ -165,7 +165,7 @@ public function isPropagationStopped(): bool;
```php
diff --git a/docs/tech/classes/Renderer.md b/docs/tech/classes/Renderer.md
index 2c62f449..093db9ac 100644
--- a/docs/tech/classes/Renderer.md
+++ b/docs/tech/classes/Renderer.md
@@ -2,7 +2,7 @@
@@ -59,7 +59,7 @@ See:
```php
@@ -136,7 +136,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
```php
diff --git a/docs/tech/classes/RendererIteratorFactory.md b/docs/tech/classes/RendererIteratorFactory.md
index 5ca58c0c..31821e94 100644
--- a/docs/tech/classes/RendererIteratorFactory.md
+++ b/docs/tech/classes/RendererIteratorFactory.md
@@ -2,7 +2,7 @@
@@ -57,11 +57,11 @@ final class RendererIteratorFactory
```php
-public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $configurationParameterBag, \BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache $sharedCompressedDocumentFileCache, \BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Monolog\Logger $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $configurationParameterBag, \BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache $sharedCompressedDocumentFileCache, \BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \Symfony\Component\Console\Style\OutputStyle $io, \Monolog\Logger $logger);
```
@@ -126,6 +126,11 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
$progressBarFactory |
\BumbleDocGen\Console\ProgressBar\ProgressBarFactory |
- |
+
+
+ | $pluginEventDispatcher |
+ \BumbleDocGen\Core\Plugin\PluginEventDispatcher |
+ - |
| $io |
@@ -149,7 +154,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
```php
@@ -177,7 +182,7 @@ public function getDocumentedEntityWrappersWithOutdatedCache(): \Generator;
```php
@@ -205,7 +210,7 @@ public function getFilesToRemove(): \Generator;
```php
diff --git a/docs/tech/classes/TemplateFile.md b/docs/tech/classes/TemplateFile.md
new file mode 100644
index 00000000..37062ca4
--- /dev/null
+++ b/docs/tech/classes/TemplateFile.md
@@ -0,0 +1,359 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Core\Renderer;
+
+final class TemplateFile
+```
+
+
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+-
+ create
+
+
+
+Methods:
+
+
+-
+ getRealPath
+
+-
+ getRelativeDocPath
+
+-
+ getRelativeDocPathByTemplatePath
+
+-
+ getRelativeTemplatePath
+
+-
+ getTemplatePathByRelativeDocPath
+
+-
+ isTemplate
+
+
+
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+public function __construct(string $realPath, string $relativeDocPath);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $realPath |
+ string |
+ - |
+
+
+ | $relativeDocPath |
+ string |
+ - |
+
+
+
+
+
+
+
+
+
+
+
+```php
+public static function create(\Symfony\Component\Finder\SplFileInfo $fileInfo, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher): self;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: self
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+public function getRealPath(): string;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+public function getRelativeDocPath(): string;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+public static function getRelativeDocPathByTemplatePath(string $templatePath, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher): string;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: string
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+public function getRelativeTemplatePath(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+public static function getTemplatePathByRelativeDocPath(string $relativeDocPath, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher): string;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: string
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+public function isTemplate(): bool;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/map.md b/docs/tech/map.md
index b1fef760..a064a2e9 100644
--- a/docs/tech/map.md
+++ b/docs/tech/map.md
@@ -67,6 +67,7 @@ Directory layout ( only documented files shown ):
│ │ │ │ │ ├── FalseCondition.php — False conditions, any object is not available
│ │ │ │ │ ├── FileTextContainsCondition.php — Checking if a file contains a substring
│ │ │ │ │ ├── LocatedInCondition.php — Checking the existence of an entity in the specified directories
+│ │ │ │ │ ├── LocatedNotInCondition.php — Checking the existence of an entity not in the specified directories
│ │ │ │ │ └── TrueCondition.php — True conditions, any object is available
│ │ │ │ ├── ConditionGroup.php — Filter condition to group other filter conditions. A group can have an OR/AND condition test; In ...
│ │ │ │ ├── ConditionGroupTypeEnum.php
@@ -92,8 +93,14 @@ Directory layout ( only documented files shown ):
│ │ │ │ ├──Parser/
│ │ │ │ │ └── OnLoadSourceLocatorsCollection.php — Called when source locators are loaded
│ │ │ │ └──Renderer/
+│ │ │ │ │ ├── AfterRenderingEntities.php — Event is the base class for classes containing event data.
│ │ │ │ │ ├── BeforeCreatingDocFile.php — Called before the content of the documentation document is saved to a file
-│ │ │ │ │ ├── OnGettingResourceLink.php — Event is the base class for classes containing event data.
+│ │ │ │ │ ├── BeforeRenderingDocFiles.php — The event occurs before the main documents begin rendering
+│ │ │ │ │ ├── BeforeRenderingEntities.php — The event occurs before the rendering of entity documents begins, after the main documents have b...
+│ │ │ │ │ ├── OnCreateDocumentedEntityWrapper.php — The event occurs when an entity is added to the list for documentation
+│ │ │ │ │ ├── OnGetProjectTemplatesDirs.php — This event occurs when all directories containing document templates are retrieved
+│ │ │ │ │ ├── OnGetTemplatePathByRelativeDocPath.php — The event occurs when the path to the template file is obtained relative to the path to the document
+│ │ │ │ │ ├── OnGettingResourceLink.php — Event occurs when a reference to an entity (resource) is received
│ │ │ │ │ └── OnLoadEntityDocPluginContent.php — Called when entity documentation is generated (plugin content loading)
│ │ │ ├── OnlySingleExecutionEvent.php
│ │ │ ├── PluginEventDispatcher.php — The EventDispatcherInterface is the central point of Symfony's event listener system.
@@ -148,7 +155,8 @@ Directory layout ( only documented files shown ):
│ │ │ │ └── MainTwigEnvironment.php
│ │ │ ├── Renderer.php — Generates and processes files from directory TemplatesDir saving them to directory OutputDir
│ │ │ ├── RendererHelper.php
-│ │ │ └── RendererIteratorFactory.php
+│ │ │ ├── RendererIteratorFactory.php
+│ │ │ └── TemplateFile.php
│ ├──LanguageHandler/
│ │ ├──Php/
│ │ │ ├──Parser/
@@ -199,7 +207,7 @@ Directory layout ( only documented files shown ):
│ │ │ │ └── ParserHelper.php
│ │ │ ├──Plugin/
│ │ │ │ ├──CorePlugin/
-│ │ │ │ │ └──BasePhpStubber/
+│ │ │ │ │ ├──BasePhpStubber/
│ │ │ │ │ │ ├── BasePhpStubberPlugin.php — Adding links to type documentation and documentation of built-in PHP classes
│ │ │ │ │ │ ├── ComposerStubberPlugin.php — Adding links to the documentation of PHP classes in the \Composer namespace
│ │ │ │ │ │ ├── PhpDocumentorStubberPlugin.php — Adding links to the documentation of PHP classes in the \phpDocumentor namespace
@@ -207,6 +215,8 @@ Directory layout ( only documented files shown ):
│ │ │ │ │ │ ├── PsrClassesStubberPlugin.php — Adding links to the documentation of PHP classes in the \Psr namespace
│ │ │ │ │ │ ├── SymfonyComponentStubberPlugin.php — Adding links to the documentation of PHP classes in the \Symfony\Component namespace
│ │ │ │ │ │ └── TwigStubberPlugin.php — Adding links to the documentation of PHP classes in the \Twig namespace
+│ │ │ │ │ └──EntityDocUnifiedPlace/
+│ │ │ │ │ │ └── EntityDocUnifiedPlacePlugin.php — This plugin changes the algorithm for saving entity documents. The standard system stores each fi...
│ │ │ │ └──Event/
│ │ │ │ │ ├──Entity/
│ │ │ │ │ │ └── OnCheckIsClassEntityCanBeLoad.php — Event is the base class for classes containing event data.
@@ -238,4 +248,4 @@ Directory layout ( only documented files shown ):
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Mon Oct 16 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/readme.md b/docs/tech/readme.md
index 28e36af4..f081314e 100644
--- a/docs/tech/readme.md
+++ b/docs/tech/readme.md
@@ -44,4 +44,4 @@ After that, the process of parsing the project code according to the configurati
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Oct 5 17:42:06 2023 +0300
Page content update date: Fri Oct 06 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Oct 5 17:42:06 2023 +0300
Page content update date: Sun Oct 15 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/selfdoc/templates/tech/3.renderer/templates.md.twig b/selfdoc/templates/tech/3.renderer/01_templates.md.twig
similarity index 100%
rename from selfdoc/templates/tech/3.renderer/templates.md.twig
rename to selfdoc/templates/tech/3.renderer/01_templates.md.twig
diff --git a/selfdoc/templates/tech/3.renderer/breadcrumbs.md.twig b/selfdoc/templates/tech/3.renderer/02_breadcrumbs.md.twig
similarity index 100%
rename from selfdoc/templates/tech/3.renderer/breadcrumbs.md.twig
rename to selfdoc/templates/tech/3.renderer/02_breadcrumbs.md.twig
diff --git a/selfdoc/templates/tech/3.renderer/03_documentStructure.md.twig b/selfdoc/templates/tech/3.renderer/03_documentStructure.md.twig
new file mode 100644
index 00000000..e5047268
--- /dev/null
+++ b/selfdoc/templates/tech/3.renderer/03_documentStructure.md.twig
@@ -0,0 +1,19 @@
+{% set title = 'Document structure of generated entities' %}
+{% set prevPage = 'Renderer' %}
+{{ generatePageBreadcrumbs(title, _self) }}
+
+{{ "Document structure of generated entities" | textToHeading('H1') }}
+
+*By default, the documentation generator offers two options for organizing the structure of generated entity documents:*
+
+1) The standard structure is an entity document next to a parent document. If the document template contained
+a link to the entity documentation, during the documentation generation process we created a classes directory
+in the same directory where the parent document was located, and inside this classes directory we created an entity document.
+
+2) All entity documents are located in a separate directory with the structure of the entire documented project. **At the moment this is only available for PHP projects**
+
+To enable the second option, you need to connect the built-in plugin:
+```yaml
+plugins:
+ - class: \BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\EntityDocUnifiedPlace\EntityDocUnifiedPlacePlugin
+```
diff --git a/selfdoc/templates/tech/3.renderer/twigCustomFilters.md.twig b/selfdoc/templates/tech/3.renderer/04_twigCustomFilters.md.twig
similarity index 100%
rename from selfdoc/templates/tech/3.renderer/twigCustomFilters.md.twig
rename to selfdoc/templates/tech/3.renderer/04_twigCustomFilters.md.twig
diff --git a/selfdoc/templates/tech/3.renderer/twigCustomFunctions.md.twig b/selfdoc/templates/tech/3.renderer/05_twigCustomFunctions.md.twig
similarity index 100%
rename from selfdoc/templates/tech/3.renderer/twigCustomFunctions.md.twig
rename to selfdoc/templates/tech/3.renderer/05_twigCustomFunctions.md.twig
diff --git a/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php b/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php
index 568a8d6c..2e019196 100644
--- a/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php
+++ b/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php
@@ -28,6 +28,9 @@ public function __construct(
public function canAddToCollection(EntityInterface $entity): bool
{
$fileName = $entity->getAbsoluteFileName();
+ if (!$fileName) {
+ return false;
+ }
foreach ($this->directories as $directory) {
$directory = $this->parameterBag->resolveValue($directory);
if (!str_starts_with($directory, DIRECTORY_SEPARATOR)) {
diff --git a/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedNotInCondition.php b/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedNotInCondition.php
new file mode 100644
index 00000000..e35f72e0
--- /dev/null
+++ b/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedNotInCondition.php
@@ -0,0 +1,46 @@
+getAbsoluteFileName();
+ if (!$fileName) {
+ return false;
+ }
+ foreach ($this->directories as $directory) {
+ $directory = $this->parameterBag->resolveValue($directory);
+ if (!str_starts_with($directory, DIRECTORY_SEPARATOR)) {
+ $directory = rtrim($this->configuration->getProjectRoot(), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $directory;
+ }
+ $directory = realpath($directory);
+ if (!$directory || str_starts_with($fileName, $directory)) {
+ return false;
+ }
+ }
+ return true;
+ }
+}
diff --git a/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php b/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php
index a39b2ba6..994a192a 100644
--- a/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php
+++ b/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php
@@ -5,7 +5,6 @@
namespace BumbleDocGen\Core\Plugin\CorePlugin\LastPageCommitter;
use BumbleDocGen\Core\Configuration\Configuration;
-use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException;
use BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile;
use BumbleDocGen\Core\Plugin\PluginInterface;
use BumbleDocGen\Core\Renderer\Context\RendererContext;
@@ -28,26 +27,27 @@ public static function getSubscribedEvents(): array
];
}
- /**
- * @throws InvalidConfigurationParameterException
- */
final public function beforeCreatingDocFile(BeforeCreatingDocFile $event): void
{
- $gitClientPath = $this->configuration->getGitClientPath();
- $filePath = str_replace(
- "{$this->configuration->getProjectRoot()}/",
- '',
- "{$this->configuration->getTemplatesDir()}{$this->context->getCurrentTemplateFilePatch()}"
- );
- exec("{$gitClientPath} log --no-merges -1 {$filePath}", $output);
-
- $content = $event->getContent();
- if (isset($output[2]) && str_contains($output[2], 'Date: ')) {
- $author = str_replace('Author:', 'Last page committer:', htmlspecialchars($output[1]));
- $date = str_replace('Date:', 'Last modified date:', $output[2]);
- $contentRegenerationDate = 'Page content update date: ' . date('D M d Y');
- $content .= "\n\n\n
\n{$author}
{$date}
{$contentRegenerationDate}
Made with
Bumble Documentation Generator\n
\n{$author}
{$date}
{$contentRegenerationDate}
Made with
Bumble Documentation Generator