-# Getting detailed information about a command
-./vendor/bin/bumbleDocGen generate -h
-```
+ # Getting detailed information about a command
+ ./vendor/bin/bumbleDocGen generate -h
+ ```
------------------
@@ -89,11 +85,10 @@ $docgen->generate();
To update this documentation, run the following command:
```console
- ./bin/bumbleDocGen generate
+./bin/bumbleDocGen generate
```
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Dec 23 23:00:37 2023 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Thu Jan 18 14:38:29 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/classes/DocGenerator.md b/docs/classes/DocGenerator.md
index fed1ae00..91dac04e 100644
--- a/docs/classes/DocGenerator.md
+++ b/docs/classes/DocGenerator.md
@@ -1,577 +1,173 @@
-
-
-
-
+[BumbleDocGen](../README.md) **/**
+DocGenerator
+---
+# [DocGenerator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L46) class:
```php
namespace BumbleDocGen;
final class DocGenerator
```
+Class for generating documentation.
-Class for generating documentation.
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addDocBlocks
- - Generate missing docBlocks with LLM for project class methods that are available for documentation
--
- addPlugin
-
--
- generate
- - Generates documentation using configuration
--
- generateReadmeTemplate
- - Creates a `README.md` template filled with basic information using LLM
--
- getConfiguration
-
--
- getConfigurationKey
-
--
- getConfigurationKeys
-
--
- parseAndGetRootEntityCollectionsGroup
-
--
- serve
- - Serve documentation
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
-Constants:
-
+1. [addDocBlocks](#madddocblocks) - Generate missing docBlocks with LLM for project class methods that are available for documentation
+1. [addPlugin](#maddplugin)
+1. [generate](#mgenerate) - Generates documentation using configuration
+1. [generateReadmeTemplate](#mgeneratereadmetemplate) - Creates a `README.md` template filled with basic information using LLM
+1. [getConfiguration](#mgetconfiguration)
+1. [getConfigurationKey](#mgetconfigurationkey)
+1. [getConfigurationKeys](#mgetconfigurationkeys)
+1. [parseAndGetRootEntityCollectionsGroup](#mparseandgetrootentitycollectionsgroup)
+1. [serve](#mserve) - Serve documentation
+## Methods details:
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L56)
```php
public function __construct(\Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler $generationErrorsHandler, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \DI\Container $diContainer, \BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache $sharedCompressedDocumentFileCache, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Monolog\Logger $logger);
```
-
-
-
Parameters:
-
-
-
-
-
-
Throws:
-
-
-
-
-
-
-
-
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$io | [\Symfony\Component\Console\Style\OutputStyle](https://github.com/symfony/console/blob/master/Style/OutputStyle.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$parser | [\BumbleDocGen\Core\Parser\ProjectParser](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$renderer | [\BumbleDocGen\Core\Renderer\Renderer](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Renderer.php) | - |
+$generationErrorsHandler | [\BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Logger/Handler/GenerationErrorsHandler.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$progressBarFactory | [\BumbleDocGen\Console\ProgressBar\ProgressBarFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/ProgressBar/ProgressBarFactory.php) | - |
+$diContainer | [\DI\Container](https://github.com/PHP-DI/PHP-DI/blob/master/src/Container.php) | - |
+$sharedCompressedDocumentFileCache | [\BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/SharedCompressedDocumentFileCache.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
+
+---
+
+
# `addDocBlocks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L116)
```php
public function addDocBlocks(\BumbleDocGen\AI\ProviderInterface $aiProvider): void;
```
+Generate missing docBlocks with LLM for project class methods that are available for documentation
-
Generate missing docBlocks with LLM for project class methods that are available for documentation
-
-
Parameters:
+***Parameters:***
-
+| Name | Type | Description |
+|:-|:-|:-|
+$aiProvider | [\BumbleDocGen\AI\ProviderInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/AI/ProviderInterface.php) | - |
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `addPlugin` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L85)
```php
public function addPlugin(\BumbleDocGen\Core\Plugin\PluginInterface|string $plugin): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$plugin | [\BumbleDocGen\Core\Plugin\PluginInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginInterface.php) \| [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `generate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L287)
```php
public function generate(): void;
```
+Generates documentation using configuration
-
Generates documentation using configuration
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
+---
+
# `generateReadmeTemplate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L200)
```php
public function generateReadmeTemplate(\BumbleDocGen\AI\ProviderInterface $aiProvider): void;
```
+Creates a `README.md` template filled with basic information using LLM
-
Creates a `README.md` template filled with basic information using LLM
-
-
Parameters:
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConfiguration` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L534)
```php
public function getConfiguration(): \BumbleDocGen\Core\Configuration\Configuration;
```
+***Return value:*** [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Configuration\Configuration
-
-
-
-
-
-
-
-
+
# `getConfigurationKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L431)
```php
public function getConfigurationKey(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `getConfigurationKeys` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L419)
```php
public function getConfigurationKeys(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- parseAndGetRootEntityCollectionsGroup
- | source code
-
-
+
# `parseAndGetRootEntityCollectionsGroup` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L100)
```php
public function parseAndGetRootEntityCollectionsGroup(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `serve` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L340)
```php
public function serve(callable|null $afterPreparation = null, callable|null $afterDocChanged = null, int $timeout = 1000000): void;
```
+Serve documentation
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$afterPreparation | [callable](https://www.php.net/manual/en/language.types.callable.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$afterDocChanged | [callable](https://www.php.net/manual/en/language.types.callable.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$timeout | [int](https://www.php.net/manual/en/language.types.integer.php) | - |
+
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Serve documentation
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $afterPreparation |
- callable | null |
- - |
-
-
- $afterDocChanged |
- callable | null |
- - |
-
-
- $timeout |
- int |
- - |
-
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/classes/DocGeneratorFactory.md b/docs/classes/DocGeneratorFactory.md
index 884db17b..86a443f9 100644
--- a/docs/classes/DocGeneratorFactory.md
+++ b/docs/classes/DocGeneratorFactory.md
@@ -1,12 +1,10 @@
-
-
-
-
+[BumbleDocGen](../README.md) **/**
+DocGeneratorFactory
+---
+# [DocGeneratorFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L18) class:
```php
namespace BumbleDocGen;
@@ -14,366 +12,123 @@ namespace BumbleDocGen;
final class DocGeneratorFactory
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [create](#mcreate) - Creates a documentation generator instance using configuration files
+1. [createByConfigArray](#mcreatebyconfigarray) - Creates a documentation generator instance using an array containing the configuration
+1. [createConfiguration](#mcreateconfiguration) - Creating a project configuration instance
+1. [createRootEntitiesCollection](#mcreaterootentitiescollection) - Creating a collection of entities (see `ReflectionAPI`)
+1. [setCustomConfigurationParameters](#msetcustomconfigurationparameters)
+1. [setCustomDiDefinitions](#msetcustomdidefinitions)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- create
- - Creates a documentation generator instance using configuration files
--
- createByConfigArray
- - Creates a documentation generator instance using an array containing the configuration
--
- createConfiguration
- - Creating a project configuration instance
--
- createRootEntitiesCollection
- - Creating a collection of entities (see `ReflectionAPI`)
--
- setCustomConfigurationParameters
-
--
- setCustomDiDefinitions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L24)
```php
public function __construct(string $diConfig = __DIR__ . '/di-config.php');
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$diConfig | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $diConfig |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `create` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L52)
```php
public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGenerator;
```
+Creates a documentation generator instance using configuration files
-
Creates a documentation generator instance using configuration files
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $configurationFiles (variadic) |
- string | null |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\DocGenerator
-
-
-
Throws:
-
--
- \DI\DependencyException
-
--
- \DI\NotFoundException
+***Parameters:***
--
- \Exception
+| Name | Type | Description |
+|:-|:-|:-|
+$configurationFiles (variadic) | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
+***Return value:*** [\BumbleDocGen\DocGenerator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php)
-
-
-
-
-
+---
+
# `createByConfigArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L77)
```php
public function createByConfigArray(array $config): \BumbleDocGen\DocGenerator;
```
+Creates a documentation generator instance using an array containing the configuration
-
Creates a documentation generator instance using an array containing the configuration
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $config |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\DocGenerator
-
-
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$config | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\DocGenerator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php)
-
+---
+
# `createConfiguration` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L102)
```php
public function createConfiguration(string ...$configurationFiles): \BumbleDocGen\Core\Configuration\Configuration;
```
+Creating a project configuration instance
-
Creating a project configuration instance
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $configurationFiles (variadic) |
- string |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Configuration\Configuration
-
-
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$configurationFiles
(variadic) | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php)
-
+---
+
# `createRootEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L127)
```php
public function createRootEntitiesCollection(\BumbleDocGen\Core\Configuration\ReflectionApiConfig $reflectionApiConfig): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Creating a collection of entities (see `ReflectionAPI`)
-
Creating a collection of entities (see `ReflectionAPI`)
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$reflectionApiConfig | [\BumbleDocGen\Core\Configuration\ReflectionApiConfig](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ReflectionApiConfig.php) | - |
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `setCustomConfigurationParameters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L33)
```php
public function setCustomConfigurationParameters(array $customConfigurationParameters): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customConfigurationParameters | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $customConfigurationParameters |
- array |
- - |
-
-
-
-
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `setCustomDiDefinitions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L38)
```php
public function setCustomDiDefinitions(array $definitions): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$definitions | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $definitions |
- array |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/classes/InvalidConfigurationParameterException.md b/docs/classes/InvalidConfigurationParameterException.md
deleted file mode 100644
index 2a957a0a..00000000
--- a/docs/classes/InvalidConfigurationParameterException.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception
-```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/shared_c.cache b/docs/shared_c.cache
index bb842d99..44020963 100644
--- a/docs/shared_c.cache
+++ b/docs/shared_c.cache
@@ -1 +1 @@
-eJztvelyG0mSLjrPUmbH7By7dk7Fvqh/aalFZqoujqSe+XF1jyxWCl0kQQNAVWnG+t1vJBYKBBOBTOTCZKZPT4kAQURken7u4f65h4d5Qbl68d/L9OPFD/PbsDCr2fxm+flqfvn5x1VwX35cBOOvw/+59v9n9efs8oe/mRe4+HuMX/xw++X2p5vVbDULyx/+9vsLmYZ4dXdtr8Kbufsl3Hx6PV+ETxdmsQyLT+s//JZ+dXUVXDHHu/nl77v5Pt2/Wn7/gx+2E6H9CyvmRy/++1//+le6ZP3ihzi7CsvPPtyGGx9uXLqSo5dNX/z37AVK1ylQ2XW+L0ZYpCt9Pb9Zhb9Wn97sBv326ec0y/e3P7xg6wsTm+nfpj9f3Jird7ObP374W7os+eKH//4fq3B9e2VWxcXNFv/jX+UXlQZRL35wxYQ3qzRJGuh9uAx//fC3v/9tc+fXZuW+vE3zbn/HXvzwxSy/rOchL36gkhNMI3UB8UgRMZ4oHAkVWBiBifrhb/+avcA93DMpu+f3P71889tPVW5388mP//d//+///T//3//7v/+//+d//c/08n/9+EOJGIobeiQIJHW6b4cFMzoIKZzmRGjqBfUmeOfWgiCFIEpBmhPEm9kiAXK++LYvDVJIQ6WJ/63xYP+WhHUoT1yGoeIDiVuZcl90VgkviNZceqa1NcaREH0MCicwMeOT6JKyMXbEPiD5eX63ur1b/TxfpMc0JEOx/jVPt3gZVu/mxgf/++J10sFV+Hv4E0eFDeaSRB6w4x5jETnRVBOCIza0uNDiAZ95oR9mN5dXYfM3H4JZuC/3n211SbPSR9l09H+7W5rL8Hp+d7MqdIXQv3U3VVj/9u/mOhRgIoePdfOj+OP5ovgDLbq5jHh3s/7C/YWg8kdefKZUN9dgFpc7zBWrzElp/Otf6zWMqcwallGtvhYzJo4uZkevrvGqxjA2BDPqUZRGBUQ9QSTwaLANFEcJq9qjVe0ZuDSNpSEipowwETWh3HONMBGRuWglkwyHuF2o8LGFSiQds3eXl0mLh7RK7dxZxnOm4MjF92YH6HE7UHppjY2AoDEg7AP3gShEDTXGG5meOXWWEIvBCIAROGoEitCw3Ajwz+mylvOrQUW0MueoGs+iZ0IZYqjgWpkgGQpJBYjTNJI4EkcV9+anFqHMwSRrRKSf19fmxn/aumlh+35yrmt9ARU6dxS/EhEjUHBUSEV9MhUkhKgD55hryjXgty5+8YnH8yEsvk4XvPWkk0Ouw9oKiqlIS45GRKZPLUorD+dee4MlILcmcjk9ENbLt/ePZ2dT3icD8Vv4uHUzporiBpLKIVpKR5mNmNgQjePMcGOSCfaReqkYCYDourY485xeep9++epq7v5YThXHteWTQ29QzpDIEliVjYR7FFTUziCEnIoRgydcG736xFqZ3sfZ5d3my5PF8HlSyiGZuhTSkxCdTNAtolmDqLaBSGo4xYYDkuvmHo6FLC9vbycH2LwwcrjUGBmpEVZax+T4WossUiFYFSyXWqiR4JL1lxRjpRTSA4vx8N3k0HqGhHbJM5pjzEuZvt74cnycLy+5sMZsuTYsYk9Y8JQaHZU0iivEmFeGqmg1sOXAlh9PmR2t7WCfb6/uLmc3H74t060MiTIna848/fuDu5rfhPvvCm64wFoLrDwuLkg89t6qXtDrByNvH7gqr8A5Y8ASZ0nR1gY/tPV4YywTuF59uzCrL8t1ORFvbb4Du26KEqmNgU8P4Mflwv1YDL270WLlWf/ynbm5vEti+DX5zFdhsQGkbk/G8zJQ9V2DlIOpNQ5gugdT9R2ma5sajQudY/W7M1K6KlysjeD2x/1VTQ+rURvA6h5W9dp9/v3mKkF1uTJpLJOm6QisRZ3I+ODGEtxmqzWfvXMjZFq5HYo4ShGST8sDoZEww2hkycm1a5Jang/Btw9n2wPjuqi3iYCPDV0GS93BNOHeETOFvP97Uy981J4Vr7cv35nl6mJ9jdfXs1Ua//FviisvTKSQ1YYsvlx4w2ms4uWvq+urzdvN5ztBiEOGuNpwh0ORYihx1lDvl6vD0Qp+QB2OduCqfLr4clsy+CuzDOmTD6s7a9MfPXz7fQZWOEaHTMpZM6SX6et31+nhzxeP5uGt3Ul6+Y+b2erRDGJLFpwxQ8LW7Tzh/cK4P9IfL3dTPZpDFk/3cGmuNscbc/fX+p9iHLUOnM4baKOT6StJCnEW/MVV8gHKf/v9wvWGq/jXlrE4xrt5o73CTsboiOKMao8J1SEqjJ3j0o6Ed1O90W6t2r2JEXKtyi6Hesyd0ZY4F6XCTKcPMVfI4xiZVGntHwnqcY8JvVrhy8RwXT+2O2quEziJINHQIBG2SBW+aTLVIXmpXEg0FuCinoD796lBkaeJPny7jvObbxsn6CaJ49NPX9O/b2bL24LWLSYs3n+4s0u3mCV3qCI4ObeYYu284tYYa52V3ikrmKVMcDkaq9oXOJPnmVsQ1w/pe97gVYjpw/XDSOOnvy+yBpMztS1ILFuYKaX3jBAUAmOIsvSPigY5gpDGiI2lpFj3h/C2Yvqp4bwtuWW9jSgUisQbpoRMEI8oWXdpsdUupuhwLEWbpL/oMGueyh/bmgy5fzs9oDeXWNagq8g110FT64NyvihjwAxHEhy1HI1lM36PBr0NVnVqGG9DZjmU2xQtGu5NxIYIq5DURWaDKGctx2w8O/n64zvaYvynhvSWxJbfPCUIskQZJJ1xTgilInVFpxVpTPBj4Uj6c1q6zEdNDP9dijKnEyk0ZUkFvJKSUmmR9ZYgFzWj3HIjxlL2PxBH/oBn+P3ml7AqKIb3YTm/W7iwK9WcFPRbkFgO4YIYpKP2hgrvLbeIGptiVceCERaFscSqPSYyDwtdMqZq8/i2M/9+8/pLcH+8XW7evzY3r8LmcU0O853IMOvo4xTAsuBF9AHz6KlDSScoEUGa5P2MhYLvTwu6r5SZmEp0L9CsH2SVdUhjmyKCYuMj0iRFwwFxpCJO/4F+PElsUF7hNTHN6FKUOZ0gAVNkeQoGBMPROKZCcFwyIiKPAo+FAu0xbdttUeLU1KJTYeYUgzlvWTTUYhG8THGFJqZIF0jqWfrJxqIYor+ouXEl7cTA31xg2QZpjBsunYomEuWcl5YHG70Tmqb/8dFsuh9G8e8jjmPzHHZ+bPCbGf5zYW5vJ5jobVV2OdQrb1AMWnFmUdGKimijjLWUICED12Mpee8R9Y+7fuSZvV3nsGI38Ktv70N6PftafLn4xfSA37L4su1/sBVaeYQRUgnwjkStvaNWGE+Vx2PJjfWH/fJTPTIP72Ix/2eacfcMl29mi+XkIN+S1LJRrQmUx6idxkxKFwOnhljClAkCh2hGgnQyjErNbGXtZvTJViS3Jbds6b0hXjPpgvTRo2it8E5GLxlGQqA4Ft6/R7SXC6v0qb2M68Y5xbvdU5uFCRr1FkSWbRGHaNEKzrDIMI2Y4siMcYFbKZUQdiwY75Gn7HFD8sR0oUfJFiqTaZ0iEPbQOgW6Ue1eDbTDjyAOOvzsWzG2D9NFstuvr8xyWXzcX0+q4jCb75tFb1YL41bL8s2i0wOs8BIACy2pOm5JRaJGkXsdkKAhOKuCYApxSizngvoILakqtaRaqxY/zCQ/DlC2U27i8OJNcvouFnMXlsv7LlQthDnbBlTN9ypv20+1RTFs+k9ltyOVDnd/i9uRljsStsFQ+9LibeeHNs2jWqIhN12i2qbxN1VcLVRNb3b/idPg3xuoiJ7usbH5o9ebNsH3IWonta3bPVx1SqEeKO5a4YrBCr393h9436anKQqdUYeCrTrF7zcvvV87Y5vr/zg/GJ1W67wVpDTYGYJckEwrSRBD0XrEvJCY2bEUrPdH2fEKwno/n6+2sNt7aBMjJ84XVJ6ClkRoFRFzXApqPdbBaKKiw44ROZZikv4OcKjymIriT8Dz2YLK4pkSz4m0XnNsqYpYeJbss/PGOZaAPRI897hlurwL2oNJ0tCXRdgIdroVgWU3zDHMlRJEGWODEQQRLEICvbRWcCHGgu++SkEm10muJjm4OTdH5c7NOX7mR2+H54jjh+ccu7rGJ+ig6CiKyX0yPkofuDNGUh0V4Zhq7AOcoAMn6Bw/QUceO0GHfl5sBfLoqp/+EJ2Cv10vTjhnELK3wPqyCfq4TchcYGOzYFUwTOPke0aKPE4YYJJQag3HyKGiOB/MApiFMrNQBKm/HyE3c9J4M1sktZ0vvu2LZJ0HKPzAEqei5mD/liR2KFRcJtTdVooWpnyoUcILojWXnmltjXEkRB+Dwp4oZrZb6wvK+qRFRfxz8aRf3y1X8+uft+7ZckgWNqE4m8CUmGgOCcwhFIYU2LyvDPlxh/AfPyYk/bjD1r01kOUFIz9efLk9+tVppeYl5lYDsgdzspkoTYzdG/ICq592WP300KJO9sQziQUCDM+gvKTj8hLDI43WoiBEdMhHU5wIby0VQiMnA4PykkrlJWvxlheGHLFzbxbmz111wnrA38LN3X2JSd51Pz7Srs5hl/gv7p6Xttw8MlgREP0SVttc//K+wKSOCU+fr2VWNO58VURGbpG+uryvLqk31uqBlIox/7G4ypeXnB5rJ6ftUEV5CS9F+ZGhCuZ1Uxuw3CuLEEfLLI4Mc7GY3Txi7V8u382Wq/uqkirdL44hY7ZMUdW3da3Cy9vZb2H1Ze6X95UlTUZOmFsP+5u53RWYVKoHOf5oNsNtLvHV3CeB+LCtNal2kJnWSAeNlXZKKsK1lZpFFovA2OsoR5LO6DFd14I5m1hKpA2RZTsX8IB1tMxgESgR1scYnSDBMRmRYoDx2hhvZ6GdGszbkVp2rx9lXhrHvKLUahwlxjJGLwk1xSENYzlnp78+Bby8jvRIzdd0j+o7W07ZjvQcCyEUIUjyEKSNnMniCMqAiAoojKaRWH9obhTTTA3SjYSV7TYsiXAxGq6C5yZqGrELDgeKi5Z5ajSdI/vzR1qJsyeG73aElvW7HcHIceuYxmydf6eGYCFJeoedAZx3jPMjHBDg/Ayh5b3uwIIxyCUbnmDNHXeWMiNlepF+OsB5XZy3wU9ODeZtyAw2XvUZW8LGq4qeeCcbr4TRxkrJVGCCkJjiSYy44IjbhGwhx3KmQY/RZdNU0NRg3VRe2T6OtPBIpKeMEUajss5T54oDiSVlHI+m61d/PklrGcqJwbw9wWUPHVBOeBm5TTbd8miJddxIFi21QmECOZ66eO8igz4x5HchwvxWciWKTQ9KaqSk4oolv4ZEKYvzzPBoziV4Qpt/dq3HxJDfnuCyeE8euycES02lL/5VhiGmqFc8IDSaE4t77N5b6cygB3Me6RYDeD9TcNm8kYm4CFcZTv+nBE2ufMK8DTiaGEQUI8F7jz5OF7V3E4N+JzLMV3NxJgNyTlCiHcckIK518nUExjKQsZxQMNCs0tGNJhODfVu7c9bFuUUjwkrbuU/vn+xre3dRzFZhe/epC2683VtKHIVxmFhrUQr+VbCBecq8YFJEaWG7N2z3zm73fmZdEBpLJirEpMFWEEQFUhIbiQj2nDgXqfduu5sbV9nNzfaVe32Vw9rLTU7sFhREQvf02SD2cqPMXu71Fd3DmVffyb394sT2wAqu4OiK2XD2cedXmI2nuL68T/uWdLp7uAX3sId7Bnu4O97DjZXTRivnkWfKF1u5BQo4rDcbIE3giIBqe7jR+oiAKrXyGxv30vvCPU1u7WJ+/S7E1W73NqtSDrEZ4+fZXx9Wiw+z/7o/EIhVv4C3yRffbpItmHVWJT29+ebFIlz+VvjXuz3ZNW47fffWLMKHBw3mWb35//1uniKJsDL3m6+r7CjbfPd9uJ5/LSYOrxbmj83xAMXG6/KNO6VDJJF//HYbPs6327+Lfda8Cg2y+frHFEcVTd99eHU1d3/s9lOXF3dlRvg1rNvUb/ZPV9rjHG3Qmgppg8Q+euwN99GaaJWwWDvgzWtXejVS94kxhc2Elc1/ImW4oVKEYJDWWkUirOFOMea8FWPJf/aH6zOXoIkB+kwp5ZBsHOacUaM4xdpwGby2OCAhNfIUs7HUlveI5DP8oanB+AwR5TBMSVTRWYyJiZRwoqmznEYaCDdBWchL1sbwWZ751FB8lpCyHYF8REQpFJR2BPMonCBGKWwMV0I4DjjuzlsuiRInhudmwspGgUFhQSlVBBuEA0cWK+qpNVIYx6IHXHdnn/eYi4nh+TwhZXf2YM6i4gK7KDxHjgmGqAlUiMBTRAg7e2rb5yYs2sTg3EhW2d2YTtOIVMHUcRUlMslvVkI7nLzn5FPDHvraqD6X2J0aos+VE+yVh0NKBwjnbg4pDUoQrw2NnmMiBBPKCoeZERZ7xoBpro3nBnmzqSG6gahymEYBO888SfGgCjZ5HkxJ7bSQXirNCcSD7djoKpncqSH6bEHt9gvwqvsFTlTo9rZbgFbbLZC93MZ7BRQTKBrEtEY+EGskJlZrKR02GMkIewVgrwDsFehqrwD97Lcdx1IYdedWd4tBnqxZ3bSeuKGhmdbs5TY2rVxir4OJPgofqEGWEISR9i44rZkyYFrBtIJprW1aC7r1tGkln+33lrxDMqrrSudj8ZdkxgpOVVw3vuYG+eSaKeU9SR4a89CxqeU8817b5v3Xv4ar22KT1NRisEbCgu7uQ+1P8At0d2+1u/umsF5XdYqPLkV9ucP8uN9T5UIbO8KMRUeMYhEbEVwUzGppUHrHOYlMgiMMjjA4wvUdYVXpdHn8+cv8z4/zjcX9uLvJH+9v9z/MYr118vk4yQjpwkdGGhNjnEPEEBewsERjao0Zy4FePTrJh23yD9tVHbyfboejBpKCpo1Da1L6cE5o2th208a1m6wqt/E6a6HiPbnQqmJrrzNuorF7bYTX2LmQfITkLCgrvBeMO5J8KoyikeBeg3sN7nU997roQ9C5ZGTFNNURo9KjxLgMyapEFZD3jCfXmxKLGYnGW08R4tuApFLS85SJLKSTlqwhhSM0F444KZNQCEEhMIYoS/+oaJAjKU7BiEE4Utt5k6XCWh/0sn69fVkwcwVYCq+k8FBW11ebt5vPp+e7tSU3ONcPzvUbNtK7PtcPTml92nwVnNLa5imtm0C8chHXGQ5ab2F4M4/5+C00DsIDxmkl9E5EwogMSjgSmaExeYE0UCsgCIcgHIJwCMK7D8JlG0H4m2835nrm1luGBpUZ3NUkF71C21nOjt5qb4taNd0890aaHydhaYr1gic8MJfMmRVUS8GEMJgqU2SnYGmDpQ2WNljaOl7aZBN++fBuhrOUyaaR2eNb62vp6g1hVVOhWAocGJbMK0KF4ALZQBHlwfKIEURhsFTBUnXeUpVvclQimTezRTKA88W3ffGsC/sK5rSEQKs52L8l6R0KGJfBbW2oyo8WqDvlvuisEl4Qrbn0TGtrjCMh+qKjnieKGb9ds0SDNSsu0mX9ZlbpJoe0cGWrMzVGRiYNU1pHimlxAh1SIRSH0HGpBRy4XZc6Z6VPNQE2zi7vtqM9eDc5nvwMCWWbvWqNdNAJwU5JRbi2UrPIYrFceB1hE17t5E+V3h77R50/SGT8Fm7uJgfpNkS2S/yghuHFkVWotxhDNYoxSq++caBhCREycMwMY1wLwlCwlkZmafCYcAeBBgQaEGgAJ9Y5J1Y4MeXxBfl8u16WflxumoHPnUnRzODiiOOHHmotkYRDD4dzaGdpV9jtHB/2Qfbw3WRP7dTa6QgAfsKzlO+xWywH389S3ow9QThaCnCEQ2TbhFvJIbLKI+ENl9YoFxU2yCdvxVsrmGUpLghwiOyxacK9E2Y2mlVe6Fy65O7o6vT1Bx/sjpItLyYtHapwqDfXOF88Gqu4eZljvx6O9T64u8Vy9jXkro8cZTzKvYs1k1Jc5aORaLXTT6nTgTrGqeGGGUEwQlFgFLXCOHITgeKrS/E19w2nxvC14U1vQC5yBN/pMLC3NkTseOh96iqb9yAiKWwODkcigtfcYoU5Ekxi4qyhUgNhB4TdUxJ2mRZd97rRo1yYc1Zz7rF1ihEuvQhcJBfOyUiZpHpLPumT5NMixK2pfHk7G2ARFs7lsoWkwhMbHDHeWC0DikZI43VCi7eCgJtQ003gpSe/nT6JZfnLYn53Ozkfoam4dkcj0EoOwilV7a17N65kC3MX29hdwIxrr1T6f6odc4QgYrT0mirFmKdwLAK4C+Au1HUXxNGGhUfUOvkEA3QZ7o9FyLa2qnVLfdVSiEwbqxoX3Hy3bLCKWpJwIkKgWGqHtRPSGo2DNho6woJ5BfNay7z2UjzRqWfWWEpeOcscEpxKb43zBjmOChNjCQkqim1BtjpjEUr/fVyY2er9/idDWpNULoylnlCNjEY6SUcEU4jJKW40jVp4w0YSxir5dHHs6TaZa/xsXkMcW1NcuVQO1soLTpCQCjFBbFoyQorevGKKUUHGUq3NNesvmXMortOP6/WVWS7fzf4IE0V4GyLLHwVvkaQBRacRx8kdwiJ5jcggyg0J0o4E5ZT1h3J+2C7v9CN7ZZZTBXhDaWUPhg/cKRu0kh4bxlBRWh8VTQ5uCoX8aA4dVsOi2V8b9yVs/i2Knja/Xa+608N2Q3FlDbd3nhcHuFlKFMXIYq+jY1KjgHTgo+mXqXsDtywtnHgc4243RKVndLOM88X198c23aKTVmWXbxPLvDSOeUWp1ThKjGWMXhJqlPNhLE2RCe3PpufqhR7lAqcL8bPllIOziwhFFtLfSSmE88VRhlIiTC1O6BZj6QcrVG9wZuXNqh9MMnUonyWjHIyNJNYGRq2jOGJlMA6YIsGUUcgKPhZPm/Cno0qquo7TRXUbItttbSdnZmBP8vmir96P6KyE7Inrb5yfjZLKoocNCxoTy5BlmIb0AkflODawvR3ys5Cfhfxs6/nZ2Qs+giKYxpLSAiPJkY7II2djipmFwogkkyMsShZo2+n59Nb/0pXjfh19ntls5I1IPivXElPhjcaYe8kQQ1QiaShks/vI991jaKLpkDZEBlntFwxDVntcKIesdklyRPVHSEBWeyBZ7Ykk/vqz35D3g7zfUFDfoz2HtB+k/br2Twik/QYEZUj7ncmYQNZvuKBuJ+s3+SJSiqCIdJgAb15EuklpV2vmdCax31tau0qrp7PuoXlnBxJ4MFyR4KwkjDikBSfCJ4uhglMBUtuQ2obUNqS2IbX9hKltefQQ4/zq8dPN3fXzzGonQWAcPUIkCkdMNJoQppNcpOQihtF0JEX9cQ1nkPsFfiAVco60IJn9guEnZCAgmQ3JbEhmQzIbktlNLDgks58BziGZDcnscSMcktkN/BNIZg8JypDMhmT26EANyWxIZo8a4G0ls/H5yewsld9XHltmzlE++/Ibp7CFUiQU27C59tQqZk2wkmiFqWLKMgwpbEhhQwobUtiQwn7KFPaZfcZ/2mamvy/jQ8ph81wOmzOMPCFY6oSh4l9lGGKKesUDSsIaiduKcY/9hep3zr4ow9DkPNj2BJcL1DglnhNpvebYUhWx8Cxan6ync8knGc0BcbzHZgSly8vDSdLQl0XMUXb22fSQ3lhgWSpCSoOdIcgFybSSBDGUEI6YFxIzG8aCcNljXVIFcQGyGwkqa7ONTEGiiog5LgW1HuuQTLWKDjtGpBoLommPx6FUENf3UgNA9BmCyuapk2k2jAtvaIgkGJdekQRqYqWwOo4F0awvt/vvU4Mlli9+eLsqPp4vXl5eLsJluohWumzmo9nhd9nMXX/zUxARRSHQ6IqKWKkVYqQ4it5xGykOTgCPCzwu8LjA4wKP+wx53HXt+PPci4SwsNRzxDFyNGiFo1YMU+qJJ9wyMxJ/EvdYKnbGCYhrAG1eTy9Oaigu2I30gvW40w52I9VnbWE3EuxGGjPAYTcS7EaaAs5hNxLsRho3wmE3UgP/BHYjDQnKsBsJdiONDtSwG6kVjMNupKECvK3dSA3y2Hk2f/h57Nz1N85jGxsFdprQokAwOEEcc0qmn1RgLjjksSGPDXlsyGNDHvtJT4sUDfLYF4viq6tvg81nZ/clGasZdSJhRyvDdIwkBM0Z18k+c+TGcmIk5v2FaepQ6U6z+x/u7PbVDk33LyaaIulGiJAVfIE1hazgICHfYVYQqDig4p4a3l1TcZA1gazJCLImwCgDozwGRlmjhozyybi6N2ZZNWKWT9xHY4bZYo6RRTwQo11y6QSmgitsmRPWc0SAYQaGGRhmYJiBYX5Khpk1YJh/C6svcz9Yflnk+GUhNPGSKicoNS5qh1VAnjJMpMBYjmW/FKH9hWVSNKBGN1ja/pgo0da+AIFXTk8WeOVhwr1DXjkwLq2lwTktrOLKUJxcbW6SM6WsI6PpgNXj6WXqcNVuaJymS811KEngofvrOAQ89JPw0BNJGRIBOcPhohrK9yHZMmqAt1W+rxomW05QTL2lWkSjVEv2LhonWhTiKjLqMWNKRRQpZ9YIb9N6GD2jERItkGiBRAskWiDR8lxL+ZMQlytzsxpsqiVbyq+iZMFZixlGAYUiaJPp8XBluA3S8JE4s5j0xzzoJlXoDyD18N1EmeiuxQlpGCjvHyz4oby/KbY1UHXDhTeU9z8zjENWBar7gXCeGqKHUt1/MtR+JtX9J+6jMenMldbeUYa9Y1KmRc9a54UwmDKHpHdAOgPpDKQzkM5AOj8h6cx4BdL54TU/PZeMc1yy5xJrwknwlsXgkOVBaOIctgFFgUdzeG9vbirN+V0Xi/k/0+ibd5NzSeuIZut+Ml3R/TxUOtaTV9nyuli12WDUTjglcdAYa8qFMTJYL61F1kgCW0HBWcw7i6VLT04ab2aLpJ3zxbd9kZBCJMXqUGI+ag72b0lih0LFZUJdb4zCrUz5YHO1El4QrZMnybS2xjgSoo9BYU8UM36z/gt0cv3frAab55quw8+KPx2SO7B+aCSJ1l3Nb8L9VwU3XGBtEHFh3QxO6LOv5/WDkbeqo8of2hkDlqztirY2+OHSiTcld+lxvvpO/i3XMOStTXqwVu7zOLnHcACzT/evDlhK3Z7s52VY69ubzcCXEh4Avnvw1WvP7/ebq4TeNYM1K7i+jvCLXvz3uOB2ylpS4gzAbQ9u9Lu1vDCrL/0ZyvQAflwu3I/F0OO0ekWsMVsVvw47x8G6GAmOnGgrPSUES0+o85gHJhHfQFOeD823D2fbA+laL5oI+NjQZXDVHUwT7l2vbWMDmUsBPl5or6/nN4e//dlcLcP92+Ly0Ta+bjpwCjk+Jo+2cGzNrEDM3hxrEeWOJ6o2x7u5S4Lyb28eDF50Oyh6WrQz+N/nq4PxiyKmR9v064//cXH3UPDFuXE8p5xHXadfFvO7280hXFsSImP+GbIIzP8QzH9hHNf2/6Da6seLL7c/bqb68eCZT2aVQDpYwq0WXkZukFFMBIo8CkVD8BTtPvtVgvSxSuANA4Ro9fK+R0ZmP5N8+OHb5cVi9jVdxqMVBKMaO9xrzzlfJYkE/2hNwajG8bx1Z72zVzP3aKXB6HCpaWvK/5gtZ3Z2lTDwaPnRNbrEHA672YhW7UmujzKtcaZ39bnKnuC6dr4BbI7O9vjJifWTq1H1Wm2uImT9eTG/fn23WCQ93D3e7/PK4hZbn/YIUlTDp7frDlkNK3ot0hpV9HWmK1V41FCYmQkfIwZv7MvhktPCdCdBs2mr3MHMR3CD6caN/NfWmTx6sq0iiGFHbGBWBs6DMSoS4RXFLAoEidja9YJNidOJZWdbIJrXABesUsr2ZJ6krwyuKM1h1rvaxgldTaSLhmjEpMEeeaMECjYgTyhRjnFI6EJCF6r/6lT/VavW2uj1oNKz9ETGwTgqgHLaWzzZPuV07/QVH/eYpa3gmX0/Hn6fHRojBZVBr8VRAnohPdt1XkwUuTAqA+aeYueYM0RhppVQiDPGnj3j2UtebC1dUYP02M558X3p3IdFYSpPB8JBJhc4PS7kgizOUk5hMYrWI+aFxMyOpdVsf/s/z1+bphYBN1rEj+GZG5kiGBURc1wKaj3WwWiiosOOEalGgmfW407QCtL63lEBAH2GoLKApsRzIq3XHFuqIhaeJQPtvEnrbEL2SADdX/Oh8uD94SRp6MvCMQRD3YrAsvhmGPnCfdRU+uJfZRhiinrFA0IejQTfuD+D3Z4LOTWgtya4bOopOdqGceENDZEE49IrkpwUYqWwOo7GQ+kJ73+fGkqLfTqbeHK+eHl5uQiX6SI2kMsxQWLj+wIT9Mx4zOMe49iIpRx67abPJqAXeMwOecygqaXcEhMVF9LayLWIyGkaKdOcAo9Zicdk7fOYNcsjtwNWb3L6aEr8t5KdBM0OOno0x7o0qsld7Wqj7l+Uz0P3aGBGimXvZnv0UiBE2RijTYGXdyr9hwLm0TpGmNV2NM1b+wu96j/ONRjfzf54gv6tGO2Dod9QK62Nn5pK6pTL6xwBp2FgLm8bGjJG57fEG4kY2YTlolKNIYNC8kecFVg6rITHCnYbVvdGHrVnrIi6HeLObjX9083d9fdB8HkKcF/1+X2kwnc446bW3Sa/j0L/diI7jLCw1HPEMXI0aIWjVgxT6okn3LKxHDPdY5l0QyBOjOtqKq4ctqlRGEePEInCpZDPaEKYJt5IyUUsqj0B2/Ww3cw8Tg3azaSVtdreCCQY1xJT4Y3GmHvJEENUImk2NAYgu9uw7tGaPTF4tyGyrPX2hGpkNNIOCRFM0XnVKW40jTphHjDeg2fywJucGL6biiuHbUIQ4skxwchbpxxB1ERJZLLkzAXt5Viw3V/NT6/s8cQ0oVfZ5tRmKgf19aY1cExfq4rylMf0WRKTw2SZVzJFBtIIJQ1mRlEc03s9Ft0g/VXZdZsdnJhqdCvMx4lPz7kKwRnJlCJYW6I8Lk4+C9gqgzhwP7W1oUbvmwoP8GnORnvCfGhxvnLdfGhVAZ5Ik3rOHKRJB9OBukNNmkjeVEmOAkOk8GuwCs6j5O6IBHZhNKJKQN60St50c9pAje57x8D45tuNuZ65fUzuEqqPWpE2xPpGOCdymji5v7E4xUM6LaRkFBlvEMEhBI28gZxm7bW/K5BMzQnuSo7Z89uFJl5S5QSlxkXtksVEnjJMpMBYgjbU1Yb2bdrE1KB9AWZXAxK4jkSh4kR3rmSIRmmCuYrIODWeEtj+uPbuS5onphDdCzSnIMZqVjSuTguFMkzHSJKfxBnXTnOOHCRaa7tLTWjg8sc5vUWiGyHm9MBFhCILKZCWUgjnC7pQSoSpxVZjQUEPauoBy50Asp3kCcnAQcD8LBnVO8xz81AGe5jn4eU17v1qGeMMIW0MRxorx5GhgWOBrZVKYQm9X6H3K/R+ba33K/6cLivOLu82nw2q92v+qG7P0o3HyBQPpOgmRpK+8PQ/h1zko8mY91hEW3ru1L3iXKSrKpQg+WQuLJfzxbrzwaPfTs4FaEtsOd/Wa410SKuhdkoqwrWVmkUWC+vndRxNweHTFYw/fGgfkwX89PMWbZ/eLMyf6c/urtMY68F+Czd308N5CyLLVgfygHW0zGARKBE2BXDRCRIckxEpBhivjfH8qebHH1jYErM7l2daMG9HatlaP0mEK+gJFTwvUp0Ru+BwoNgm7CtgKmojvfREziPPLH2+zq4XS/CrwlF3i/TV5fSA3orQso30aGDBGOQStp2h3HFnKTNSphfppwOc18X5YQI6/8hWh6bpH4ur6cG8DZllE/RGGyslU4EJQiIKDCMuOOI2RaVCQqlqXZSXn7x15IkVj+Pi6u5ycwp0Qa9MDuGN5ZXd6kYLCy49ZYwwGpV1njrHlJCSMo4xoLuuDS89/vzI07pYzG4etWt+uXw3W04P5u0JLhuFOoKR49YxjZlZt1UxBAtJ0jucnBjAe7e++f36ux6rcDcn6bS0IrRstpxjIYQiBEkegrSRM4m5MwERFZIPAziv67XkaeCHj6zIOKXHtl2Bpxd7NhNWDtfRBq2pkDZI7KPH3nAfrYlWCYu1E4DrLnC9zmh+eul9kam8WRUnTr8LcXo+SjNhZU/hQMpwQ6UIwSCtdXEYtjXcKcact2I0p3D0V91UJWraPKqfZ399WC0+zP5rgvVN50kpm8v0MfkYCgWlk6/No3CCGKWwMVwJ4SBv36GFvliEW7MIH+Z3Cxcmmd5pJqys5xEUFpRSRbBBOHBksaKeWiOFcSx6wHVdC10l4N88qn+/m6/CdViZyeH5PCFlGT/MWXG8AnZR+GIDgWCImkCFCDx5IcD41bbPVTLKm0f0PlzPvxa2JrxamD/CBAPDJrLKZmmKQ0KQKqJDrqIsaoqJEtphwo3FGHKRtVGNKz+p5BZ+/HYbPs6nSOWdLadsNBiUIF4bGj3HRAgmlBUOMyMs9oxBNFgbzVUI181T+hj+Wn2cv5778Opq7iboQTcQVbYpcsDOM0+S/6yCTZaaKamLDhBeKs0J+M+1MV2lYHP/Qf0ajE+jTw/RZwsq2wCZRBVd8i2IiZRwoqmznMbkd3ATlIXGDR3Ggyl0v/yt2DkzOSyfJ6Ts/nKHOWfUKE6xNlwGry0OSEiNPMUsAI7r4rg6BfX2+vYqrZ7TQ/EZIspmu6X0nhGCQkjeMWXpHxUNcgQhjRHTgOGaGBbl+57XhWXr19uXu31OYbMR6tfV9dXm7ebzyQG7Nbll0a6K/Y+6OCzVB+XShzQZahxJcNRyBDVMtdFeWkN88qlNG+ltyKxSp4TMDmY6gE4JRy+vcaeEpOLFEchJ3QOTUaT/UYGZwBZrm95j6JQAnRLKOyUUOoUedwQwy2VYLX8Mi8V88Tn8ZdJ9hP9zezOIZgDFGefr62bltuDEtfdjBkoV4fiVNe+VIgkigibtp9ymn9YyG7hy2hMrNaXbR42PPmo/d5+Xq8WdW90tAhncs+bZZ3304vt52DTzsMsurfHTFg5TGbS2DiFCDPFJoY112FljNSXkpGI/uKrBPey8Yh+79qdX7JIra/yoiaSWSuq0xNE5EhEl2DLJCY5GO6M2j5qq7KMeqgUnJx/0U9lvdOIxt2u9mZWOJH/FsWCRwjQt3MQpTYgzVgS8rdOgJfp86Fs9/cMluVY9OCpsMJck8oAd9xiLWBDi6VZxxKPZVCNIbxEpOXysmx/FH0+wBc8JaWTbC3OjIkcWcUOET56UYMoko4uDZ8qPZh8MZ71Bkx5Ka/9h/Gxc+nd67VCrCWVLd9AjnlCp1e9lYWwa4VcNZ1BIkSuNMkWrOAjumFQ0OT2KEqk5VUcd3IzyP/3SiBmsjS+47u/kN1gcW1ocNUZGaoSV1pFiam1aJ1UIVgXLpRZqJNjsb21kpSbn9T4//PDd5NB6hoSyRWXMpgCLeS18QEW+17FIQ2RaCCcpHct20P4Cj/LM/C6Xs/7x09f0lTez5W2x2IfpGdxzRJTdMMcl1oST4C2LwSHLg9DEOWwDigITwHDdCKW0Rmo7ycVi/s80+ubd5LBbRzTZsBp7zCIyxHjtRTA0BdlOYo4FDcmpH8smz/4w+6hGNXOexubHr+HqdoIIPl9Q2c2dXijGLBWOBhWZsikaTQ5wMsWSImHBBte2wfmNXrsXk4NvZblkt3Cm99palqApOaNSxOQtEOqMFIHx0ZCaPVrfUpcuDXaZJtkZlm1Qnb79U5HqX25/PzkINxNWdhOnpMITG1wCuLFaJv/XCJlcDE2ot2IsVrg/PoLn3L3tJO/n80ed9Ja/LOZ3t9NDdkNx5bAdNHVFBkpYiw1SnHPrCBEyvSdO8rHwwD3a7Mcbb2+W86tQhDGXi7BcvjKL/ddTTU2dLaespY6cqUgw50QgbESULqBiezLC2EQ7ls2cPaK5dOPAa+O+hE8fvphF8K/n17fFIwr+zbYbZJHiW//F9DDdTFrZrfdGBiIpwTJ4R6wyNLroSVQUMaoNILsFO33/rN7Nnbnae/m7LQioiWL6XDlluWVjHE8oRppgzGOg0nufHGqhsfPEj4Wnk72h+dG5tyX5q5/+cuF2/ertzVdzNfMPPk4XlMZahcX9n00O6t0IMacH0nClaUjRJHHKKWaUR1axQDX1mpCxNFTpsQrscPvXy7eFE/l15sNiuscFV5RKvmDRGZ1CQhelwkynDzFXyOMYmVQijKU9W48Z7VJj8yBdO13A1hPOtn5RltcvHi1C2m3klJ/nd6vbu9XP88W1WT3FPs7nsZOxjy2dz2UnYy/7OouKjmPbe4+BtkOx4CiMjJwYq7mWMjpkUJBWcWFQsSVsu4DofJnsjuZJkfC1ufH3R7xt3w+hcpbmCmeltUVlYkSG2aCEdcimfyRBPjge9VgCccafciV8CJHi5OJ7eMBKmBFOlumXLpqAGQ2OCKE9E0gwKoTkAhdNdkcCXNETbv8+OSQmg/zh23Wc3xTjXd/Ob5I4HsGxEhSNZzHhTxliqOBamSAZCoSk+ELTSMZydmFfUNxsYq63yk4NvLUFtA0qiis8FVScGGsXZ/CiI0vxhxBiQIgxlBADHw8xSvDaoURsJIFZmowEN4JiHlnypkmwwZOgVHTbFUXUiy4+hMVXCC2GtSzSHjc+QWgBocWzS2NAaNEgtJCIGIGCo0Iq6tOKTkKIOnCOuaZ8LC1XVX8m9FidVvkSO0Hk1pDOLqgobzBWeSCIKCCigIiinYhCPG5mdpgq36niLq5/n57qb+Hj9hYHFF1kO35AdAHRxbOMLmggiFCqEXFSqsAU4ZRy7qXmUqPRlJ70Vyz4qFNAsnEfF2a2Wn6vUi4eSxp+5tYfTA+9Z4gIImSIkJ9BhOywtskdoiL5i8mmyvSpRcltTBZVe4PlSKCoezOnvKS6sqLLODEUN5DUNnLW8nTkXHVQiKIhioYouqW8XPUo+qUv9r6tT+ZcQuw8qDUTYudhrJMQO0Ps/IzRC7EzxM5DwmN7sbOUjjIbMbEhGseZ4cZQrn2kXipGxnIobX+xM8tEhKWO4tSwW1c+uwxzvTi5ZCiIjiE6hui4pRwzq1e1+qCnwIBiZKheTTFyj7s6IEaG6lWILwaPxPbii6CcIZGlcEKllYV7FFTUziCEnIoRj2VjXI80oz5hJcqX2qkh+Dwp7XJytH41a9mAEHFAxAERRzsRB63YhePl7e0QAovsMa4s3TBVkmnJkaaOm4CEEJY4JjVxwo5kUeyr4cbk/LPCkh33z5IGXM3c5nHnU2ku2WUSopPJGStMkkFU26Ipq+EUm7GECaQ/8pcc25S/tkoTQ2leGFtXS9ToRpC+Bx4VeFTgUbXE4Z44/nctneyBkU/vZmGc87MmcuwqQT1unoWDV09RD+0evOoiCswwHooCJyOQx4xrJox0wifPDQ5erYvgI0caHH8+F7sW2K/M5eTQ3FBacAAEHAAxPEx3cQAE1SjwSIy02OnkkVsmY3qjWVBIYgTHTtVG8+PT7x4y7i+9nxXfS89r85s9f3FykG4kLDjY5AWGk02eFeD7P9kEq8KQW+0s0dhgYZNlV05ogryQjI2lD1OPBv4wUDo8YPrg/XLK9r2JrHKoVlQwxKLWInAhjMLCea6s8+mXmDk44bguqmWpc3lPMl6kqyoIw4vF3IXlcl7ym+kektKq7LKnagqHLVfEGIUM4hxx5BElFisbJPVgy2vTguXC2j/eZsrmu6548v0gadQRaYmjDyLY5HsgQgNGSCrr9VjO7u4Pu+JwR8r+JB/mdwsXCipgNT94N2VAtyKz7L40ZJ2VmGkdLCcORReIsMQajB2NxgDK66K8VFj3a+vHP2eXnzZZyE+v75ar+fXmzaRB3oLIchhHngoZtNLMaaEikcRj66gKklmKyFj6FvWI8ccs2OMHtkXa7pFt304a5y2JbbdTU1cp6clnkaDOB+p8oM6nnTofdfKEke+xSPF6+/KdWa4u1nb8+nq2Wq05poPfDKECSOQKgLzRXmEnY3REcUa1x4TqEFXyIh2XYym0lviJ6a0z0TOxdbZV2cHR1n1uuoOjrTPkVs2jrTPmOmGTCBINDRJhixSjkSVTvS6AExKNBLewL6arLJkq2xfz09f075vZ8rZwp4oJi/cf7uzSLWY2VE0ZUM2k4NEGari3ihrlYsQkOsswdcaNBJs9pn+reem7X2zfT866niumHJanUhffn38AVfH9VsVzbjHF2nnFrTG2yBV4p6xI0TATXI7Fw+2ROs3FJusV87vNeRVi+nD9LNL46e8L+mRyiG5BYlvCFBf3U4kxPStW3HGp7PPt+jsfvi1X4RoIVSBUh0KoiuOE6jHQdigWGRxSnFltBLWGC2+cwj7qBJbgNdFbVpWcxaruKpa25Uy/rq6vNm83nw+fUY1CoUi8YUpIglBEaRWWtqiLjc7xsfSLJf3tqMyuI+XIKRrBfX8LK299iWVLT5ixglMVcaDYcoO8QUwp7wlimnlIy9eO9PP55VfFkucW6Q+W+69/DVe3EwR3M2Fli14lFZ7Y4IjxxmoZUDRCGq/T8u+tgMLB2rhWp4X1fj5fbV5+n275y2J+N71+ME3FlWW0aGDBGOQcDs5Q7rizlBkp04v0E9jZ2l5JaYHnkZqgX8Iq/dXddRoi+M3o/1hcTQ7grcgMWC9gvYaM8TZYL9ht3BvCYbPxgDcbb9jfHS12Bvt7gk0C5heYX2B+22Z+5YmTQavpKrC+w1uWgfUd8CIMrO/ziq2A9QXWd5S4BtYXWN+RYhtYX2B9J4ByYH2B9QXWF1jfJ2V9SVusLzC+wPgC49tprS9ug/F9v1wNjfRVQPq+kP11fgbSd2Ck70QaJdDeEA6NEjJghkYJA8UtNEposVECJNIgkQaJNMA1JNIgkTZZbEMi7YxYDxJpzw3lkEiDRBok0iCR9qSJNN5WIu2AoIdcGuTSIJfWdi4NoxPJtMOT7S6+3Jao7prl/3L7YXVn7Y70v387nAQbzyXYkj4RZIkySDrjnBBKReqw416apFZjYXFlf32a1SH70yKYprZodyhKSMlB7/JhoBxScgPFLaTkWkzJCWKQjtobKry33CJqrJPWsWCERWEslTz9EV9SV18cN6zOdubfb15/Ce6Pt8stS29uXoXN45qc6e1Ehtnj9phmybv2SkpKpUXWW4Jc1Ixyy40YCzk2TPr395tfwqrgMd+H5eZA0G0QOynMtyCxHe1FK9BerbnsQIUBFQZUWPtUmOyACksvd5nR+eJ5EWIWB09Z8CL6gHn01KHktVIigjTSmLHE/rK/JVofSqt1SE1sBe9eoECOATk2DKwDOTZQ3AI5BuTYcGkBIMeAHAMtAHLsCckxhjsix4477kCRAUUGFNnzqBZLL/9xM1s9L3IMWWUd0thG6hDVFmmikAyIIxVx+m8kK3SP5Fg7JU7lYJrY2t2lKIEQA0JsGCgHQmyguAVCDAix4VIBQIgBIQZaAITYGKvFylx2oMKACgMqrH0qjLZBha29xWSoLoz7I/3xcqfIgyPDsgdSkYApsjwtx4Lh5NIyFYLjkiU88SgwHcnqrPvrTaoO2wu1CqeJrdzdChMIMehoOgycAyE2UNwCIdYiIYYcc4xZx71hjJjIbEDRCyso4QhZMRJs9kcFcFZledzMuVsTp9rPtIGogOQFkvdZgR1I3ueuBUDyPiXJK9sieSsFokDzAs0LNG/bNG9BrzZned+Yu7/W/wyBycU4R+Uy5y1Lcb/FIviix74mRkWuJfUs/WQjWYOx7I+zeqRXtUEztUW4scCAk30hgJMdApaBkx0oboGTbZGT1RgZmTxLpXWkmNoUuyMVglXBcqmFGgk2+4vcWakz+LBJ+4N30zOs9SUE56TBOWnDBHN356RN5AySHrepwRkkLVTkdHQGCZw2NcjcApw21cNpU8QEymNBYGImpYuBU0MsYcoEgUM0gPC6CJfnPq/N6JPFeVtyy6HdMG64dCqaSJRzXloebPROaJr+xyHirF0xUSvzuXkObw7OfPzPhbmdovvequxyqE+hqdDKI4yQogQ5ErX2jlphPFUej4UD7NHGlyfdjuf7Lxbzf6YZP+7SmG9mi+Xk8N6S1HJIV96gGHSRoUUpgmVEG5Xc9gR6IQPXFpBe174fli6eema7h3VhVl9efXsf0uvZ1+LLxS8mB/m2xberEkK6rSqh+/QnVAJBJRBUArW+4RO3Ugp0H+L842YWZ8FfXBkXyn/7TDZ/akSLHJ9hkWGaEIYjM+nquZVSCWHHwqwll7u3tTrNdVYFzBngmtgy3qNkoQbpBYcapCGAHmqQBopbqEFqsQYJGGFghAcDdGCEnyvqgREGRngaSAdGeJCMMGuNEa4dtAJzDMwxMMet7yE90Snwsd3YGqtNcUzxJtmltGC6sFwOgQ4mOTpYMMyVEkQZY4MRBBEsAqdEWiu4EGQkyzT0Uu9oWaV6nyK4WS2MWy3LKYITHKvxIvmHBEnMSKBOKqRwUFon0+7EePiA/khWfthHsablmhiSm4rrvkSgQiORWkODmwduHrh5rbt5sq6bdy+vl3F9tcW7XRX02qV7elcv2ytkIq4edAkdhqu3WQ1xhcNEa6sarIiwIsKK2PqKKM5eEY/sf3v6BRG4j9kLBQviIBbEye92xkT3lxeG/c5Psd956/ShRk5f6ejg84HPBz5f2z5fsaq04vPdp6nB8xvOggue39A9v4l0AenV84M+IOf5f+31Adl6gaJFL/DBHOALgi8IvmDr/J9q6Ave8/RbNYWU2ECWX0iJDcMP3K6LpIV18ZGuwZoIayKsicNdE7+vfbAmwpoIa2KXa+JOp2BNhDUR1sTWcwbn14mc3Dv99GsjhbURGmoMZG2cfPcMjntLG0D7jGfQPiNSrb1RQshgk9cSKHHeOpY8GqWp5HoksO9rt+KxTU+P/RsAemaPWHVx7cId0qxA6oQOQdgDYQ+EPa2HPahB2HO0hc7TBzxQKAWnmA4/4JlI4zQpe3P9oHPaWVVSbXVO2/LerKEjeGQGcAHBBQQXsHUXUDdzAU+0lANfcBBLMPiCA/cFJ9JaFKP+ekVBc9FmBHhHzUUJbe4eZqcCPxH8RPATB9RJY62yxYaX92E5v1u4sBEEuIZDWJHBNRy6a4iYZg47r6SkVFpkvSXIRc0ot9wIPhIg9uka1ukLccR6TQzNLUispU4apaODzwc+H/h8rXODtdvG72lpYa82xqWIy9Z/9HpzK0Nw/Ri4fi/66l8Art+5rp9XMVDhEEOUcCs881QkT9ATaWRgdDStNHiPKeLTLdErGrGJgbo9weUQL4w2VkqmAhOERBRYigsERzzFPEzIOBbE94Z3rrN+zcfkaXz6eYu3T8Xj2Dys5VRh3lheOXRryrw0jnlFqU1uusRYxugloUY5H6DWuza6y8PSB5O8n89Xm5fTPX/5bDndB+1nnQBSaUGA2B1id4jd247dC/ubi90z5zdudHdrFX6/ef0luD/eLjfvX5ubV2Fjy4YQxsPOVuiIOfwwXhCDdNTeUOG95RZRY520jiVUWhTCSICISX+Onzx009uwZxPDdycyhPAHwp/BIb1x+ENUoxOxK2oPREIQCUEk1HYkhBFuGAptDcX64LZCU5Ppufge7+yFKRARDWIBhl4/Q4+InHMGU4mCDxIbQnSMWAWOPTUm+YJj2e7QY6+fooNZV1ZtYijvUpTZI9MYRp4QLDWVvvhXGYaYol7xgJAfy37w/sKjRynr0gf5YE7QgNJc/9mC2wVQlLcQQFVVM4ijII6COKr1jNKJHUBV1ff3m5fev74yyy0B8nE+rAiKQwQFu4IGH0ExxlRUxkarLUIsUh0Y55YYZIlCwo0EiAT15i2y0sqvrQX7/ebq23aov4K7K76+fUgTA/CZUspBWdoU9FgnaKTCekqUwqrIjiITuWNhLHGPJv2RAYf5jnbW5olBvSMp5lQBa+UFL5p+KMQEsck/DZhxr5hiVBA5ElXokQI4FNbpSHb94N7N/tiOPznYtyEyoLmA5noGSG+f5qqwt7mNVQQYLmC4gOFqm+HivPp+582PvVKhpyeuskfg+eRIEkGioUEibFHyJyPD2AVmGBdyLKtuXwnXyRFXxTER34mr69v5TbFUlRJXH+7s0i1mNiweV9IV7Ubr7CM6UDNY92Ddg3Wv9d5ussK6d2QL7JuF+fPN9syW9fd/Czd3Q1gNVW411DSwYAxyDgdnKHfcWcqMlOlF+jkW9ry/8iNBa2yb/iWs3hwc8/OPxdX0ws82ZJZtH6I10kFjpZ2SinBtpWaRxcIqeh3HwiaSvs49LuHGzjCNU0N5CyLLds7mnMmQLLmgRDuOSUBca8WIwFgGMpoeOT3yiaWdn488sdd3y9X8evd2uluM2hFadvccRkYmx1ZpHSmm1qIUxYdgVbBcajGW81H7y5KyUk80RQBxdnm3He3Bu8mB+gwJZRP9zFjBqYo4UGy5Qd4gppT3pOhx60fjj/SGYH5Yqf7Q6LwqAnC3SH+w3H/9a7i6neJBp42ElT3ITTMpeLSBGu6tKnYzx4hJdJZh6kYTTfaI62okze4X2/fTQ/SZYspm56kh6f9dwq2kWmoutEBcJd86WoX1WLqN94fl8oPEc4Tj7rPvv/rZuNV8Mb1SlFZll2VKjHGcWIU0wZjHQKX33ngtNHae+LGgvsftiKWm6aHn+NNfLtyuX729+WquZv7Bx+mC0lgpMrr/s8nBvxsh1qlVqc3V7BJ09PNi+60fEf9c5DkexrzL/Zwdg5wd5OyeMGenj+fs9nDco2SiQkwabAVBVCAlsZGIYM+Jc5F6v8EJ7V4yxcnAFSRzSsM7lFRQhiuGkpdKQoq8kmopIUhSLha8dITVOOe+gpnbZV6GcoBVdqua4gEnp50ZLAIlwvoYoxMkOCYjUmw0bEuP2Z/Sx1obNxPzYlqSGuSAIAc0dKR3nwOaRt1Kf+wM1K2cAfOu61Ym0ie0Rz4d+oRWI9TP7xMK3CJwi88J6h1zi1UPea8ZBgC9CPQi0ItALw6LXhQnOmNV9SKenlDMHovqIkIxhZ8uSCmE8zEaLiXC1OLkpQs6EkdGit48GSZPS2vqPvlZMoLoMjl4EF4ODMqdhJcTKQvvL7yEsvCey8KTO2GwMwQlx4JpJQliKFqPmBcSMzuW47F6pPsqCOu7nZlwA6DzBXV/LmrlfganrDxQG0BtALUB1MawqA154uykHIlbCOyXsNoe87wcAr+RPR3JcSyEUIQgyUOQNnImMXcmIKICCmwsfshg9qedgMvUnJFGwoLyKCiPGjjAuy+PchGt+9kFqbk0AnnMuGbCSCd8dFKMBOg9GvBS8jUT6d8nhV+Zy8kBvKG07g+bZc2S5wdrAwSWEFhCYAmB5cACS31+YJk+L74YLtKiuNeqYQgBpsgFmFYS4YqsuQqem6hpxC64dTMULIIaSwK9zx05dVzKo7CZmJvSjtAg4ISAc0xAPyvghI5W0NFqsIwhdLQaEK6ho1UlRENHq+FjGTpaQUeroaAedp09K/h3vOuMNCPOj8S6QKADgQ4EOhDoYyLQ75sybI3qZVh3ZXh6Aj27A005gpHj1jGNmeHpdXLssZAkvcPOjIZA58PkFY/CZmJeTDtCAwIdCPQxAR0I9CGQM0CgD4JAB/oF6Jfh4X3o9EuppwT0C9AvQL8A/TIw+kW1Qr886In59OyLzrEvkWrtTRKGDDaZlkCJ8wUVE4TSVPKxNE7pz6fhqpqqHWDlPxfmdpLeekNxZf11JQ2SVGJBTVpBVIwBW8SD97GwkGMhXHqszNVNHta+rZoazFuUHJR49WnNocTrqUq8ptIWv8e8EPTFr2+4u+6LD1khyAoNAeedZ4U8ZyjF3GRNUzAepaAcaY4QIobLSEYC9P6yQixfdrp7MdE0UE3pQDfOPpEL3TihG+ezRjB046waGTboxgmZeMjEPyesd5yJx61l4veCU0jEQyIeEvGQiB9WIl7IBofv7DsRT599l7ns+0T8ci4keOZD81a68cy5kWmFVBExx6Wg1mMdjCYqOuwYkWPhStiwQs1XZhkA0GcLCk6WetGjgYaDparBuYuDpYykUUekJY4+iJA8d4YIDRghqazXkIRpJ6e+neTD/G7hwru5M6v5wbtJF0O1IbOszVbJkcaO2MCsDJwHY1QkIplwzKJAgPLaNru0fG07ySZATKGrn62HvX81YdvdVF55j0QJlHxqYaylLhAnlPZSeRuJCtaNxSPpsWCkdMfgw0l21MH6aSwuFvPLRVguX5nFdEHeltjy1VGBC6NVURJlOZUipJfGYKUt9ixGwHpdrJcSkMcnMX73CN+H5d3V9Epbmwvs/ggI1PBYwe/TQNYGsjaQtYGszbCyNpKdv32yMJwXV3eXsyKpsr6DISRvso2rkl9irJRMBSYIKU6pwklCHHGbok8hx+Kb9Hm0YH6X1GnETMw3aSwv2JgAGxMGjvHuNyYgZpOXyLwWPiDkCHIs0hCZFsJJSuGAwbo4Z+XEwNr2bH/89DV95c1seVt4HlPcnXCGiCBL2SfjDVnKrrOUW1ZENitrfezWADkC5AiQI0CODIscUfR8cuRiMbt5xAG/XL6bLQfBkvAcS0Jo0cRBesqSntGorPPUOaaElJRxjMfimfTYhSffMqkGdCbmq7QnOOBNgDcZOtg7502m0qCnP5xDf576MO+6P89EtugMaz8DbNBpJCjYOg9b558X1jveOi+acYyZWADIRiAbgWwEsnFYZKM+QTa+MzeXd2m5/NXc+Kskt4svt8dsX5GBvDLfXl+Z5fLl7ey3sPoy98vB045MOeFl5NZYaXm0xDpuJIuWWqEwGcsZVFL05ufIQ/asBRBNzMvpQoRARb4g/SkBUJGDpCKFpMITGxwx3lidMB+NkCmqTZ6WT17FWIDeH0lTmio5zT0sf1nM724nh/Cm4gKaHWj2QQO8c5odaEmgJYcH+25pSVaBlmwcIQBBCQQlEJRAUA6LoDxVDVnH7C3Mn2ub95u5HQItKXK0JDdKRIq8kjqhSCVJERJJlNJThzAfS3tETHR/7nwTUu0Bdibm3LQnOOAgX5D+GigCBzlIDhJ4GuBpnh7mXfM0wLQD0z5Wpp0zjDwhWGoqffGvMgwxRb3iASGPRoLtHjduVPEwH8558T1om3Dpb3uCA869R1sOnPvgOfcqpcBnxsHAtAPTDkw7MO3Pn2mv5Fk8PdOONZyt9SIZkf5iVdi6VzFK7eZsLZqcciKt1xxbqiIWniVEO2+cS6vqWLgXOqxu6GnoS5P+AoDdisCAgHmBJVAww0d6LxTMVI5LRIPyUeC4xEaCymZBMTIyhbNK60gxtRZZpEKKT4LlUouxALo/TpGVBlMP6bAH7yYH5DMklENw5C4SbwXmQQtPjSA+ROk4ozJ45UZTsNKfRT5sEVu6kn653b79EFarNPb0doeeLSdobg7NzYcE5Labm1OuBSPCYi+N94Jjq5NXIYWQUQprLGC4JoYr7UM/mNOk57T5t4jtd6HOt5+NW80X3yaH8S5EmNMBwkgMzgUeiHHMWRUjo4grGqXXEo2mjW5/ufrDSrls1nczYvrL47/5NVzdTtDYdybHbJSpqQ0qMo8tI9oZobVA0jmJOQqOQZRZmyY8jKEy5iy9PHw1Uey3JLUTBGEgkhKcgk9HrDI0uuhJVBQxqo0HpDeNRjdswXptLs6Zv9p7+bv9Z5pr/YvJYftsOeXQjLVK/jtBQirEBLGYiIAZ94opRsVounL12I/oUFgV3NCiXO3d7I/t+JMDdhsig6raFwqqap8T6ruqqp38kXT97fuEI+maeC4V5JRDszNUWGEDEiaw9K8OEXkqqVYuRaJuNNWE/XGQLReJTg3lrcsvh34jadQRaYmjDyJYyRgiNGCEpLJ+NJWHT723eTvJh/ndwoUislrND95NGfGtyCzrsSiCGHbEBmZl4DwYoyIRyYHBLAoEKK/tsZSeT7+dZLMZIrmYfrYe9v7VhD2XpvLK++NKIKOJMNZSF4gTSnupvI1EBevG4o/3WFpbnuZ+MMn6xyws109jcbGYXy7CcvnKLKYL8rbElm86FLgwWhWdhiynUoT00histMWexQhYr4v1CnX/+5MYv3uE78Py7mqCZ402FljTHcsVatNhxzLsWK4qDdixDDuWezq8iLXWG/SXsNp0Z9j0Qn41999ez30YwuZlltu7bE3ETAXGcPo/JaiUNLnvNuBoYhBxLFW7fZ5edBhatYGiifk0ncgQeofC+UUDxz2cX/T8mEfoqjiUrooTqYeBk12eFeI7PtlFttpl7ojzBPQN0DdA3wB9Myz6pogSc/TNWc7z0/M1OMfXTCRQ7bHVHASqTxiobhNP5LQTc8YE4LWA1wJeC3gtA/NacH2vZX2Zn156X0yfLnsxv34X4moI3grJeSvRBq2pkDZI7KPH3nAfrYlWCYu1G0t2CdP+6MbSmqaqcJmYl9JMWNntpcoapDSyzhCvhIsCBUQI09zRQPFYShzxU9d9lT6rrW1fv5mwC95YYDv3m5zpfh/RnDK3m+0vyuvvgdMNTjc43YN3umk1pzur3x3KSdIguTVMMB24jcFI5TU3LBohaNDbZLg4Ued13Lj9PPvrw2rxYfZfg2AGs742Ryn8MEUFejBIa11sKLKGO8WY81aMpqV5f742K90kcxInE/NDzpQSeNfgXQ8Y1e1515g38a6/qwy41eBWg1sNbvWA3Oqzmey36cYHsjsi61Mbhzln1CievA7DZfDa4oCE1MhTzMbSi6VPn7o6JXsPkom5HueICLxp8KYHDOkWvelGXPVWX8CVBlcaXGlwpQfkSp84O/m4SbtYhMvfiosYvDNNSVTR2WTCTaSEE02d5TTSQLgJyUcZix/SozNdupnqFEwm5nucJyRwqMGhHjCoW3SoWROH+l5jwKUGlxpcanCph+NSn19nnYzarVmEbWvXtVAG7lp7HxFRCgWlHcE8CieIUQobw5UQbjQ73wdZZ10Cl4l5I82EBa42uNoDBvdQ6qwfaQ643OByg8sNLvdwXO7zWex/v5unmw8rM3hXOwaFBaVUEWwQDhxZrKin1khhHItjOSZzmCz2Hkwm5oWcJyRwrcG1HjCoh8Ji32sMuNTgUoNLDS71cFxqic51qd+H6/nXgigIrxbmj7AcvGdNMGdRcYGTK+I5ckkyiJpAhQicI4XH4pD0SGKXPtaKaJmYL9JIVuBng589YGy3SGHjJn72oeKAuw3uNrjb4G4Px90ujow8z93+sFp8/HYbPs7/sbgagqvNc662poEFY5BzODhDuePOUmakTC/STzcSn6Q/T7v8xOjjTfbTX91dpyHC5jDGb2vQTM0raUNm2bNunKYRqaIHJVdRIkMDUUI7TLixGI8F5YT0F1Diyo7kQ3s4MWifLScIJCGQHDCu2wgkM1WsnCEhCFk7sYxHKShHmiOEiOEywtlktTPreTO0e/FruEoDTA7MNaWTQ26QKQRLZhm5IJlWkiCGovWIeSExs2PpE9Kjo1FBWGXHxE0OxOcL6j51XuEEsWruC9B5QOcBnQd03oDovDNOCNvYtY9JeB/nxdmHr67mbvg7wHhQgnhtaPQ8KZNgQlnhMDPCYs8YdP+t74JUOeLqCFim5oQ0EBUwHsB4DBjaLabOURM/+0BvwNUGVxtcbXC1B+Rqy2au9q/pwSfDPHhHGwXsPPNEEayCVTYwJbXTQnqpkqGB/V8tcX1VoDIxX+R8QYGTDU72gIHd4j4w1dzJ3moNuNjgYoOLDS72cFzseh3NXhXP2S3SHyz3X+/S2U/vZoucmy2ZsYJTFXHyQSw3yBvElPKeIKaZlyPxSigV/fnZ+S5dJ/AyMZekmbBy/rbGyMi0RiitI8XUWmSRCimUDJZLLdRIkN1jlVOpvUpLRpxd3m1He/BucmA+Q0I5BHMjA5GUYJl8PWKVodFFT6KiiFFtxkKBPHVZ9WvjvoRP7+bOXO29/N3+M821/sXkcHy2nHJoRlbFqKnD2IiAnZQmYsewNMmlJ2Q0/Ed/aBb5ndRHls4iDv/p5utsMb8pNnlMDtstSS2LdGZTsM68Fj4g5AhyLNIQmRbCyeSJAtLreh6lTuLF1d3l7Gb746ev6StvZsvbIgScoB99joiyewSMcTz5HEgTjHkMVHrvTYK0xs4TP5pO17g3EKtS6uWhc/jTXy7crl+9vflqrmb+wcfpgtJYq7C4/7PJwbwbId6z2qIuq52NT8uYbfLZfv8z4LSB0wZOe+CcNj+Okyqa3aGEtMRIG0QtZ4J456OJiCsjmWM2CU5tVnhMzuzZ+H1L+E1hj8NFWjj3bBxYN7BuYN3Auj2tdRMqn6t7Z24u75Lh+tXc+Kskr4P3e6UNT5+oy7aSQUgXeTqkMUmhmUPEEBewsERjao0ZC32GUX/1Q/ywMUp1sEws7GogqRzJQDWTgkcbqOHeKmqUixGT6CzD1I2mPVKPiK62WOx+sX0/PTifKaYcliWyzkrMtA42reIoukCSdU5LFXY0mrGcutxjeqN6Fe6DQqIJNyloQ2TZxIanQgatNHNaqEgk8dg6qoJkliIylmKhHjFe5UC/XRy+fWTbt5PGeUtig1Yz0GpmeOhu3mqGVegeXdWDL6P58Ocv8z8/zjfi+bjjDn68ZxH+wyxmJk31gALkQAECBQgU4PAoQFmxaP+I1vcoMS6D8D6qgLxnXCFNicWMROOtpwjxtcRY9xJTvJHEcnayQ+kZKzyXPEakuaKEWuwEsRxxjzGl0W3TRbxCEvxw8bj4cnuwQF18p1C/r1CwlsBaAmsJrCWwlkxlLaEVSw+2hYrF613NYlpeChkVq0ux0qyurzZvN5+fs5QU30+BGCwksJDAQgILydgWkmYSO24lO5Sdipxi5K1WHid0Re68YpZix7x2QejtMlKoSbMKtrJDTWAJgSUElhBYQmAJmcASws/sClqyhGy3kVwGWENgDYE1BNYQWEOmsYaQqtsDMx0/aiwYcZHu9TezSjcKawWsFbBWwFoxsrVCqkYSKzWQXQJNxAJRRiuqKJPBKqO0jZgLYShBaMdWVU16HAk13izMnw9ijd/CzR2sG7BuwLoB6wasG2NdN+SJnaz7VcAf5ncLF4r+a6v54tOb2SK49CKtMg8+GMKeVprd00qDojQaJ7gjNFBJsdDROqEF1YSPZU8rVX972t6zpah5ZZbhAC5TK7RvJKzsxlanA3WMU8MNM4JghKLAKGqFceQmjgTYWPcGbFHakrL0WT14N9092y1ILAdxohkJweHkYVOrNQkoYEScVsx7EggdC8R7PM7kcJP9OSv+1EDehsxqnxxYa/xd5E4+366/9uNy/1NokgQR+lAi9EwroHvw9igX5pzVnBdbzBUjXHoRuLBWOBlTFEV1by2SWAW5HFHqLqNKq03gCguOlWUsBGmCoUK79FukCNtGlVVO5i61Z4WM3q6Kb84XEFYO0DWh/fWuhbASwspx+twQVg4rrKSYkmSveeCRExs4pYYhhQhlilrLR9N3vEeIs8oPLLPkTw3lrQjtPrCs0I/jjAkgsoTIEiJLiCyfJrJUVQ6iLzVo74O7WyxnXwMkLoftpUCEOUzvBCLMZ+R+Q4Q5rAgTCa8VJQ6lIFNjhxxHzhhlLTZKOgUQrw1xmZNW7aV/YmhvV3j3EWfVHfPnTQSRJ0SeEHlC5PlEOc2zI8+NZS4kBfHmAH0WiDeH6aNAvPl8nHGINwcWb2KsLWWBEI55VJFg5azVzjrqA/EaMpr1IV49ZDq64E8N4y2I7P6U5Eax5ZHhIaKEiBIiSogonyiiFGdHlEc8gqcPKHEuoJyI300o+N3D9Una8Lu3Lolq5JKUjg4eCXgk4JGAR/JEHgmt7pFsbXLZmXDLXxbzu9shuCMi547oIJlhXHhDQyTBuPSK6GCIlcLqqEbijmDUkzvy96n5EjjZwF2N9MvLy0W4TBeR5+WEpMITGxwx3lgtA4pGSON1MufeCjISzBEq+kuqqPNOrtxZqYmBtqm44PjaF/2RznB8bVVUNzi+NpNFUQpJXORNiMYGC8uCUk5oghKgGRtLBpz0h+dDv+/EgcBTPm+8kaxyqNZUCWQ0EcZa6gJxQmkvlbeRqGAdoLo2C5erVNhOsot+1k9jcbGYJ3dxuXxlpkzFtSS2HNZNLAJerpyWyXAHyUVAWmpGBeHJqHvAel2s14rc1z5j8VB2z/F9WN5draYH9Xakdl9oTeoxzyfd+ke08yLE7R+8vJ094vGAfQb2GdjnAbLPRXarglxyut2hlLxyljkkOJXeGudNsQ0qyUpYQoKKohoJffoY+I8LM9sauiGQ0MlaZ1horJUXnCAhFWKC2KRRATPuFVOFlyJH4qEI1hcNXVJ3dhoyr6/Mcvlu9kfYwWZqDkoLIsvy3s4iSQOKTiOO02qBRVpUkUGUGxKkHQnKie5xM4Gs/ciKOvmJAryhtLKsd+BO2aCV9NgwhggRMiqa1v/kKXoylhhzYCmd18Z9CZt/jd0Nu175p4fthuLKk4XMS+OYV5TaFApJjGWMXhJqlPNhLGSh7A/buQK0R4H6dNnBs+WUQ7OLCEUW0t9JKYTzMRouJcLU4gRuMZb+8aQ/OLPDdfUYiTthKJ8loyyrLYm1gVHrKI5YGYwDpkgwZRSygo/F48D9HWGT3aqUW0Kni+o2RJb1PFJ4KDXCSutIk4W2yCIVglXBcqnFWMrz+tsswEr5rsyxwZOD9BkSyiE4cheJt6Lo+SQ8NYL4EKXjjMrglTMjQXCPB40d+oSlQfyX2+3bD2G1SmMvJ4fjs+WUQzNnGHlCsNRU+uJfZRhiinrFA0IejQTNPe4oPwzbT1NSF98zGBOujGpPcPkWCh6ziAwxXnsRDFXJnkvMU5gYmFRjaaHQY/FfjRzD5sev4SqNNTl8ny+obAtKxxxj1nFvGCMmMhtQ9MIKSjhKYSPguS6eD9v1Zx7T6/n17XzCiG4gqmyMqKkNKjKPLSPaGaG1QNIVZhoFx8YSIz5heV/O9Hy5PXw1UXi3JLWs921kIJIm9zt4R6wyNLroSVQUMarNWCi/Hq13aX5hQ1gVO3Ov9l7+bv+Z5lr/YnLYPltOOTR7YxxPKEaaYMxjSBGl98nPFho7T/xYfGveH5xVaWHhQ+rqp79cuF2/envz1VzN/IOP0wWlsVZhcf9nk8N6N0LMKYKKkgVnLWYYBRSKZI4MxnNluA3SjEUR+tMDffgIT3MDH+7sbvaipC09z+XK3Kwevtv8xeQ0omtxZg97JwhxjxBG3jrlCKImSiK90cwF7cdSGdufbmBUv8qz+tOcNifZq2xzWpOcKqSwI8aoqBQqvCsWNSJK0RiIGkvSqT+tkaUO8P2Wjc0Q6aPjv5lujUCrssu29PaEamQ00g4JEUyx0cQpbjSNWnjDRoL63nr5lBSV1tx3MzGkNxVXdvOE0MRLqpyg1LioHVYBecowkQJjCSa9tkk/3HleZ63+Lay+zP32x0TR3r4Asy4Nicm8W+aVRIJJI5Q0mBlFcUzvR9PMvkeyqL6xyj2+aXv+3QozWwZsNaNO+LQ+KMN0jCQEzRnXTnOO3FicnickUes8yovFPA2792Kia0M3QsxW6pDAdSSqqGLgXMkQjdIEcxWRccqOZnNpfyRqEy6j/BFOe43oXqC71jAMn24NUys0OdEa5vbLbfHf+gvv9z/Z7xYjoFsMdIuBbjHQLablbjFFtXb3UuK1pVQYxR4lpQVGkiMdkUfORmqUUBiRZHKERckCrSXFu5dU4fmdIakTy0eHgnMYMyIpt0pz45APVgSCo/WREOYRqXby6xmtUgbQlCh7Us9UmhJxaEo0YK8ZmhK1EzdCU6KBAhyaEkFTotFiG5oSQVOi0YEamhJBU6JxQBmaEkFTovGhGpoSteNW92eqoSkRNCXqAMHQlGhoOIamROejGZoSDR7e0JToWZY6QVOiquYbmhI9CzxDUyJoSjQyTENTorMcEmhK9OyQDk2JmuRhoClRFTRDU6LnhXVoSvTszTo0JWp3Nw00JRqPbkBTou4UBZoSjVVroCnRM2hKBH1b2kY99G1pCH3o2/Kc8Q99W9qMq6Fvy2j0Avq2QN8W0APo29I609Rf3xbeRt+Wg+2v0LsFerdA7xbo3QK9W6B3C/RuOa93yz3Xt/NoB9C7hUDvlheC9dfVAnq31PacoXdLO7Ej9G4ZKMChdwv0bhkttqF3C/RuGR2ooXcL9G4ZB5Shdwv0bhkfqqF3SztudX+mGnq3QO+WDhAMvVuGhmPo3XI+mqF3y+DhDb1bnmW5E/RuqWq+oXfLs8Az9G6B3i0jwzT0bjnLIYHeLc8O6dC7pUkeBnq3VEEz9G55XliH3i3P3qxD75Z2d9RA75bx6Ab0bulOUaB3y1i1Bnq3QO+WCaIeerc0hD70bnnO+IfeLW3G1U/WuwV5I5ICcC0xFSlywJh7yRBDVCJp6Fh6t+inK5Q8Y0vmxNDfhsigPxH0J3peqIf+RM9eD6A/Udtsan/9iXQb/YkOlqFq/YnuvwQ9iqBHEfQogh5F0KNooj2K2Lk9ik4tIR0KTyLKYiBWWB9kghbVSmlupdaOJIHajQva0vp6Vv8/WF9hfYX1FdZXWF9hfR3r+ipJ0z6AP93cXe9II2gBOAjiSrD+9rpDC8A+0hTQArCEnoUWgAMFOLQAhBaAo8V2hy0Ak4OLcfQIkSgcMdFoQphO/q6UXMQirhwFuHv0Ts6wRPv+7NSw3Uxa0N0SulsOD9PQ3RK6W44DytDdErpbjg/V0N2ynYixP1MN3S2hu2UHCIbulkPDMXS3bEBy9OdzQHfLMz0P6G75HIvlobtlVfMN3S2fBZ6huyV0txwZpqG75VkOCXS3fHZIh+6WTfIw0N2yCpo57w3O0N0SulsOVxH6M+vQ3bLd/djQ3XI8ugHdLbtTFOhuOVatge6W0N1ygqiH7pYNoQ/dLZ8z/qG7ZZtx9ZN1t4TOf13zTND5rwWeCTr/PTc9gM5/bTNNvXX+o610Jvq+gapaU6Li76EfEfQjgn5E0I8I+hFNsx+R1Of2I8qsHh3KzcoUKCVRBeIZM4ZgHJySSHmKsCFrhK1b/bEna/UHqyqsqrCqwqoKqyqsqiNbVYvCu+araunGl6pr6+H3YHGFxRUWV1hcYXGdzOJapCrOXVyPLx8dCo4jJTB33GAdtEyLLPMmaaYIxFhqixY/6/a5tGn73HW4uku9QP/cQaR/RI/tF6F/bu0UD/TPbSfJCf1zBwpw6J8L/XNHi+0O++dCk9FeNrc+nASajEKT0UZuCDQZHRKUW28yirCw1PPkSSNHk+OBo1YMU5qcDcItG82Wiif0OGqyDBNDdFNxQQdd6KA7aIBDB912Ysb+/BDooAsddDtAMHTQHRqOoYPu+WiGDrqDhzd00H2Wm86gg25V8w0ddJ8FnqGDLnTQHRmmoYPuWQ4JdNB9dkiHDrpNkozQQbcKmnl/5B500IUOusNVhP7MOnTQbbevCXTQHY9uQAfd7hQFOuiOVWuggy500J0g6qGDbkPoQwfd54x/6KDbZlwNHXRHoxfQQRc66IIeQAfd1pmm3jroslZaE+0V61drSLT+AnT7g4ZE0JAIGhJBQyJoSFSvIVFu+ehQcA7p4JwwSVAIMaIDx9TzaBwTaSGldtdElz9ZE11YV2FdhXUV1lVYV2FdHdu6qnnTRn8VeKOnb/+Hca7930Q4XCyesFoQWNznwOJOpEUgRT2WgUOLQGgRCC0CoUVgpy0Coala681MoKla/03VoO9U6/stoe8U9J16GkekP1MNfaf67Ts1kfMSntBKw2kJta10y6clQHeetqNF6M5TMU7spDsP9HdoG8/Q36EanKG/w3PgO6C/w7Ps7zCRppn9mXVomnmuQ95i08xNHb1spY7+ZEq0RhXg7otQDQjVgFANCNWAUA040WpA1aga8MQy0uXxvzxposSRccZSyORi8MhTG9MvkWXKbasCcXtVgaWdBgZQEZg9EHgi3T7SrfTmV0O/j2fV72MilYBEI6gEHCTcu6wEZFxaS4NzWljFlaE4xSzcJK9UWUfCSLCdNLY/9rBGg+oqxmm61ScdShKqY6E6drC4h+rY55QtgupYqI6F6tgpohqqY9txRPoz1VAdC9WxUB07LUhDdWw7HnV/0SJUx1aME6E69lngGapjq8EZqmPPRzPuj9+G6liojh2uIvTnikN17JkOeevVsaKVjpjZ3FGNytjN16AuFupioS4W6mKhLnaidbGiUV1sdhHpsiqWUm81k4IGoSSznrOgZeSBMxNxNNse1KjFZpkVji4dQJFstm3mRI4Wxpz35l7D4cKtOt1PebjwZApoe6yoggLagRTQQrEgFAtCseCzBreGWsEBARpqBaFWcHyohlrBdvwQqBUcDKShVhBqBUcGaagVfGZJeKgVrBomQq3gs8Az1ApWgzPUCp6P5v64PKgVhFrBASsC1AoOHfvt1wqqljtpnsyN1qgc3H0RagehdhBqB6F2EGoHJ1o72Kyn5ollpEMBWm0EFt4FGpHQmshoGIkxmS5uTQxs63bSfPHgvi9xsZgX0dvm3RAKAVWuDtBziTXhJHjLYnDI8iA0cQ7bgKLAZCSOM0b91QHSXH3DATom5hzXEQ3kDnsM9yB32HPuEDGbogTmtfABIUeQY5GGyLRIviClAhBcF8GHHXY3k1zdXc5utj9++pq+8ma2vC2cggla33NElK2SllR4YoMjxhurZfIYjJDGJzeKeivG4juw/nIpFSoj38/nW5rm+3TLXxbzu9vJ4bmpuLJV0lIa7Eyyy0EyrSRBDEXrEfNC4mS7R4LtJ8x7V3xY00P12YKCTGGPeIZE4bNMFGqqBDKaCGMtdYE4obSXyttIUvDoNOhBTT0Q5U7l4+L3WViun8YixfmXi7BcvjKLCVdXtyS27DaCyLGyXDktlRNBchGQlrqoTeWWaKh1qo31Wozt2sssHsruOb4Py7ur6e33aklq23R4cdmnsuFHWcWSzPbDVI15QSFhDQlrSFjXSFgXZ86R6vmxzfUlOfnZljS9vp7fHP72Z3O1DPdvh5BGo7k0mlYEMeyIDczKwHkwRkUivKKYRYHGQoX1eOQc1xlpPcbQ9tV0HcrG8sp5khILp7gLniFpjbceM4ZYcAEpRpkfS74N95cklrk9w+eZyIkBvgMJQmeBPhN20Fmgq84Cm7phRupFSufozKOAavOMD760H18xiK8gvoL4anAFwaXqUk+5u6xz1UwqZLVBHgXsqLIKk4i8ScFVWn31rsljjTrNiuYuyepjEmwhXzMrAkUISQflsPTos0NIOqCQVGHsEEOKM5siUIuZRiYtKpRLobA3ZiTwZv0dca5y5TSNreXEsN+tMCFQhUB1UHBvFKgWu2s6CFSPqQ/ErBCzQswKMeswYtZimWg3ZC1ayKyCf3szqFhVQKzaYy9ICFUHFKoyjx0OklrKGdYqvTHcS02k95ZTP5aaU95j8XVpM63GVnJioO9IirBxFzbuDgjlLW/cdREFZhgPUnNpBPKYcc2EkU746CRs3K3tqpRSB5nnc7/l45W5nByaG0oLiEMgDgeF59bPzpjIRkc4Pf1ZwbyrjY7bSi/RBYH+2LcH5hyYc2DOgTkfCHOuO2LO/z5fAXk+OI8HyPOhOjedkufBKeudJhZhrjBSBiNbHMFruCeYhbE04umTPGdt0b6HhnJiuO9OkEChA4U+IKADhT5sBAOFDhT6OJENFDpQ6EChA4XePYWuO6TQH7r3wKIDiw4sOrDoA2HRcdss+sfFHXTuGpyz02MXe6DPh0OfUxm5p55SwSORyWhyIgXz3plotKFsLPDusXNXrnPvWRZyYnhvX4BAyQAlMyiIN+vbVeG834YqAyEohKAQgkIIOowQVKImIej21fZMJ4g2h+CNQJ/owbom3RZrJa2OCEtBIqM2BOkNQ5pxEqmU1o/lxBHWY2o/Z7VOGcOpQbuJrCCGhBhyUGhuFEMWd9AshtzXDggXIVyEcBHCxWGEi7iYJRcvvjM3l3dpYfvV3PirJLWLL7dH7dyVWRadAZcrs7uZ7x++XV4sZl+ToCCbOTBPBZo+D9Zt6TS+tMoS74gnwTLEo7SGxoiZ9A5hTyXEl7XhvW6Z35v1nJgu9CtciGAhgh0U/BtFsKLCOa/daRNEvBDxQsQLEe9AIl5yIkPapiGcJ+GsgoeYd2C+DcS8g3V0uo15MdJpgfHcO4YMMzwFvNxZEo3VLsaxwLvXmPfQbHVrPyemDX2LF+JeiHsHpQCN4l5ZIXPbpT5B5AuRL0S+EPkOJPLFsrfI985ezRyEvQNzbSDsHayf02nYy4kROsioBebOcOED5lFTY4WKybKOBd69hr2H4urQeE5MFXqVLQS8EPAOCv3NEr2y14D3oTJBtAvRLkS7EO0OJdo9caRBW3bwP2bLmZ1dJWFAvDswzwbi3cG6Od02anLJaBtJkmWwhlNJNMcYaYoI4SzA1tlz4t3D/vydms+JKUPP0oWYF2LeQeG/Wcxbodtwh+oEUS9EvRD1QtQ7lKj3RAviGpbwt7D6Mvewkfe5+DQQ7Q7Wwek22hUGKYWpUwYrihRREQmsRXDEK671SODdY7SrD7vqdmI1J6YD/QgVYluIbQcF+2axbYX2xR2oEcS0ENNCTAsx7VBiWtpDTAtbdYfpzUBUO1jXptOoliGvmEaRaiKYlNQI7YzkaXHh0sQ4lrPq+4xqVRcB2OS36PYlVohsIbIdFPCbRba0p8gW9uRCbAuxLcS2Q41t2+tGddQGwmbcITozENgO1rPpNrB1KBJDpfBeCUOYI84RJWRyiWxEXI0E3n0Gtg16JFU2mhNTgV5kCiEthLSDQn2zkLbdblMVtQjiWYhnIZ6FeHYg8SwhHcezv99cfft5Mb9+fbdYpJvcbdeA2HZIXg1mENsO1MXpNLYVRHERPfLMYIKJJtEbF2myo0RrhcdSitwjdYPRoUvatQWdmD70L2CIeiHqHZQKNOuxTHqIerMaBREwRMAQAUMEPJAIGHcdAUPDqcH6NZDTHayT02ncq6wmhhClFNNOEZNWXWMZSwaUB0fDWOLePnO6rUdl0GiqN6lChAsR7qBw3yyv20eEC52lIK6FuBbi2gHHte3twr1YFAM9ulvoLTVYdwYC28H6Np0GtkQE5BU2hjAiDMXSB0lxWlmUREhCYHtGYNtgu2gduzkxLehLrBDaQmg7KOAPaRdudUWC2BZiW4htIbYdSmzLe4ltocfUMD0aiG4H6950Gt06YYyOQWKtkTLe86ADiy5yRqnkXI4E3r2eE3S43HRmOiemCD1KFmJciHEHhf1mMS7vLcaFXlMQ5UKUC1HuUKPc9iqTM1YQuk0N0aGBEHew3k2nIa4mUQhFGAnWMa9UCEYGRbgVgkhnxgLvZ1KZXMNsTkwJepIqhLYQ2g4K90OqTK6sRxDXQlwLcS3EtQOJawnrPK6FrlPPwLOBrlODdXM6jXGtRl46L4m2zHmBXAK5i4Lp6CJFMY4F3n12nTp8Xt3b0IlpxFOIGKJfiH4HpQTNOk+xXqJf6D0FkTBEwhAJP4dIGHcfCUP3qcH6NpDjHayj02n8GwMSkacFNkqlC9sgA0FYYKelUs6IkcC7zxxvB7EZ9J/qUa4Q6UKkOyjkN8vz9hPpQg8qiG8hvoX4drDxrTwR3tZ1qp8+bCUQtr4gFMLWgXot3e6+BT8c/PBn5YeTCn54PQ0B/xr8a/Cvwb8ehn+Ni1kaEA1b+3nx3Zf+brKPWDowbWDawLQN2rRVksuhNneKl2CZT5GCIpgoia0njktNsfESBcK3tgy1YsvW5T6b12DBwIKBBQML1p8Fk21YsJ9u7q7BgIEBAwMGBqxnA4ab7U/eGrB7sgysGFgxsGJgxZ5lIPlxYWYrsGBgwcCCgQXr2YIx1IYF+3Bn90mxJMvlytysHr4DCwcWDiwcWLi+I0159sa32tbtQVpzCEWEKldESAhC3COEkU/QcgRREyWR3mjmgvZjOeMA99od41BeHcJrYvVZvco2V53IjUzLtIqIJXsjqPVYB6OJig47RqQai96gHjeNVhDXK7PcjjVhJThfUNlWwEEyw7jwhoZIgnHpFUmgJlYKq+NYEN1XNfnfp4bKwsd6uyo+ni9eXl4uwmW6iDzksFZecIKEVIgJYpOzHzDjXjHFqCBjcT5IbyZU1F8d16vgu9kf2/EnZ0zbEFl29z13kXgrMA9aeGoE8SFKxxmVwStnAON13QRc5YF9ud2+/RBWqzT2cnLAPltOOTRTrgUjwmIvjU+2G1uNLJJCyJi8BGMBzTXRLGscTL6b07gvYfOvSd/blVN/+9m4tPROz4J3IcKcDqgoWXDWYoZRQCFiZWQwnivDbZCGj0QHRG86oGscXVg/2TA5fehanDnd8MY4TqxCmmDMY6DSe2+8Fho7T/xYdKO/9UGV8vnpkcTZ5d12tJ/+cuF2/ertzVdzNfMPPk4XlMZKgdn9n01OI7oR4m7bJ2+ljO1MlhJSqZBKhVQqpFL7SqVq1V4m9bew+jL3n958uzHXM7d5t3Mynj5tqnNp08C4tJYG57SwKrn+SUzBc5NApKwjYSR+DkX9RQHq8LmeAaV9DE23iUWHkoSGLUUX5d50Alq2dNayJZOVYtJETbmQybhLySgy3iCCQwgapQB3JDjmuMcolja3SKVuwsSw3pkcs4UBGBmZwgeldaTJmltkkQrBqmCTfyigMKC2VS/1YB/SEQ/eTQ7nZ0goa9GxxywiQ4zXKdwzVEXuJObJKQlMKmAlG5dqZezQ5sev4SqNNTkgny8oqJvpMQMFdTO1kd113YwQmnhJlROUGhe1wyogTxkmUmAsx+KF91hpINplBSaH+PYFmMN/kNJgZwhyQTKtJEEMResR80JiZsfCMD6hz1Iyyfv5fJvmhvLyMwQFlQHrxApUBjwbrHdbGUBpu5UBxxkcKAOAMgAoA4AygL7KADCirdcB7Nmzwe2hzhYDWBI9oUlqSiLBpBEque7MKIpjeq9H49pI1Z9zU7+muwaepubkdCpM2CUNu6SHiHrYJd0A0bBLGnZJj5YJhGxPbdjCLulnZVZhlzTskh6TxYZd0s9ul/REdkj0WEML+yOe9/6IiVS09Lc7AipanlVFy0QqAKA3wLPSgY4rAFo5HKIyGw9lAFAGAGUAUAbQWxkAEV3bNyhtApsGNg1sWn82jbZ8HM7Foqgl2nsBdg3sGtg1sGtPcF50WyWb5TZtcGWb2aNvMAlcR6IQsoJzJUM0ShPMVUTGKTuWLB0m/TGyusnpLJUwNTF2qnuBQvkmlG8OEflQvtkA0VC+CeWbo017QflmbdhC+eazMqtQvgnlm2Oy2FC++ezKN43VjCbvWKT4zzAdk7McNGdcO805cmwkOtBje+smp7IcSSFMTgu6ESIUrUHR2jPXg1aL1ljLB9pU4CEhGQrJUEiGQjK0v2RoBRtXse8d2C6wXWC7wHb1ZbsKMjdXx1FitjY/9vapPX1pBs2VZkzlKCGBeou74CihJzhKaCJHp/TX9BaOTun56BRoQ/4EBUDQhryRoLY8lpZnhXgHBh6iO4juILqD6K6v6E7hCtHdvYwu0iJW3O/FYu7CcjlfrGsiH/128AGfooIhFrUusCKMwino48q65GhEzEaTbsb9dVCWh5Uxp4Dz6DfTjQNblV02u+xZMpUxMsUDKarsSVphefqfQy7y0XQOZ/3RHOKwpc2Z9nJiiG9LbECG9BhKAhnSCRmyKYLYeZUno8e6SrILKPFntz/zfkBJIaCEgHKYAeVR1HYoF8wNstYRhSzXCgnJkjyocYJpxAS325Q+rprSvxfUx3Tln37eGq5Pbxbmz/Rnd9fpBtY391u4uQNtBW0Fbe1CW3l72hq2raIKkYDCgsKCwnahsKyZwqbPCz997RC/Kh67W6SvLkFfQV9BX7vQ1wqHz+b1dXW4vv5jcQXqCuoK6tqBuiLdTF0Lou3i6u5yViTj1rcBqgqqCqraxcpaoal7TlUvFrObR2VLL5fvZkvQWdBZ0NlhRq+rB9xwEcWCOwz6CvrakTtcO/36UF8LGSWd3brCwDKBnoKeDklP19f66aX3xTWka1/Mr9+FCP4v6CnoaQd6qs9klzZq+vPsrw+rxYfZfwXQT9BP0M/BraMXi3BrFuHD/G7hAlRBgJ6Cnna0jp5J/W7U9N/v5umGw8qAeoJ6gnp2sYyeWVW40c/34Xr+tVg/w6uF+SMAawRqCmraiZriJmqaYtGP327DxzkkYEBFQUU7UtEzE6YbFf2YJPZx/nruw6uruYNwFLQUtLQTLT1zz9u+lv6anvbs5hJ0FHQUdHRolNHFIlz+VlwIqCeoJ6hnB+rZKPHyNt1scnJBOUE5QTm7KNut3MNzvfVl/Xr7ctd4ZduZ5dfV9dXm7eZzUFlQWVDZp9x3elJlQV1BXUFdu1XXQiintHXzo2jeUHQvOwT6fbs1ULyNSAsg5Dr47ovz/izWp+/Py3P9eROYVOTIIm6I8JRJwZSROOLgmfJhNP15RX9HWdBDcZXiYmING6sJJddlFEeFDeaSRB6w4x5jETnRVBOS4GrGcnQQ6w2n5ND+7D+SyQH0hDSg/y30vx0QWls+DEgwbGkUKgjHg0yGVhHJhMLYKi2Tww0IrolgXtpo/uHzeR/irkXE7Wzz0eRwfLac4GgrONpqgHBuerSVqECLl3jOELyfDN41r3D8zkPD89NfLtyuX729+WquZv7Bx+mpJuil+7j/syEE++jFf2/a3JMK/E8L9/y5nBY0LwjAD0jbUtK2wa7lu1M98QCHgMMaOGzcrDzfS5V+Xmy/VgJMyGoBMJ8yq6WPZ7UyuO1QMlEhlgI3KwiiAimJjUQEe06ci9T7rR+HadXK6FYcG9Bh0GHQ4ZZ1uPIBzhlCE/QT9BP0sxv9lLTOUcX3UjpwhP9zYW7TIENgRViuBCJSrb1RQshgk64ESpy3jiU9UppKrkdCFyvdH1+sqqnVMcBMjTVuKK5sZs8X5217TywlimJksdfRMalRQDpwNxJw91c1ceII6cOH9XFhbpZxvrg2djc+HL/diuxyqOdGBiIpwTIZdGKVodFFT6KiiFFt/EhQ/+T5bOO+hE/v5s5c7b383f4zzbX+xeQQfraccmi2CiGFHTFGRaUQ5jGwqBFRisZAlAE0t2vDN0Okj47/Bmx4K7K7P5O7arKyqlME7ACwA8AOdMMOKNYiO7AfvQ+AKFA5osAraZCkEgtqEoJUjAFbxIP3sZDQWNZhJnpbiIVuEvk+wM7EluEWJZdzPalmUvBoAzXcW0WNcjFiEp1lmDozFvqgx0Cq2pqy+8X2/eTgfa6YgBQAUmB4YO6CFJDMWMGpijhQbLlB3iCmCqYXMc08bNmojWaRNTl7J9vvv/41XE0yZdFIWDlcI2ZTiMq8Fj4g5AhyLNIQmRbCSUoF4Lomrlnpo9o15lj/+Olr+sqb2fK2CBAniOZzRJTdEEqTATaOeUWp1ThKjGWMXpLCf/ZhLBnlp/Y0ju2rmS45e7accmieSH1Ej2iG8oihlEd4YxxPsSDSBBd5NSq99yY5Hxo7TzwfCbb7a36iSgP3pvvqJob4boS4S7aR2md0VGcTIe8GeTfIu3WTdxNVdjCfpkifPslGc0m2iWQchISUw7AW3S5SDo4HqgMxWGPCg0uKLZJTyVVScoYdxSMBc4+VW7Tu0rD77PuvpksPtCw9IA16rDsH0qBn0uBfZ57DdGShgMgIIiOIjDrqCYAqt6Y/RYWDmoKagpp2pKa86pFMrbfuQPjzl/mfH+cbZ+TjTnQlus1At0G3Qbdr6fbsBe1eMkXwWkEyVTW9Q4lxGYT3UQXkPeMKaUosZiQabz1FiG+tIal8BNYZTgsYPDB4YPDA4A3J4NHaJ8/X3+UJdg/sHtg9sHtDsnusdpPZRgU3YALBBIIJBBM4JBNIah/GXj2NBvYO7B3YO7B3Q7J3tOEBF5XPFQDjB8YPjB8YvyEZP6Z6TfOSz7frBEmSxN5BgT/efrktsYIcrCBYwSe0gselsY/j3uTCnLOac4+tU4xw6UXgwlrhZKRMUt2XDRS4klz29btHKXnlLHNIcCq9Nc4b5DhKshKWkKCiWEuJ9SAlXltKZVawQ0lpgZHkSEfkkbORGiUURiSZHGFRskDbnUwiv5Ppnbm5vDOX4Vdz46+S3C6+3Bb/bd9+CKvV7Oa+3nc52H6BkbtIvBWYBy08LfZ+hCgdZ1SGBKmx9AvElP7tyRpBVIXK1Mrfz5VTdjdTRIEZxoPUXBqBPGZcM2GkEz46Ca15aqNZ1jzF/d4JfmUmeFZ4M2lBa8Anb9gDrQF7aQ2oFUEMJxwHZmXgPBQHBxDhFcUsCkRGgmbVH5pLm+1uJ9k40Mnw+NnOBG1eTXefaWN5QcueF7g/Yw09ewbcsyfTARZZZyVmWgfLiUPRBSIssQZjR6MZS3jZnx6IUmEdZOjW1uvT67vlan69eTPpNvQtiCzbDdZTIYNWmjktkhMjSUFVUhUksxQR6HJcG+P5xr0Ps9DbR7Z9O2mctyS2rNuOGXLUFkkaXuQmGbWIYEZZ5NRoDs1iWm4WsxniTe6oqilDvmXp3R/1VaEyphpZCflfyP9C/hfyv5D/fW75X0wrnPdYugg8XOWuzHL5bvbHdkWD9QDWA1gPYD2A9eDZrQe4av+uTLYXzD+YfzD/YP7B/D8/8191t1TlTkiwCMAiAIsALAKwCDybRYBX2DV2mhP6cGf32aEk3eXK3KwevgO+CNYKWCtgrYC14pmuFVXyB93sMIZW8LAewHrQZD1Yn9dQ9QjKcwJ+UFFQUVDRPlT07DotUFFQUVDRpiqKK5xN1kYVDWgraCtoa0Nt1VWbQNcrcQDdBN0E3Wy6krJW6lGb5R5Ak0GTQZMbh61VKwnPabz7WEkJKCkoaamSFi5f1T6oNc87AhgCDGvAEKPazchP4PDx+TMASYBkHctYNX9b8TgQgB/Ar45FxOeRMfXrBw6BcL+/HoC5Oxmoaiq4Ai8G52KApXh2cTacizGVczHSJGHbozxd/tX3LuJk3UacJCRsb09+nt+tbu9WP88XafIDv2b5Il3TffNzctjpfPOjaOsyX9x/o2iRHjbM482uyUz+i+k7vBDXvaO/+96jbuvFvZ28ivW1dtMj7/gtdtXYsLpkCtGw+8fKPyf4LedXh57q/ROVxWvGHl31+kvp5/W1ufGftoIN2/c5CdQfq8bdpeEft699OPyHsPha6TrrDVTrIvlhI6OXb++H393++2Qsfrs3HhUuuMGg9SScmeel9+mXr67m7o9lFRnXHarehT7u+frwCT7QqyqXe96AtS6aHFOPl7e3WduZ/V49uZWeVJFxdrMyqz9YPTt/1tVO2PZ/X9LZ59uru8vZzYdvy+TS7C8AYm8BSOtoeiNLu4JfrL+/fr19+c4sVxfr3nrX17NVutLHv8mJqNVpaoFelLbyfzxzMUfhDhbp1iL1urq+2rzdfJ67udamqHdjpU3zTs5a+abaGL7eDZU2vjw54/vlqvI9tTRDrdtSh5OWZvcfXcMrswzpkw+rO2vTHz18e/pWu5y11u3rwzaiZ11IerlLEMwXlYXQ/dxPgIT08h83s1XPSCiftd7tq7MuJBn+2/kyzWncH+mPl7srqi6ATuetZ+IOPYVql/LG3P21/idr3BqPXetWMDpvvp92rVsTnOIs+Isr40L5b08/2h4vol4ceAi5/YXmp6/pLnb1XK9CLC4rvZndXF4s5i4sl9lgsOHI9eBa3gJ6f7J7Cu5lXLNcxbs03/dhMoBtYfR6t5NzQg8m3EhvTfSlCdPfF3xi9m6aD96eX5ud7x7mJ2+prSna82tLZ73HxXbCPOraGL6vG6qkRm0MX+uGssHcwYy/32zI8iPlHWfHjHWnqffEyo/0PDLzL2GVzGtxYNZ9RuDNbJF/Zu1MUO+pPSaS8nPuJrswqy+vvr1fZxG+Fl8ufpF9cC3P1JmRX09e2Kv3YTm/W7iwyQe1Y+SPDF7vZk6v9nvzFU387y3v5o9eb3JQ2XtqbY56cDzkXDOe2+YqNtMWqv4luD/eLjfvX5ubV2FzfEEWk11M11n098CRW/s+xZSFH/d90P0TD9qJ/urOWu/2Kx0TW3Ihv9+89H69r2HzBD7OK955NxPWY9xLmeEdy7T+sXcUXYZsrzVOPZ69RYJ0oux7a1zsdOXXGvU7XRG2QC1NV3gt+llrIZYfS3pkI1Ax3maYZQV/rfHQNROLTN0nFvdLofjnIql4cP7Yg+pTul8/tE42VjrCb3fpbxbmz104t37Mv4Wbu/p8Ur3RWwgTK0y4i05PhhvtTFCPuiwPcU41R8oi9twh6114nXPzCh4nhWdbncgzro3GrQeo0sD56PbBTelPsRC+KioQ3SJ9NU87tDJ+l7e0eqCTxdT/WFy1eEtHxm+Bz6u1ybM+n1dz+HqaU+Gkx+/6WS36On/Mepc+jnX2mAdyZLaLxezmkeReLt/NlmcwPefMUY/pqZJ/PbaozZa3V+bbOhp/eTv7Lay+zH3WxnUxW7MnWecC0hq+nv03ky0KbG+O9m/toY7XJqzam6N9OvK4Ed4IdIOXV3OfVMZnXaJOputuYX7o5ldy+toZv2YY1158MbpFfpJhfVsB2mSJkQbR4Fpmz6vkvK34a7JwaSvam64A21l21psdy0vFHu+ZrF+Z0XTkeo5KPg6r3j8kux63N0m9+LXavtbdL7bvs8/mzBHBmTi1FDZgSTY5gefJrLZMTkzWtHdDg0xWnG3SLCDEtgidyQnxOZv1jjiviWpTkSoXpalytp8qX3cDWR7ts4HWnkKVlON6oGI3fdEu5Gb182J+/S7EvG/YaNx6lW9VsiebqX6e/fVhtfgw+698Cdx5A9a76OryeXt9e3WC4z1ntHqXW8Ut20xwsQiXvxW9ZbIXfNZ47Sfp76e4NYvwoVJhdrNxu5L6v9/NVyHZFNOS1PfGqyf1KjzoZor34Xr+tRBLeLUwf+R3njQatoU1tnSmpPkfv92Gj/MTDPzZQ9a78CqE2GaWjykML0qNfVj3Rslee4NRW6gMyEz0a1gXjNevDKgyZhvUdSXM4BFmgP61LUcv8U/IZ/udvz44F+B7u5AKjskeDb7/+tdwdYpQbDTutGusTq+qJx/LRD12SPg0D3lEeXXwkUaJ9x0W/8MsZiZd+dFAaGNuDm3kYYB68L5acH3+oFAsA7zR5Hmj7XadM5S+CLaSI3fQEfle5dfexsTadT1bd3KEld2wF7IdnwpKGKCEAUoYBqmaUJ7VNNzBdTyfuEjQ/M0UXUuztMozqpIc2SZO6DNc14RAiT0sKfsWsThi5fCszm2/o7krjmQ4OJHo3vLx4xjYRqwf9of59Ga2SBc0X6SpH3xwRm+0esO3EBWVzljsFX672pxbUf2OWhm/1i3JXOHjwynfB3e3WBa9u854WO3O08KaVjr1h9nN5VUoZFv9mbUwer3byfFABxPuv6u2sav54HXTVuyxiVmEuCstvZ39+PiorX1Lg4+HkqfLd5e/LOZ32c2YTUeu64LSU9JI3yn++7gws9X7/U/yub36nO56hs3rWgKqOXIzVT492bqQ7d3sj3D6VtoYvWZur/FjYZP0VUvY8FLJfbndvv2w6daYr3g5d8jpQvhZRbetCR90DnQOdK66T1MSRJb6NPdOZHW/5gzZ38/SyZN9NPp0gXre/ZQ8HrC3YG/B3oKPAzoHOjdEndtKv5KP89PN3XUN2uawZOW02IsJKrA2zQaeLjL/1cJDAdsKthVsK/gzoHOgc0PUuTp5qN33vme+ju5+X/M1sG8C9k3UMVfPaN9EVZVZG5JOU7d75xu1nLp9MPJ07fl5qduDxwIuCbgk4JJAGAA6Bzo3RJ3bHgZc3ae5WMxvw2L17ahv8ygceKQZp+X/4c7unOftdPcvTj/vbuarZ8g6vecJmrZnplLFTr7qKrXpwFddoWSlE2GPgGsz2fbHaWVqf656itTZvYISDV2J6q1Laa7lytwcL5d+pEa6iY1+MOfDd6eVquuZ66lY93KgoHBDVzhQh+/74VCZ3TncniIPzQnNbSJJntw/0+SbdzlZ1BmlnprXu77Jbo+d1nk5DSiDySIESCogqYCk6tdOQYsH8OifXrTPSmvAo/++/Zw/9ug3V7xpH52G97NinKM5+g3vVt5bbnMbByOlz66v5zeHv/3ZXC3D/dss8db+ZLXAo3LhQsX5Z1ehaACefrMym3O1T993t/PWE0EuFKh2KevOCcG/val2791MWO+mc+1Jal3D3+erqvfd2Zy1bv0R11z/Mj4u7iqqd+tz1fPCS5eeo9NvX51upNFk2Fo3gNGpJtB7S8yjmffXlMMP3y4vFrOvCUyVnmO/11FTRIdPo81Lm6f1NClcRSH1eyU1xVQj9Kp7cXf2auYqyqjHy6gpoEPz3NaV/cdsObOzq1nRU6eSiHq9kHq+do085eHsm/xkMzvUz/z1RFKjeLL6JdWxO31dQT2xNLCFRy+qup3pZfqa9qXGXrtql/T7zdW34ti713eLRbr/ne5XMTF9X0s97LR+dTVNcE8X0Jud2VVYNTS+PV1BTbWqQcLUuap6nl9vF9GbImUuq4YZ7ucCaiKmynGyNS+qgSnu/2rqYaiD66trjvu6hHrkQuk5BqdYgGr7vJoOXS+R0hkDONnUVJf04kSFeqRkaXOdDzrq8v2aJTbqrbqj2VI51e4wQ+7gN5JGy5Afrk8A176aymay18uolxKskeJ4dGHbPRhvvqUZZq7qtpPOpmyWA2+2+aQyFLqdt1lOdKx7jSa4TzHZ4SYmp/wSKoO8+7nrrem5Iz62s5adAZFdzc8es9als1yp0L3rVvyoFGOfNVy9KBC66Ey3iw50VYHieSie73WTD/QyBXUDdetL3eA8BNA50Lmelzg4Yw30DfStN32DHYawwxAySPfq0HMKaaKFDt1nop6V8k0SAH1k5CYn2GfrBUKDwKn6HtBjdeJPv7fU9QSR8HxXgyZZ/LVX/XyzqmdWATy7pnUPy53xZ7c/1INyZ/Sog4so7brwPtz4sCgwmPD4bnbzR7IKLiyX88WnV2YZHv02yxu1NEMzKuzhpB+TQD79fHezHujTm4X5M/3Z3XW68rXMfgs3d7WosDNGr3c7pQCqMGHY+nCFLLN31M4E9W6qdOPDkTnT5yEBeg2MV0XvUbdIX80a2HbGr3dLh9F4fsrVoRT/sbjK3lEbw9db90p3Fx2Z8d3c+Iuru8tNg6FVmrj+xqUaQ9d7MqVNlI7MdrGY3TxaEF8u382W2Ttqb44u9Wj1wBgVeD+FulbGrwe7/JrxcMqiuVWadouLvM/VaNz2b2G9j+vTS+/fpl/frIp9mO9CzKtNo3HrhT9VNHQz1c+zvz6sFh9m/5WvozxvwK7kfrEIt2YRPszvFi6cWiGbjVtP7lXsyGaqf7+br0KKbExW7GeNV0/qVfyHzRTvw/X8ayGWtM6aP0JeX5sM2yzAOz5TwuXHb7fh4/yE3Tx7yHoXXsU6b2YpOgB+nL+e+/Dqau7yaG8war3Lr+JK70/0a/LNUhxcv8i8yphdqWmyCJe/mZX70pKa7o1X75KrG7G317dX6ZlmL/iM0ep5NuUB/NoPXL/evtxFi9tw8tfV9dXm7ebzrHPT1hQtxAknZ618U20MX49raTHgHl0QNTm+tE3GYrKZ/bbokekKsB07si6DfFRN+XCsdYz41+rT4RD/uTC3t/njbZqOXG/dyQdgJyar2t2ivUnquZKlmHs07+4X2/fZZ3PmiLA61N3t2ICNm659a4n3m6wAG8T8eISOarsB12RR1VJsN1H5/Wvzxz++/+nlm99+OnZa6fo1OQwxNj8KPzifkT7xxVqrNz2Me/fH+tm49G+2arva9+sh8KRgpoutQtzbOgn6ebE1pT8+PsuStWjfIYCAAAICiHYXWTj9rpZL0qbWTlaKUzoHd5tIf7xUIvz5y/zPj/PXac1chY/h+vYq/VweW0KnJDPQM+Btwe0Ct2vEqgluV71TVtXjJuSLEHcU9u3sx/SdkqWTly6dcBD96aUDDqI/W3zPdpMTND55UqcX1gQIIo/dLTTFga3J0BTnu0NI7rdpPnb62qx9hNgXYl+IfYFEH5oU1+l9XPx1MejnL2b5ZZcEFzRqRzxWXDDFlLJKRcEZ81JazLFf/1366qxwiW7M1Wdn3JcUK3xefluuwvXnr0nG6+uZvSB/+9f/D970zec=
\ No newline at end of file
+eJztvWlzG0mSJjy/pczWbNZem624D/UnHXWZqbo4knrmw2pHFoeHhCmSoAFgdWva6r+/kTgoEgQSmciDyUyfnhIBkIjI9HzC/fEjPNwLLtSLfy5fcPniu/kNLNxqNr9efrqcf/70/QrCl+8X4OIV/J+r+H9Wf599/u4v7gUt/p7SF9/dfLn54Xo1W81g+d1ffnuh8xCvbq/8JbyZh5/g+uPr+QI+XrjFEhYf13/4NX90eQmhmOPt/PNvu/k+3r1afvuD77YTkfsXVsxPXvzzzz//zJdsX3yXZpew/BThBq4jXId8JUcvW7z45+wFydepyKHrfFeMsMhX+np+vYJ/rD6+2Q369eOPeZZvb78rhsoXpjbT/5L/fHHtLt/Orn//7i/5svSL7/75v1ZwdXPpVsXFzRb/68/DF5UHMS++C8WE16s8SR7oHXyGf3z3l7/+ZXPnV24VvvyS591+Jl5898Utv6znYS++k4RIQyKx0kRjuLA6pJCU8Ezz6GP67i9/zl7QHu6ZHbrndz+8fPPrD1Vud/Ob7//r3/7t3/71//7Xv/2//+9//2t++b+//+6AGIobeiQIoi1NLFAlnAWlVbCSKcuj4tFBDGEtCPZMHn5jaahEuWBCJcu4jNISylQSIXkttKCwgQUvpHFwyZZJ481skZfnfPH1vkhYIRKTJ/6XxoP9S5bYvlDpIaEWv9C0lSnvi84bFRWzVuoorPXOBQYpJjA0MiNczKLLqkeII9qS6E/z29XN7erH+SI/piGpzfXHMt/iZ1i9nbsI8bfF6wzKFfwV/k6ToY5KzZIEGmSkVCXJLLeM0UQdLy60eMBnXuj72fXnS9j8zXtwi/Dl7nfbBWXFwUfZdPR/uV26z/B6fnu9KtYK43/pbipYf/pXdwUFmNj+Y938KP54vij+wKpuLiPdXq+/cHch5PAjL35nTDfX4Bafd5grbO5Jafz559qiC1Ni0UuWVl+mPVOlY9r96NU1tvHRUydk8pyYrMFpICRQTwXVMgovE9p4tPHlNv45rYnGYqFJOZ1Nl/NWWq1TII6A9kYqR7Jk3NZ+02P2W2XV428/f87KbUjGe+fzCFmmIY9cfG/qkR+HwsFLa6wbPVDQmnKSNUJiwqSsE2KmLT6YJESwqBtRNz6lbmxvQTSWSVaGISiVDIdIjZYmuPyvh6iliFlCG8VYxFQOK0b5KV/Wcn45qFCQLvNpXBQpCmUcc1xJaxxoQYAxz4LliaWR+DS0N5em8Hr3JlkjIv+8unLX8eOW0cP2/eS8nPoCKtbcUfxqwpwiELjShsesPhlAsiAllZZLi/iti1964vG8h8Uf0wVvPemUITdQ6xWnXGUzbAnT+beeZGssZbTRUY3IrYlcyfeE9fKXu8ez0ynvsoL4FT5sycZUUdxAUmWIzuSJC58o85BckMJJ57IKjolHbQQDRHRdXVzynF7GmD98dTkPvy+niuPa8ilDL2Syz5LIYDU+MRkJmGSDI4RkPzlRZMK10WtP2Mr8Ps0+326+PFkMnyelMiTzQBNjkILO0C08fEe49cA0d5JTJxHJddNUx1yWlzc3kwNsuTDKcGkpcdoSaqxNmfh6TzwxAN6Al9oqMxJciv7yp+JgCOmBxnj4bnJoPUNCuzwrL8siHIz09ZZDoMdDpgcurHkGIXmvvUmCRZ99VqO80cYQSq3yziWPGQTMIDxlBqGt5dBYItlxAOF5VnjSKU5lEjILBzxEBsakcKowSny6ubz9PLt+/3WZb2dISQS2fgIs4y5czq/h7rsq+/gQQJlszH1xQeoxn616Qa8fjLx96OZw+doZAx6gj4a3Nvi+9aMb85HB9errhVt9Wa5r8WRr8+1ZOlfUF25MXn4A3y8X4fti6N2NFrZ4/eFbd/35Novh5+xFXMJiA0jbnoznh0DVdwFfGUxF0gjTezA132C61qvJBegcq9/o2UHLcLFWgtsfd1c1PaxaEhGr97Bq1w7Fb9eXGarLlctjuTxNR2AtqonGBzeR4TZbrSP8OxqhTaSBJJq0AhqZBMYTE07wJESifh221+dD8JeHs90D47oivomAjw19CJa2g2ngjoi5Qt7/3BTbH9Vnxevty7duubpYX+PV1WyVx3/8SXHlhYpUutqQxZcLRpzHKl7+vLq63Lzd/H4nCLUfM6823P5QrBhKnTXUu+Vqf7QiYmL2R9ujKh8vvtwcGPyVW0L+zfvVrff5jx6+/TaDKIjRfmzprBnyy/z126v88OeLR/PI1u4kv/zb9Wz1aAa1DZ+cMUPG1s084/3Chd/zHy93Uz2aQxdPd980V5vjjbv9x/qfYhyzdpzOG2izJvNXshTSDOLFZeYAhz/9duF2E735cxvDORaJjM5GQ4NOKTAjBbeRMm4hGUpDkNqPJBJpegtEtqr3JhaibFV2ZainMjjrWQhJGyps/iUtNkbSlIQ22faPBPW0xxRnLfdlYriu79sdVdcZnEyx5DhoQj0xBTfNqhoyS5VKk7EAl/QE3L9ODYoyT/T+61WaX3/dkKDrLI6PP/yR/30zW94UYd1iwuL9+1u/DItZpkMVwSmlp5zaEI30znkfvI7BeCU8F0rq0WjVvsCZmWeZQVw/pG+5g1eQ8i/XDyOPn/++yBxMTtW2ILHSUlWtYxSMEQAhCBf5H5McCYwQS4kYS5G17Q/hbfn0U8N5W3IrZRtJGZJYdMIonSGeSNbu2lNvQ8re4VjKWFl/3mGpejr82NbBkLu30wN6c4mVKnSTpJUWLPcRTMi/5JwKmhgE7iUZSyeLHhV6G1HVqWG8DZmVodxnb9HJ6BJ1THlDtC0yG8wE7yUV49nb2F+8o62I/9SQ3pLYyreTKUY8M47o4IpNzMYkHoo2Rdo5iGOJkfRHWrrMR00M/12KsmxNZNdU5CUQjdaca0989IyEZAWXXjo1lo0QAyHye3GG365/glURYngHy/ntIsCuXHNS0G9BYmUIV8wRm2x0XMXopSfc+eyrBgFOeQJj8VV7TGTuF7qUqKrN49vO/Nv16y8Qfv9luXn/2l2/gs3jmhzmO5FhKdGn2YEVEFWKQGWKPJC8JjhToF1mP2MJwfe3CrqvlJnYkuheoKU8yBsfiKU+ewTFVlBiWfaGgUhiEs3/4fp4Et/gcIXXxFZGl6IsWxMMKCdeZmdACZpcEAYgSC2YSjIpOpYQaI9p226LEqe2LDoVZtnCECF6kRz3VEHU2a+wzBXpAs2jyD/FWBaG6s9rblxJOzHwNxdYacs4IZ3UwSSXmAkhai/BpxiU5fl/cjRtCIZR/PsoxrF5DjseC3Ezw38u3M3NBBO9rcquDPUmOpLAGik8KZpzMeuM854zojRIO5aS9x5R/7gPSnlkb9dLrdgN/OrrO8ivZ38UXy4+mB7wWxZfaUMk6pU1kVBCTAZ8YMnaGLhXLnIT6VhyY/1h//CROCUP72Ix/+884+4ZLt/MFsvJQb4lqZV6tQ64TMkGS4XWIYHkjnkmjANFIbmRIJ0No1KztLJ2M/pkK5Lbkltp6b1j0QodQMcUSfJexaBT1IISpUgaS9y/R7QfFtbBp/YyrRvnFO92T20GE1TqLYistGke4UVzPCeSoDxRTpNwLoD0Whul/FgwTvsDeY8bkie2FnqUbLFkSlqnRLqpfcDWKdiNqng10A4/0QWKML2nxcR9mC6y3n596ZbL4tf99aQqjvf5tln0erVwYbU8vFl0coAFqgICFltSddySiiVLkowWiOIAwRtQwhDJmZdS8ZiwJVWlllTrpSX3M8mPHZTtlBs/vHiTSd/FYh5gubzrQtWCm7NtQNV8r/K2/VRbIYZN/6nS7UgHh7u7xe1Iy10QtsFQ96Ul284PbZpHtRSG3HSJajuMv6niaqFqerP7T50G/72BCu/pDhubP3q9aRN8V0rTSW3rdg9XnVKoBwt3veCKwYp1+60/8H2dvvWwzb5gq07x2/XLGNdkbHP9H+Z7o/NqnbeUoNIYxYxzHpxihFEFWbFr75VUio0knNFXKmZynVxqkvMKJ6Yf77k9hBPTj11d857+0uQFaFiAoLxPMbKihF6w5LRLkkns6Y89/Qd6Ynr9NdFYLBoCKUpnrFPcO6miC4bGIs8qIVpmt4399bHG/vzTYiuZRw/z6Xv7785Nl7RMT5beguxLVdrjsCi5wMbaktHEWXZFidJUJh5SKDrDCJE8LdYKR22J2vIptWXby6KxZJIhQjvqM8PnihhNi4OaaZRF91Ee4wYnopDMQSVXJpnsfmaFNl98vS+edeCmcBwOsNCag/1Llt6+gOkhuO1qX1uY8gEzMyoqZq3UUVjrnQsMUkyQDQ4zwm33QhYxhpO2hshPxZN+fbtcza9+3PL55ZBsT0Z0acTZgt/098SI81Nn8gps3qXyvt8h/PsPGUnf77B1pw304Qzf9xdfbo5+dVq5FAtJM0T2YI6iUQcjmXeKvMDqxx1WPz7UqJM9oiZjOGCdBeYDu84HhpgZkbZJMZaJtTdS8/wDRJI+aGMC5gMr5QPXd3M4k3dEz71ZuL/v0knrAX+F69u7nGA5dT8+0i4xtcvU0KMJxpLBNkO8KnyasMhfXN7lBct9rccjFb3W9sYpEoLyYNe2I+MU7tpPsNqmi75lAusYlfz9B7Iurutvi8tdKvBwVvH0WDtpb4cqUoDy4Fo5MlQR8N+khJb3smH6aHbtyDAXi9n1apv8ugPxy+Xb2fKueYOusun52IOcLbNv9nWdonp5M/sVVl/mcXk0D1hn5AyR9bC/upt6ecDjz2Yz3uYaX81jlkiEbR6w2gE21hILlhobjDZMWq+tSCIVkYdoN0ccjiCN1mNnyxa04sRScW2IrHTHqgRqkxeOKuBM+ZhSCopBEDoRIxDjtTHejr2eGszbkVrpHg8uonZBRMO5tzRpSnVKUTPuiubcYzlfob/9qfJw/dCDSd7N51s6Mt0jms6WU2kDGeKi9M4HxUOiRltuiaCZrThirTVj2YPao95u7NBMDNbNBVbaaVtSpZRhjGgJoH2SQhdH6wFhBgiMpkFSf9q6kaM9MWw3E1Yp3w6MkiB9EJYKJ/Nr7hhVmuV3NLjRdMTrT2+3EvyZGL7bEVo52wYBzpEQKGRYyyCD58JpnV/knwFxXhfnbQQmpwbzNmRWhnLQutDajATQwhrNiCDJRyKi0lT4sXSG79GnrCCsb77S/fzZxKB9vqBKN44467zWwoBQjKXMsymRShLpM7KVHksP6x5Zd9Mc0NRg3VRepX27eMFIdORCMMGT8SHyEIoDKDUXko6my0t/nKS11OTEYN6e4EpjhCaoqFMRJtReJs98kE6L5LlXhjLM7dTFexep84khvwsRlnevMypxEo22xGgjjci8hiWti/Nr6Gj6UD+hzj+7yGNiyG9PcKV4z4w9Mka15ToW/xoniDA8GgmEjOaEyh67NVY6I+LBnEe6AyDezxRc6alkLtHCXRU0/59RPFP5jHkPNLkEKqmR4L1HjtNFzd3EoN+JDMuruKTQQEJQnNkgKQMirc1cR1GqgWE1QKdZpaP7VCYG+7Y296yLcovGU5X2yZ/eftnXvvmiiK3CBuFTF9x4H70oWo5YF7iSPns/LgSSFETlopLWeYX76HEfPe6jP2sf/TNXII0lBcZJI4hUloE3PC8toxTLi0tA1IGJ7bZ5WmXbvLh/F+urHNameVK+LTP71UTitsxBbJonJZvm11d0B2dZfcv89ovT2mzsBE8CUT2cDfNVqmzXl/fxviad7GZ5JwSPiF/cLN/1ZnlmPBMSqAGbNJXcgCsSrUxLp5jH5tmVNsubde/sKsXWGxX3MsaCnWZWu5hfvYW02u2SF1XqRjZj/Dj7x/vV4v3sf+5OyhDVL+CXTM23u4iLFISoksfffPNiAZ9/Leh1rZ3vd9+9cQt4/6Dzsqg3/7/fzrNjASu32+kuq2y523z3HVzN/ygmhlcL9/umb/Z6h/vBnU0Hh8gi//D1Bj7MtxvkdbUt2MmDtVxpD5rGFGl0MibvkjfKUxswvF+7IK3RYptYQLOZsErTtCQ70o5rBbDZsJeY8k4GI4qT4dVY0rT94fpMAzAxQJ8ppdKD3gOVUnBnJKfWSQ3Relq0cLUkcirGUgLfI5LPYCNTg/EZIio9upolk4KnlLnEmWSWBy954sCkA+MxfVobw2fx4qmh+CwhlTYsiokwYwgYGxiVSQXFnDHUOWmUChJx3B1bPuCjTQzPzYRV6gWCoYpzbhh1hIIknhoeuXdauSBSRFx3p5/vxQ0mhufzhFS6AYlKkYxUNCQVJQlCCcIdcKVAZo8QNyDV1s9NYlgTg3MjWZVuGg2WJ2KKSJ00SROXebNRNtDMnjOnxq3+tVF9blh1aog+V064pb/HDRS4pb8qnBts6d+UzMqqJbMnSq96K5jl1erdSi+3cbms9lHxFKyAIFWINAThQlBKSiWC5HjsFJbLYrnsIMtlu1Ufzc8z5KCld9nLsyB9AqdNtNKJ5JTiYKFOsSz/FLfNiTKVuQ2r28UgTzesboJO3NDQTFDp5TbfsUFocuCN0cpaShWziYm8rHyyJC8ygyYITRCaoGdsgs5UH43lJLiIQjlLIhCqpGZJCQISnF2f9KO3vrCsYoLYJ/+te++QjM+6JPKYP6+F80pykyhw6qUj0RFhTIzZsbciYhOclnNi9zo833/9M1zeFLsppubTNxIWNoDHBvDDxXYbDeA3xb+2qtNw1AT15S7I47ywyoU2dxQy+TOCCpIIjyYGDVEzk41bNueSRYuOAjoK6CgM0FHoTHE0lpDVlGTSwL0UisUQk0tEGqdFED4LzmxoiKl0Ejr99GX+9w/zjT36sLvZ7+9u+z/cYr377Pm4D4TYwnsgljJXNNJgjgWgyjNLuXduLKdG9eg+7Pdk3++NtPd+uu10GkgKOwQOrSMmdgjstkPg2pEwlXtGnWWoVE9OhqnYBuaMm2jsgLgYjfXcJqopAw8mOi+8ZwwMB27QAUEHBB2QITogumKm4ohS6VFiUoOKMRkgMQqZqTdnngqWXPSRr3su/VnsYB+nGm4sPedVlFqmRKw0nHFPg2JeEhkp5TyFrTtXqejg1J0VksoGf0jOHC9z5oLWGVKMEQAhCBf5H5McCSx7eZQIdOZqU199UFjrM1nWr7cvi8hvAZaC0xX8bnV1uXm7+f30mG9bcsMj+PAIvmEjvesj+PBA1bZRjgeqngHzlg5U3YQxKhdRnkHQegtiNPM3jt9C4xBGTNxmXeETUSpFcBrAex8ZMVQooxOGMDCEgSEMDGGMIYTRvxJuLDuTJKckemsizehKMkQjPKdBRBtA2W0AQ7cRwHjz9dpdzcKry3n4fVA56d1+iqLRZztU4Oit9kYIqum1c2+kMS0woJgwSnkesmpTxluqmGfJaJucE5jZQFqAtABpwShowVOp4sYS5JwlxbQXhEIkxAguk1UaDBQVa8A35EA3yW7s42E4ZEA3jQs8vrW+jH9va7Tqnn8XHeFBgwMjmdDKiaCokiAZUVYwNPZo7NHYo7HvxdiXN+Y6ILE3s0U2GfPF1/tiW5cxF5mOAwHvmoP9S5bqvuDpoQW6fiKHz6KoO+V90XmjomLWSh2Ftd65wCDFogtkZEa4uLXyqoGVT4t8Wb+6Vb7JIZn60lp0S4nTWScZaxOn3HviiQHwBrzUVhlMddVMdYmDTzUDNs0+325He/BucnmtMyRU2qDYWmLBZgQHow2T1msrkkiFgY024Wbs2snag8Iq2YP5IPH4K1zfTg7SbYhsl6glDR2yI1aoN6/MNCJTB6++sWtGJfhMKpWNAMwRMCoZTmWSoMBlbx9dM3TN0DVD12wEcdh+9W9zoKlUIMpZww0XOjsezlifqFTKcUbIN+532C1jn27W1vz75abv/zy47AQOzv06frhoNEYHPFx0OIfjHmwAvZ3j/X2QPXw32dNxo4HoEcBPeGb5HXYLm/DtzPLN2BOEY6IIRzysuePDmk0kKjqpvTMhGepIzCQveq+EF9mdAjys+dg0cEfC3GZlHd7PcdDk7qL8+esPfrE7s/lwzfzBoQpWvbnG+eLRWMXN67Kg4cOx3kG4XSxnf0DZ9bGjgaLD7GIdgCqu8tFIvNpBxzxY4EFI7qQTTjFKSFKUJGsoTdIljIzWjYw254ZTC4y2waY3IFdlcdHTbmBv3fzEcf/71FU2jnNaQqUM1DivNAuKRUadZyo47bU3RGOcE+OcTxnnLGlYd7c2epSLCMFbKSP1wQgmdVQgVaZwQScuNLe9NfLrRGc0j81560AaqiQ1XggA7cBxZUP+lBgmtrE5ezI2t4C0tSQvb2YDLIakZRUSSnMVmYfAXHTeaiDJKe2izYspesWQRdVkUfLgGZinz6Ra/rSY395MjkI1FdfuIC9eiT+dWqq9naFCK5mKsottzKYgCaKTiGC9cc4okUTWezwSY2VgHg/xQjaFbGp4bKpT1dFYStEELwJRkuvoXYiOBEmyrNS632FS2wO8jrZGPnIHmTkNkFjdHeFV2kSz1i31VcekSjq11bjg5ltIg+XEcsuY9JxBMNIKwQxnIiuhhJ0l0AihEUIj1L4R6qVYqXMl21hSVlGiJbGJRBJ84tkNMJSwrHKUJ1kDbbeNmDPMdf7vw8LNVu/u/2ZI1tuUhUV4ZNwSZ4nNOFLgCkBl4+QsT1ZFJ0YSFjH66eIip1uXr/GzeY1xkZriKsucUmuiKrbtakOEYj4bV6BCRiOM4IqNZU9JppK9oftR5vv043p96ZbLt7PfYaIIb0NkZShXwRPNgaRgiaSZOFKV+TVxhEvHQPuRoJwz2Z8O32/Ce/qRvXLLqQK8obTKsA0gg/FgjY7UCUEYUzoZnl2B7DRGFkeCbTOstM1rF77A5t+ixnDz6drqTg/bDcVVqrhjiLI4bthzZjglnkabgtCWALEZ+CMBN7W9gVsfrFN67Odut23mZ3S9TPPF1bfHNt0ar1ZlV958XkTtgoiGc29p0pTqlKJm2SsPEcZy1ALj/en0svK8R7nl6UL8bDmVwTkkQpKA/HdaKxViSk5qTSj3tOgTOZYu88r0Bmdx+AiMB5NMHcpnyagMxk4z70FwHzhN1DhKgXKihHGGeCXHwrR7dCJLNwmUUcfporoNke0acLAzc9Un4/m6r67I5Kysyonrb5zJJjErCGA+6uiDSd4xYSR1KppovIkCM9mYycZMNmayMZP9VJnsTNbHZ50aCy5QKpjm0hsrXSARvAJGk4+JMRHJtgTAnG5RcvCm7gjI8ywDINGpTPal1ZSr6CylMmpBBOGaaMexDKCPROkdhiaaR2pDZFgO8EJQLAcYF8qxHOBAVkn3WNKF5QDDKAeYSMa0P/2NCVNMmA4F9T2Wd2G+FPOlXfMThvnSAUEZ86VnRkwwXTpcULeTLp189S0n/TEPrL7tt/p2UwtQrencmYH93uoBqrSXOuseGtcEKKG9Iz45nlwk2RX3SURPtYPsp0cFWBOANQFYE4A1AVgTMO6agCewUI2FpwkXRT2b8hF0hha3xljptbWBZYH6bWsAfV5dwA/Xt1fPsyQgo4jSlK05Syowl5xlTNgMKq2lSjCattOkv0DNGZmRAj+YRzpHWlgJ8ELQJwzfYCUAVgJgJQBWAmAlQBMNjpUAzwDnWAmAlQDjRjhWAjTgJ1gJMCQoYyUAVgKMDtRYCYCVAKMGeFuVAPT8SoDSUH5fRQDFWaTnpVhKLr9x/l9QL0gMmdApYlSiigTBIngaiIxaYnd7zP9j/h/z/5j/H3f+v2fj1FhuXksbsqiARSGcY9lzC0YTEzmhju0O8Tn3VIAfthn9b/RnSLl/WZb7l4KSyBjVNq+94l/jBBGGRyOBZJCNhO7TPndK1+9zf3EIQ5Nj/u0JrszBlZxFybSPVlLPTaawUSQfs9UJIXO5sRwPavprSnrY1jycJA/9uXDVDh18OT2gNxZYaQRHa0eDYySAFtZoRgTJACciKk2Fh7EAvMdagArSQmA3ElSpxnY6u9YmERGkVtxHaiErapMCDYJpMxJAy/66p1d5Tt/qMxDQZwiqNLmfFbMTUkXHITFwIb9iGdPMa+VtGgugaV8x9r9ODZZUv/jul1Xx6/ni5efPC/icL6KVhrjlruzwG+KWXX/j4Ddl4BPXRgoZk1fcaW5VYjIGmj3mbZwKg98Y/MbgNwa/Mfg91uB339apseAkMYrKIF12nKymwER0eWUqYM5zX5TfNYl+r3cqPM+db4Qqz6MkkpLAwRqarBGU88gik164sRDxHgsTzzjldQ2gzevpOZgNxYV7316IHvd14t63+sFu3PuGe9/GDHDc+4Z736aAc9z7hnvfxo1w3PvWgJ/g3rchQRn3vuHet9GBGve+tYJx3Ps2VIC3tfetQQFAeTR/+AUAZdffuAAgEzcB0mhrJbBoRNDKUsMUI5IppXD3GxYAYAEAFgBgAQAWALRpnZqfiEsshKBcFhQhglmQlEeZCbFQVFC+7XxbNM8/uwDgYlF8dfV1sIUApdvgnLeCB5UXnTVO2JQYgJVC2mzYJAljORWXyv78W7O/Bk+nRd7f+u2rHZruXkw0t9SNEDGdmhVqj+F3TKcOI52KMUyMYT41vLuOYWK6CdNNI0g3YSgeQ/FjCMVb0jAUf9Kv7i0kbxoFPU7cR+PQPKNeGJuEN4ZJQYiOTgQZCInJMKMChuYxNI+heQzNY2h+3KH5J7JSzffoybwSNU1CCqFjDAkiidynok1dtmxhG6IXDUL0v8LqyzwONkCvygL0SlkWNTdBce5CsoEayPIRlGlFqR7LTj3G+/NrtWoQW95gaftjopHK9gWIgfkX1GJgfphw7zAwD0Jq7zmEYJU30jhOs68iXWajxgc2lpZ1tMdTGs2+1W6onKYb2+xQkhjIfyH6U/cYyMd9I50Rd4VJ1+GiGjeOYLZq1ABva+OIaZitOhFi6i1XpRpFAUvvovkmEsmCKf6PUUu1N4ISlYAzLgU3QAAzVZipwkwVZqowUzXuTNWT2KjmeSrOo7dCKw7KaOGjFGB1kiCFSzS5FraSZMkuV+56NdhMVelWEpO0gOA9zXY9W/PC59UZ3dI46UE7ORJfgPL+jiuwTXZBPIDUw3cTDeR3LU7MYuH2ksGCH7eXNMV2f3ofI52Di3ROJCvVH8YxKYW7SzBePzVED2V3yUlX+5nsLjlxH41j9jYIT4ySJhs58D4kqyzlCSC7LJpriTF7jNljzB5j9hizH3fM/omsVGMBeusUVTEAT0RZy3RygqWUVZf0LoHY0GUhK0TtHz70pw/G07JgfJSaWiYZRC8SBOIlKMtCoB5IUnQsh73T3ng+LyOuF4v5f+fRN+8mx+nriGbL34WtyN/3F53siZa3TCwqsm2VKQIRiSdurTNZUzmbbSXkhewDD4kg20a2jWz7DLZ90CSXyeXNbJG11nzx9b5wWCGcwmoeUKs1B/uXLLt98dJD4i1+URxA08KUD3iRUVExa7PQhLXeucAgxQSGRmaEixtepMhJXrSxkpvnmq8jzoo/HRJNWj80lkUbLufXcPdVJZ2DABklCWhxPcqefT2vH4y8XUTm8EM7Y8ADnMfw1gbfpxR0UwqbH+erb1Hl5RqGsrVJ9zjE/QBh2WPYg9nHu1d74W/bnuznh7DWN8svga9TMiF878HXrhnxb9eXGb1rp3NWBJE7wi958c9xwe2UtnSaINzuw41/05YXbvWlP0WZH8D3y0X4vhh6nFqvoJuzVfEx7IiDDykxmiSzXkfOGNWR8RCpBKGJDOtuGPp8aP7ycLZ7IF2viyYCPjb0IbjaDqaBO+q1bTiiy3LLjw3t1dX8ev/TH93lEu7eFpdPtnGHpgNn5+NDZrQFsXWzAjH35liLqOzAumpzvJ2HLKj4y/WDwdlfNr1m2hn8r/PV3vj8LwfaZ9Qf/8Pi9qHgi5NEZdniPEqdflrMb282xzJugzNl6t9Fh+p/COq/UI5r/b9Xxvf9xZeb7zdTfb/3zCdjJYgFz6S3KuokHXFGKOAkEihOOsje7rO3EqwPK0E3sSDCq9eNPlIy95M/+7/8ZXmxmP2RL+ORBaGkRueJ2nPOV1kiEB/ZFEpqHNhed9ZbfzkLjywNJfumpq0p/2O2nPnZZcbAI/Nja3Rv2h92s/mm2pNcH269zwVamevQE1yXnTeAzdHZHj85tX5yNcqpq81VuKw/LuZXr28Xi7wOd4/327y6uMXWpz2CFNPw6e0aClbDil2LtMb2jDrTHVzwpKEwSyZ8jBi60S/7JqeF6U6CZtMvvoOZj+CG8g2N/HNLJo+edW4YETQwD8JrkBKcM4mpaDgVSRFMUNcuRG0aOJ1Y1rqFQPMa4EpUSmWfzJP0ldlWB3O79a62caI7WZMUp8SFGAnjJIREGPM+iEgZUQ4T3ZjoxkT38MpKO9UdzaslrdCGeOsKX58GbryhLJHoMqGwVNnKxX6bWxhUFvtUYiZFiZG5+xxD3I/M3XHj4tc9JrMrENh38/l2A/n9INoYI3XH0SsIZxzRi1nsrtOHqkgZcg1URk5DEMExQ4U1yhAphHj2geFe0odr6aoasaHtnBffTOd9WBSq8nS8QApKYvH0LNex+Nc4QYTh0Ugg2d6PJV7Q387V9p7gxCIH7QmuPNsqiEpYbPMcOd23xilT5nRBKkQvcrqOOR1Y7rn0zCUjlfY+SasSCZYnLqzkyOkqcTrRPqermVHfDli94dqjKemh4rNmZ1Y8mmOdTWtyV7t02t2Lw/Pwe5RYFAHz2fX2FA1gzPiUks8sOAaT/yPZnUk+CCa89aNpJNcfD67/ONdgfDv7/Ql6yVFyHwz98t5sGz82ldQpyhs5koahUd42VsgYye8BNpIo8dLJkBwTxBHIfCR4RXWgRkVqsEC9Oht51CqqIup2iDu77eUP17dX3wah5y2Au0KBbyMV3OGMm1p3vvo2Cv/LiUgZocrzKImkJHCwhiZrBOU8ssikF2M5MbTHypqGQJxYeKypuMqwzZ2hNEVCWFIhu3zOMiYsi05rqRIkxHZdbDdTj1ODdjNplWrt6BRRQlpNuYrOUipjpsOCcE2024QxENndunWPbPbE4N2GyEq1d2TcEmeJDUQpcEUXuGCkszzZjHnEeA/M5AGbnBi+m4qrND/tNFPWJCKC1Ir7SC1kdmJSoEEwbUaCbdZfg/DzE21Tg3WjjOTRDRqghRMy62UOiWVlnV+xjGnmtfI2jQXQvCc8/3VqqCy6WW2CPfPFy8+fF/A5X0Q55BgjRGbnjpLogwmMcJc005kNiwA26pFAjvZ3RE6vGbipAbxP2ZYtm6kcvNbbqsFj11pdKE957JpnKTudXkSjiRLaKaMdFc5wmvJ7O5a1wforG+22wmJiS6NbYT4uHolSGoDgtFifwu2ZibQ4yQqoN45IjJ/XXg01Wk5UeIBPc9bVE9aUFOfl1q0pqSrAE6Um1CuGpSaDafza4UqaSO2J0ZKAIKzgNdRAiCTTHSUVVc4SbhTWnlSpPdk0+a7R9OoYGN98vXZXs3Afk7uilEcdABtifSOcE3UhNNPfZLlUOlilteDERUcYBQBLosO6kNq2vyuQTI0EdyXH0vO4lWVRcxMU5y4kG7LGJJELyrSiVONqqLsa2tdpE1sG7Quw1BowkDYxQ4oTuqXRkJyxjEqTiAtmPNsI+ou1d78tZGILonuBlh5q760o+sVmQ2GcsCmxzJOkkDZYKUnAYpXadKlJGPjw45yekehGiKVHhmvtaHCMFDETazQjgiQfiYhKU+EB10HNdXB+U6CJYb1Z96RjeA6JkCTAZThrpUIswt9aE8o99ZYqjniuiWdRdpDEdpJHIbmJQfksGdU7K3PzUAZ7Vub+5TVuIZq9Fxm8t7bYXJcoc0QlqQ0RgmfmprGFKLYQxRaiw2sh2rKyaAEv4EXMBMAwyoymPrIgteXURU2AyVM9Q+mnfFlp9vl287tB9QwlZSeEW0qczsvDWJt4Zj+eeGIAvAGf71+Npb63Rx508LG+vo+Oh++mx4LqS6iMyccoskpLSRgJrNh3wbIllPl/gYQkR1Pb1eOWuYMHk92p/ot8VYUav1jMAyyX88V6V8GjTycH67bEVop1a4kFm7V1MNowab22IolU8Jpo02hK4/vD+kFh3T20D9mGf/xxi7aPbxbu7/nPbq/yGOvBfoXr2+nhvAWRldaxS6A2eeGoAs6UjymloBgEoRMxAjFeG+Plx94ff2CwTSHuSPu0YN6O1MqQLoiL0jsfFA+JmuxuWCJo1u+OWGsNFh/URnq50/r4mRXm91XhfodF/tpyeiBvLLDSvaMcBDhHQqAQHJdBBs+F0zq/yD8D4rsuvvdLpMoe10+w2ldJf1tcTg/ibcistITMWee1FgaEYiwREJRIJYn02RtVGjdT1M6MHixOPvLEisdxcXn7eXM8eBEYnBzCG8urdDM2LzS4jlwIJngyPkQegjBKay4kpYjuujp8f69X2dO6WMyuHyW2Xy7fzpbTg3l7giv1PgOjJEgfhKXCrZsnOkaVZvkdzSQG8V4X7/tnW1e0v+uxCro5SdLSitBK618kVUoZxoiWANonKTSVwQFhBjKHQZzXZS3l4d+Hj6zIlebHtrXA0/M7mwmrDNfJg7VcaQ+axhRpdDIm75I3ylMbFOK6C1yvc/EfX8ZY5NivV8VR5G8hTY+jNBNWaWM5Ypx0XCuATXQwMeWdDEaIEL0azcFn/eXpq3hNm0f14+wf71eL97P/mWDF4nlSKs/Xp8wxDAFjM9eWSQXFnDHUOWmUCpiv71BDXyzgxi3g/fx2EWCSaZ1mwiplHmCo4pwbRh2hIImnhkfunVYuiBQR13U1dBWHf/Oo/v12voIrWLnJ4fk8IZVG/KgUxSFqNCQViy1uShDugCsFMrMQjPjV1s9VMsmbR/QOruZ/FLoGXi3c7zBBx7CJrEqzNMVRgMQU3qE0SRPHgRllA2XSeUoxF1kb1bTyk8q08MPXG/gwn2Io72w5lbbQZ8mkkHHLXOJMMsuDlzxlTEsHxmPlSIdcI9PCz78W+wkmB+XzhFS6uz5QKQV3RnJqndQQradAlLYkcipwV3FtHFd3b365urmcxwmGNM4QUWkmResYBWMEQGSmLPI/JjkSGCGWEmERwzUxrA7vkl0XLaxfb1/uaudhU1z/8+rqcvN28/vJAbs1uZWi3RR7amxx3HYEE/IveVbUNDEI3EuC+fHaaD9Yn3byqU0b6W3IrNK++pJ9nWIA++qPXl7jffVB+mioDV4zYYiWTChvwDEjIigtFO6rx331A91Xf8aiaCyXyEmy2ruUWJZItEoSaywI4NlOqrjbP04e7x93yyWslt/DYjFffIJ/uHxH8H9urgexdZy8+OdGR4rDOvLEtfejHg8qiONX1lgzZo1ImOJCJy59/um98CBNsJF5bTnfPmp69FHHefi0XC1uw+p2AWxwz1qWPuujF9/Pw+YlD/vQpTV+2ipQrsFaHwhhzLGYFZ3zgQbvvOWMnVzYD65qcA+7fGEfu/anX9gHrqzxo2aae655sJqmEFginFEvMvWhydngzOZRc1P6qIeqwdnJB/1U+puceMztam/hdWCZxwUBnhjKM6FhwVjGgvMK6DY3yg+s533O+fQPl5U1dqHJUEelZkkCDTJSqlKRKMi3ShMdTSG76Ovkxuz67j/WzY/ijyfY7uKENEqbTktnkiSeSJe5cmZSShiXlS6FKEwcTe25FL1Bk+9L6/7D+NGF/O/0muRWE8o2DMSPMKGDWr8Xw9g08lHVnQmZ33qRmPYRgnSBi6Sz2QjeeKljOEpwSxb/05tGytE25pWGtvG52caJ9OPrzzRiP76e+/ER4YsMQbQqAinS4EEkDklYpYLmfCw7sNgT13TsUlzrHz/8kb/yZra8KWw9TE/hniOi0j0qUlPLJIOYmREE4iUoy0KgHkhSlCGG6zooB0vHtpNcLOb/nUffvJscduuIptSrppGKRBxz0UYFjmcfO2gqqeIgtBnLvqr+MPvo4ImSQ1Y2P36Gy5sJIvh8QZXup4rKCOG5ChxMEtkb5SYT4KyKNSfKow6urYPL91bsXkwOvpXlUrprKr+33osMTS0F1ypltsB4cFqBkKOJafaofQ9SujzY5zzJTrFsner87R+KTP9y+/nkINxMWKX7pjRXkXkIGeDOW535r1M6UwzLeNwenT4CXPcXj5BldG87yaHjrJY/Lea3N9NDdkNxlZ5pZ3koElDKe+qIkVL6wJjS+T0LWo4lDNyjzn681+16Ob+Ewo35vIDl8pVb3H891czU2XIq1dRJCpMYlZIpQp1KOgARTnlCqUt+LP0HekTzwf0Ur134Ah/ff3ELiK/nVzfFI4L4ZtuArcjwrf9iephuJq3S3kdOA9OcUQ0xMG8cTyFFlgwngluHyG5BT989q7fz4C7vvfzNFwGoiWL6XDmVoVk7aSyHzKJZMMEIZyLxRgC3PFrGxtLJq8fil/3dQC9/KYznH7Pstk/3rNGKUimv0wrOZiockjZU2PxLKg2JNCWhjYKxdILpMZN3sGLoQZpquoCtJ5xt2ZY+XLZ1tPhit69Pf5rfrm5uVz/OF1dudb+8iz+T8q5+Nrb1scPv+Wxs62GbX5HJPrax7RhoOxQLTcrpJJnzVlqtUyCOgPZGKkf05njlPzcnEMx3K/tAdeDOvc0ewJW7jrtIJGzfD6FgsLReUHtfVGQl4oQHo3wgPv+jGSkqJpMdiwPSYy39AWX/ECLF4Yh38EBLWCKc0ginDskBFRwCU8pGoYgSXCktFS36+Y0EuLIn3P51ckjMCvn916s0vy7Gu7qZX2dxPIJjJSi6KFLGn3HMcSWtcaAFAcayf2F5YmM5Jkn1p0IfnxFxwspODby1BbR1KoorPOVUnBhr52fIohdB8YfoYqCLMRQXgx53MQ7gtUOJ+MRAeJ6VhHSKU5lEZtMMPEQGxqTt3qOiuKGOd/EeFn+gazEss8ifNMiGrgW6FucCF12L4bsWmjCnCASutOExW3QGkCxISaXlciwdOPvbzSmO1accNrETRG4N6eycisN9lSoPhB4FehToUbTjUajHPZz2U+W7pbjz69/lp/orfNje4oC8C4HeBXoXQ7GMrXkXHBhhnFvCgtYGhGGScymjtlJbMprSkx6jxfs7RLKO+7Bws9XyW3Vm8Vjy8LOw/sX00HuGiNBDRg/5GXjIgVqf6RBXmS9mnarzbz3JtDFrVBsd1SOBYn/qVB6orqxIGSeG4gaS2nrOVp/2nKsOil40etHoRbeUl6vuRb+MxZ6fV5fz8PsSfedB2Uz0nYdhJ9F3HizZQ98ZfWf0nZ8XHtvznbUOXPhEmYfkghROOseljYlHbQQbyxmlParTEo/wIFGcGnbrymeXYa7nJx8YCr1j9I7RO24pxyzqVa0+6LA8IB8Zq1czTeuxXTn6yFi9iv7F4JHYnn8BJjiWRHYnTLYsMhIwyQZHCAkmJTqWjXE9qlB7QkscNrVTQ/B5Utrl5Hj9atZDA6LHgR4HehzteBy8YheOlzc3Q3AsSk+vFPmGudHCakksD9IBUUp5FoS2LCiPRhH5WWn3M13Gz/IKuJyFzeMuT6WFrJcZpKAzGStUkiPc+qIZpZOcurG4CazHg+KObcpfa6WJobRcGFuqpWp0I8jfQ0aFjAoZVUsx3BOnnq6lU3pQ3tPTrPxJCc+ayHGTVPW4eRYPnDwVemj3wMmQCAgnJBQFTk6RSIW0QjkdVMzMDQ+crIvgI63cjz+fPH/+albPr9znyaG5obSw8T02vh8eprtofM8tAZmY054Gmxm5FzrlN1aAIZoSPG6nNpofn/r1MOL+MsZZ8b38vDaf3OOLk4N0I2GVtsk3BX69DZ5Z6qjyGdAmKMtIVFqIsbSf6RHX+/xw/zzRvffLKcO6iazKUG24EkQkaxVIpZyhKkRpfIj5QyoCHmhZF9X6oE29i61c5Ksq4iQXi3mA5XJ+4JPpng3RquxKD1FTgXppmHOGOCIlkSQSzjw1HjSPqMtrR0MOC+v+qR5TVt91xVPeBo8nm4jVNEVQ4DP3IIwDJUQbH+1YjmrtD7tqvxD//iTv57eLAIUHtJrvvZsyoFuRWel2HOKD11RYC16yQFIApjzzjtLAk3OI8rooPyisO9v64e+zzx83yZePr2+Xq/nV5s2kQd6CyMowTiJXGqyxIlhlEtMsUh+4AS08J2ws7Vp6xPjB89H3HtgWabtHtn07aZy3JLbdBjVbpZKhPHiO5Q1Y3oDlDe2UN5iTByt880WK19uXb91ydbHW41dXs9VqHWPa+2QIhQ+qrO4hOhsNDTqlwIwU3EbKuIVkMosMUo+lvrTHsofDIZoz0TMxO9uq7PBE3962veGJvnW3a5YIpwy3MWOTKZYcB02oJ0bwJLKqXtf9KI1nptfD7eS2AxSt6h5vB/jhj/zvm9nypqBTxYTF+/e3fhkWM1/5lHRuhVYyeeBORm+4MyElylLwgvLgwkiw2WP6txpL332wfT857XqumMqwPJFy4B7TX1gM3G8xsJSecmpDNNI754tcQQzGq+wNCyX1WBhuj6HTMt9kbTG/6ZxXkPIv188ij5//vgifTA7RLUhsGzClxf1Uipie5SvuYqni0836O++/LldwhQFVDKgOJaCqjgdUj4G2Q7FoCMRI4a1T3DupoguGxmQzWCBaZrdRVXZWVHVXsbQtZ/p5dXW5ebv5/RAiqrY0opqUIYlFJ4zSjJBEshXWvqiLTSHIsbTJtP1FVEvtyGHkFP2vvr1Fy1tfYhg97bNTE0ZPMXraGm4lRk+fX/Q0aB2jYIwACEG4yP+Y5EjIDMJSMprNMz2yhoPbUc/gmxMDeWtyKy1eFc4ryU2iwKmXjkRHhDExsgx1EbGwr3auoLxC7VXhNIdF/oPl/dc/w+XNBOlxM2GVbpvRXEXmITAXnbcaSHJKu2gt49Er3HpQG9fmtLDezeerzctv0y1/Wsxvp9dIq6m4SnNiHAS4TEkCheC4DDJ4LpzW+UX+ifnd2gzl4BaRI1XFP8Eq/9XtVR4C4mb0vy0uJwfwVmSGmV/M/A4I05j5HTaCMfP7hJnfXUrsjMzvCQ8Vs76Y9cWsb9tZX33iMORqaxUzvsMzuNoOw+JixhczvrhfZsxgxozvQHGLGd82M74mSSstWO4jmJB/yTkVmYdD4F6Opg1ojxnfwy136nHNiQG8FZlhphczvcOEN2Z6nw+uMdOLmd6RYhszvW0xE8z0DhflmOnFTO/zRjBmep8y08vayvRilhezvJjl7XRvL20jy/tuuRpaotdgoveFJsMwuJjoxUTvs6eUmOjFRO/zwy0meltM9GIKDFNgmAJDXGMKDFNgk8U2psDO8PUwBfbMUI4pMEyBPW8EYwrsKVNgsq0U2F5oHbNgmAXDLFjbWTBKTqTB9s+gv/hyc2DpruPzX27er26934Xr794OJzUmy1JjeT0x4plxRAcXglLGJB5okFG7vKzGEn/VtDdDbPbjNi2CaWIWuktRYjINd00OA+WYTBsobjGZ1mIyTTFHbLLRcRWjl55w54P2QYBTnsBYanD6c/i1rW4cN97sdubfrl9/gfD7L8ttfN1dv4LN45qc6u1EhmWroEgcZ3Ydjdaca0989IyEZAWXXjolcRV0GPb67fonWBXxm3ewnN8uAuyc2ElhvgWJ7cJevELYqzXKjqEwDIVhKKz9UJjuIBSWX+5ymvPF8wqIeQqRC4gqRaAyRR5IZq2cKdBOOzcW31/11xTM7kurdUhNzIJ3L1AMjmFwbBhYx+DYQHGLwTEMjg03LIDBMQyO4SrA4NgTBscE7Sg4dpy4Y4gMQ2QYInse1WL55d+uZ6vnFRwj3vhALPWJB8KtJ5YZooFIYhLN/43EQvcYHGunxOkwmCZmu7sUJQbEMCA2DJRjQGyguMWAGAbEhhsKwIAYBsRwFWBAbIzVYocoO4bCMBSGobD2Q2G8jVDYmi1mRXXhwu/5j5e7hTy4YJgqC4YxoJx4mc2xEjRTWmEAgtQi40kmRUdzDlSPwbD9xkCtwmlilrtbYWJADHuRDgPnGBAbKG4xINZiQIwEEYTwQUYnBHNJeCApKq84k4R4hdisqVOlqGIeN3PubOJUO5E2EBUGeTHI+6zAjkHe574KMMj7lEFe3VaQt5IjimFeDPNimLftMG8RXm0e5X3jbv+x/mcIkVxKy0K5IkQvst/vqYJYdMe3zJkkreZR5J9iJDaYStWfFd5fV7VBMzUj3FhgGJN9ITEmOwQsY0x2oLjFmGyLMVk8haFtnYqnMJxSrO2ewoAnnLWdVcATzmro5s5OOEsyJBa9ohKsitwpFiHpIAXXEE1wiOu6uN6PEB50Tr7cbN++34QIl9OD9LlywrNyBpohwLNyWjsrp6SU0gGXqQhDUqF1SCC5Y54J40BRSKivayNcn/u8NqNPFudtya0M7U5IJ3UwySVmQojaS/ApBmV5/p9Ev7F23UOt/OXmObzZO3PxPxfuZookvFXZlaE+O5jKmkgoIYYzEliyNgbulYvcRDqWSF6POv5w6ux41v5iMf/vPOOHXTLyzWwxPYbektTKkG6iIwlskWclLjudzDqTaXsGvdIgrUek19Xv+wWIp57Z7mFduNWXV1/fQX49+6P4cvHB5CDftvh2tT7EtlXrc5fExHoerOfBep7Wt23SVgp67lycv13P0gzixaULcPjT4Wzh1GV1P5bwIlPnRBKUZ4TRJFy+eum1Nkr5sUTWKBW92epM78+qYzkDXBMz4z1KFiuJsJJoGKDHSqKB4hYriVqsJMJ8Nearx5OvxvwG5jcGg3DMbzxX1GN+A/Mb00A65jcGmd8QreU3aodgMA+CeRDMg7S+r/lE98rHemOrrDalXsWbrJeywQywXA4hucHKkhtKUGmMYsY5D04xwqgCyZn2Xkml2EjMNPb378iscns/4HW9WriwWh4OeJ3IGLioMj9kRFPBgAdtiKFgrM2qPajxxAP6S7LJ/d6eNTXXxJDcVFx3BS8VmtvUGhppHtI8pHmt0zxdl+bdyetlWl9t8W5X07+mdE9P9Ur710yE6vUVkUGqV071NtaQVjjgtvZSQ4uIFhEtYusWUZ1tEY/s5nx6g4ixj9kLjQZxEAZx8nv3aY/BD9y9/yS797ekjzQifQdHR86HnA85X9ucr7AqrXC+uzQ1Mr/hGFxkfkNnfhPpadMr88OuNufxv/a62mxZoGqRBT6YA7kgckHkgq3H/0xDLngXp98uU0yJDcT8YkpsGDxwaxdZC3bx0VpDm4g2EW3icG3iN9uHNhFtItrELm3ibk2hTUSbiDax9ZzB+XUiJ/dOP71t5GgbX/QVrEXbeG7eYCLdM4TtLW2A7TOeQfuMxK2NziilwWfWApyF6IPIjMZYrqUdC+x7Q/3hTU+P+Q0CvWSPWHVx7dwd1qxA6sQaQrcH3R50e1p3e0gDt+doC52nd3iwUAr7YQ7f4ZlI4zTdY50Udk47p0qqrc5p27i3aEgEj8yAFBApIFLA1imgbUYBT7SUQy44BBOskAsOnAtOpLUoJbS/6Dc2Fx1ic1HGm9PD0qmQJyJPRJ44oE4a6yVbbHh5B8v57SLARhBIDYdgkZEaDp0aEmFFoCEarTnXnvjoGQnJCi69dEqOBIh9UsM6fSGOaK+JobkFibXUSePg6Mj5kPMh52s9Nli7bfy9VVroq41yKfyy9R+93tzKEKifQOr3oq9CRKR+51K/aBJwFYggnEmvoohcZSYYmXYaBB9NKw3ZI/U73RK9ohKbGKjbE1wZ4pWzzmstDAjFWCIgKJFKEpl9HqF0Ggni+9qplwVtS3nNh8w0Pv64xdvH4nFsHtZyqjBvLK8ydFsuonZBRMO5zzRdU6pTippxZ0IErPWuje7DbumDSd7N56vNy+meJn62nO6c9rNOAKlkENB3R98dffe2ffdC/5b57iXnN27W7lYr/Hb9+guE339Zbt6/dtevYKPLhuDG487W2QuDbvzA3XjFHLHJRsdVjF56wp0P2geRUekJwEiASFmPxT37NL0NfTYxfHciQ3R/0P0ZHNIbuz/MNDoRu+LqQU8IPSH0hNr2hCihDV2hraJYH9xWrNSsei6++Tv33BT0iCZlgNEjOtcjCiE4yjWBCJo6xmxK1ICkkTuXueBYtjv02Oun6GDWlVabGMq7FGXpkWmCksgY1ZbrWPxrnCDC8GgkEBLHsh+8x+3g+ynrgw/ywZy4Ag7m+s8W3M6B4rIFB6rqMkM/Cv0o9KNazyid2AFUdfn+dv0yxteXbrkNgHyYD8uDkuhB4a6gwXtQQgiTjPPJW0+ISNyCkNIzRzwzRIWRAJH2ld3MSvFg5ddWg/12ffl1O9Q/INwWX98+pIkB+EwplUFZ++z0+KB44spHzoyhpsiOEpdkEDAWv8f0GAzYz3e0Y5snBvWOpFi2FKg1Ucmi6YchQjGf+SlQIaMRRnDF9EiWQo8hgH1hnfZk1w/u7ez37fiTg30bIsMwF4a5ngHS2w9zVdjb3IYVwQgXRrgwwtV2hEvK6vudNz/ulQo9feCKvPjnn7uWjnX2auzdCuoW1C2oW1rvn6Ur6JYj2wzfLNzf32zPxVh//1e4vh2CxtFloXIjpdBAQlCc2SApAyKtNYIpSjWwsWxe56Q/on+wJeMR0Ly+Xa7mV7u30639bUdo5WXtIMC5jHQKwXEZZPBcOK3zi/xzLKH4/vasK17jkf0Eqzd7Zwb9bXE5PZi3IbPSXiTWEguWGhuMNkxar61IIhXmP9o0ltCk7rEVyUFp1eMAU0N5CyIrVeWUOJ2JrbE2ccq9J54YAG/AS23VWM6g7E+Vi4NMNHsAafb5djvag3eTg/QZEipNpgrnleQmUeDUS0eiI8KYGFnRRzSORU33h2C5Xw38UOW8KhzwsMh/sLz/+me4vJniYZKNhFV6WJYVWsnkgTsZvSl2jKZEWQpeUB6QZNfHdbUgze6D7fvpIfpMMZVmQLlj+f9Dxq3mVluprCLScGaTN9SOpaNzf1g+fFhzWcBx97tvH/3owmq+mF66v1XZ1cmD1qbuu8QE/7TYfut7Ij8V8d2HYZvl/VyFwFwF5iqeMFdhj+cq7uG4R8kkQ4R21CtGuCJGU6cJo1GyEBKPcYMT3r1kilMnK0jm1ArvUFJgnDSCZOvMIDPOvLSMUiwvLgFRByZqnKFcQc3tAnFDORyltEO2kUAzWRGOKuBM+ZhSCopBEDoRI8biZfYZDDz4WGvjZmLkpSWplZ7MN400JuOYxhw00jGN+dy8UkxjngHzrtOYE+lB12McEXvQVQskNu1Bx6senFqT/mBYBcMqGFbBsMqwwiqq0nmzp7XnwAMpIRGSMu0OoLVSIabkpNaEck8zO1F8JHRE9biNX5+W1tS5yFkyQlb9QiOtHhqUG9BqLAPsTyljGWC/ZYCZTjgaHCOZWAhrNCOCJB+JiEpT4cdy5ESP+riCsL7pmQlvqj9fUHdnjVXev3pKy2NoA0MbGNrA0MawQhu6SpuBkiDuRbaA96qnhxDjKN0ILIiL0ruiw1tI1GjLLRHUgnXEWmvGkkHvs1ikfKFVgMzESElzgWGJCJaIDB3knZeI4OYy3Fw2xs1lxJuUbOZr1CmgQWuXaBBUu+wQMEbHEr7usfSpvC7zyKMqNNQP13/MFvProkhhcgBvSWq4jRK3UQ4N2l1so8QsDWZpnneWBjcC40bgwWC7k43AVQ5OrhmLwaQOJnUwqYNJnYEldU4cMl2m5AqB/QSr15urH0RCp/QY6SCpUsowRrQE0D5JoakMDggzQECMhLb0mNA5Edo6AZeJEZVmwsJEDiZyBg7w7hM5IWU17YSE7HNqp0ikQlqhnA4qpqDVWIDenwI/WFFfEhjI8+ev5of1yn2eHMAbSuvOuRTNnMs924COJTqW6FiiYzkwx9Ke71jea5CwVaOfYd0hYeAOpgmMkiB9EJYKJ/Nr7hhVmuV3NLix7Irss2KwDqU8CpuJ0ZR2hIYOJzqcYwI6Vg4OwuHEysH+Kge3DXhYM3fziIVAtxPdTnQ70e0cmNtpWnE7H/Tle3qv0+CBlS9YjyfTIxkfIhmfSKdX2yPQsdVrfZx33eo1cWujy8ZNg89UETgLsQgpgjKWa4m7emr7nKYaddp7UP+5cDeT9Dobiqv0NFajHdFcU8Vd9ghMSkA9kRBjKhjvWLhKjxrcNnlY97nn1GDeouRw5xruXBsavLvYuRalINnnZuswhZBJKy6JlYQQ5qRODLFcE8uifO/K7sVEw981pYN7LnHP5ZDQi50xB82csTNmVSbRuDMmp61lIO9FUTABiQlITEBiAnJYCUilGxwAcl95Pn3WsbQ75kT4iCVISMZESEqamjidDaRJRASpFfeRWnCWmRRoEEyPxUXk/R1pU+U5vXJLQECfLSg83OZFj3jGs22qwbmLs22c5skmYjVNERRk4i4I40AJ0cZHi7Hndmo/tpO8n98uArydB7ea772bdM6wDZmV6myTeTQNzIPwGqQE50xiKqtwKpIiiPLaOvtglnc7ycY/zJ5rnO3CsZtXE9bdTeVVzkiMIplTK+c9D8CCMjZqE31iBnwYCyPpsfrj4AaRh5PsIgfrp7G4WMw/L2C5fOUW0wV5W2Ir3yIJUjlrilJsL7lWkF86R431NIqUEOt1sX4w/nh8Ehd3j/AdLG8vp1cB0lxgdw1LSMOTzb5Ng0kbTNpg0gaTNsNK2mhx/q6xQnFeXN5+nhU5lfUdDCF3U3p6e+YlzmstDAjFWNFTjWYJSSJ99j6VHgs36bMRZnkx8WnETIybNJYXdifB7iQDx3j3GyKJ8JklimhVBEICI0EkDklYpYLmHNth1q5qPRwYWOue7Y8f/shfeTNb3hTMY4pF2WeICLOUfUa8MUvZdZZyGxXRzapaH9MaDI5gcASDIxgcGVZwxPDzgyMXi9n1oxjwy+Xb2XIQURJZFiVhvGg2oiMXeZ3xZHyIPARhlNZcSEpHwkz67OZa3lmgBnQmxlXaExzGTTBuMnSwYyOp5+ZzYh+pM2DedR8pRqVIRioakoqSBKEE4Q64UiAlMWPhLz1GVsrPOd88sTVBzx9ezf+A7AnAq4X7HSZ42FkTWeE++D5RjdvOKkK6+T541SxiWMLsMXSIoUMMHWLocFihQ3sidPjWXX++zWbvZ3cdL7PcLr7cHD1RfbbMwvj6+tItly9vZr/C6ss8DuLM4dJSK2GCijpJ77z2Mnnmg3RaJM+9MpSN5QARJXvjK3o/FtYCiCbGZLoQIQYWMbA4cNh3H1hUmqvIPATmovM2Yz45pV20mWnFzCrGAvT+nNODiY/TPtfyp8X89mZyCG8qLgyaY9B80ABvKWi+CceICuGYxswIAzMYmMHADAZmhhWYOVXTVUftLdzf1zrvV3czhHBMaU2XdEYlTqLRNqPIZEkxlljSOvJAqBxLkzdKn7Co62zsTI3LtCY4jL3g6YBDBzsWdaF/OgGYd13UhRFGjDCONcIoBSWRMaot17H41zhBhOHRSCAkkpFgu0emUoVhPpzz4pvTNuFSr/YEV6f060z+jxFGjDBihBEjjM8/wlhJoz59hDHLryzEyFlGjfbRSuq5SVRFkXwM0YWQddBYGDrv72CUKo0s89CfXf4LrFRvRWBI019QObAYOhL1bon65PccKTx8c3AAx7OumnAUNShA41lXjQSF53vj+d4DAnLL53snGRKLXlEJVkXuFIuQdJCCa4gmjCZP359G3u/vd5AafrnZvn0Pq1Uee3qbgc6WE3amxc60QwJy251pubRKMOVp1C5GJam3mVVopXTSyjuPGK6J4UrbDvfmdPk5bf4tglU73/3rjy6s5ouvk8N4FyIs7SEkWIIQQAJzQQRvUhKcSMOTjlYT7CFUdw2Y/QKh0qTvZsT8l8c/+Rkubyao7DuTY6mXabkHk0SkXjAbnLJWER2CppJAEOhl1o577/tQJeosv9x/NVHstyS1EwFCYJozmp3PwLxxPIUUWTKcCG5dRKQ39UY30YK1bS4OCb689/I3/995rvUHk8P22XIqQzO1JvN3RpQ2RCjmKVNAhYxGGMHVeJqw9Ke394VVgYYW1WpvZ79vx58csNsQGZ6j8sI8scY+lnmb7s6eBueoHEdzcFx55YEoByL/ayGRyDW3JmQGHsaSce8x9tJybdzUUN66/MrQ7zRPNhGraYqgwGshCONACdHGx9GUED71VrbtJO/nt4sABaNczffeTRnxrcislLEYRgTN3iUIr0FKcM4kpjKBoSIpgiivzVgOHqq6nWRTA/56fh1n62HvXk2YuTSVVzkfN4o4y5TzngdgQRkbtYk+MQM+jIWP97iZ7XB678Ek6x8zWK6fxuJiMf+8gOXylVtMF+Rtia28xwRI5awpGkt4ybWC/NI5aqynUaSxnCfeI9YrFPDfn8TF3SN8B8vbywkekNVYYE03alYoMseNmrhRs6o0cKMmbtTsqUe/aK0V3E+w2mxK37S+fDWPX1/PIwxhzyYv27LpXaLCgBA0/59RXGue6bsHmlwClcZSrdhnk/5916oNFE2M03QiQ2wVh236B457bNP//CKP2ESr3yZa2wbmutWmQkeMBrqt6Lai24pu67Dc1oIdl7mtZ5GGp/dTaZmfOhGCLrCX86DpS1sEfRtwZ80OxT0yAbIWZC3IWpC1DIy10PqsZX2ZH1/GWEyfL3sxv3oLaTUEtsLK2EryYC1X2oOmMUUanYzJu+SN8tSGsUTVRY8l6QdrOarCZWIspZmwSrcTGe+IscQHx6JRISkChDFhZeDA6VhKu1h/wD5hPe4/q61uX7+ZMAVvLLAd/WZn0u8jK+cQ7Rb3jfL6e0i6kXQj6R486ebVSHfp+u5QTpqDlt4JJSxIn8BpE610IjmlONhtElCdqG85rtx+nP3j/WrxfvY/g4gMlnJtSbL74YrKW3DEWltspPBOBiNEiF6NpSdzj1xbHNwccBInE+MhZ0oJ2fUL1uPuN2TXT8WuqWzCrr8tGaTVSKuRViOtHhCtPjuS/Uu+8YFUhZdyaheolII7IzPrcFJDtJ4CUdqSyKkYSw+KPjl19ZDsHUgmRj3OERGyaWTTA4Z0i2y6Uax6u16QSiOVRiqNVHpAVPrEUZnHVdrFAj7/WlzE4Mk0Z8mk4LMKd4kzySwPXvLEgUkHmaOMhIf0SaYPbiI5BZOJcY/zhISEGgn1gEHdIqEWTQj13YpBSo2UGik1UurhUOrz66yzUrtxC9i2tFwLZeDUOsZEmDEEjA2MyqSCYs4Y6pw0SgU5EkYyzDrrA3CZGBtpJiyk2ki1BwzuodRZP1o5SLmRciPlRso9HMp9fhT732/n+eZh5QZPtRMYqjjnhlFHKEjiqeGRe6eVCyKN5Vi0YUax78FkYizkPCEhtUZqPWBQDyWKfbdikFIjpUZKjZR6OJRak3Mp9Tu4mv9RBArg1cL9DsvBM2tGpUhGKpqpSJQkZMkQ7oArBVISM5aD5vsMYh98rBXRMjEu0khWyLORZw8Y2y2GsGkTnr2/cJBuI91Guo10ezh0uzgq7zy6/X61+PD1Bj7M/7a4HALVlmVUeyqc5KmP60NO0iknKTt6FQQ4R0KgEByXQQbPhdM6v8g/w0gA3iO+Dx4FffwUifxXt1d5CNicsvh1rRWnBvE2ZFZ6iE2wPBFTNFmVJmniODCjbKBMOk/pWFCuaX8RE1pZKz00+BOD9tlyKoNzlIIoxdiaxAqZtOKSWEkIYU7qhGcy1c6slz+l3Yuf4TIPMDkM15ROGXJBZxcsc2kSQAtrNCOCJB+JiEpT4cfSJ6Q/5MoKwjp0PNbkQHy+oO5S5xVOEKum3TGch+E8DOdhOG844bx6e8BeFc85LPIfLO+/3hGAp4/pibKYnhbOK8lNosCpl45ER4QxMWYyYkXUY+Egqr+ze0/sazqBl6kxkUbCKg3mUeJ0thHG2sQp9554YgC8AS+1VWYsyO7PLzyor7LJSLPPt9vRHrybHJjPkFAZgqXTwDRnVGeux7xxPIUUWTKcCG7dWDYN9OgfHvTdX7vwBT6+nQd3ee/lb/6/81zrDyaH47PlVIZmInx2YUS0KgIhgZEgEockrFJBcz6WU7161McHTefF5e3n2fX2xw9/5K+8mS1vCmI8QXZxjojuIhyqboSjlKwcCnOwT/7bn2GAAwMcGOAYeIBDHsdJlZXdoYSspsQ6wr0UisUQk0tEGqdFED4LzmyMMy3U8jlx213C+c3C/f0i27t7+g01G2o21Gyo2Z5WsylTHrR9664/32bF9bO7jpdZXnvv71WIPX3EtrQKkxBbBGyJpcy5EAhzLABVnlnKvXNjqcKkhPQXF9gvuaoOlok5VA0kVRYb4FZoJZMH7mT0hjsTUqIsBS8oD1h4WR/R1YzF7oPt++nB+UwxlWFZEx+8psJa8NmKkxSAZe2cTRUNPLmxNCzvL86lDgrrZM33fUM7NVy3IbLSWG7kSoM1VgSrTGKaReoDN6CF54SNJmvcH8ar9MLc+eDbR7Z9O2mctyQ2rNLEKs3hobt5laaosPG6KoM/FOajn77M//5hvhHPh13s4Pu7KMJ/uMXM5akehAAlhgAxBIghwOGFAHXF6s0jq75HiUkNKsZkgMQopCGWM08FSy76yAmRa4mJ7iVmZCOJlenJDqXnvIpSy5SIlYYz7mlQzEsiI6Wcp7BNFckKCfB943Hx5WbPQF18C6F+s1BoS9CWoC1BW4K2ZCq2hFcsO9jWZhWvd2Va2bwUMiqsS2FpVleXm7eb359jSorvZ0cMDQkaEjQkaEjGZkiaSey4luxQdiZJTkn01kSa0ZVkiEZ4ToOINoCyWzNSLJMm1WuH26WgCUETgiYETQiakAmYENmwAPqeCVmnbQqfBG0I2hC0IWhD0IZMw4awqlsDS7Z+1zAYaZHv9Ve3yjeKtgJtBdoKtBUjsxXaNJLYQQXZJdBUKhDlrOGGCw3eOGN9olIpxxkhu2hV1aRHyV7LB77Gr3B9i3YD7QbaDbQbaDfGajf0iZ2s96uA389vFwGKRjyr+eLjm9kCQn6RrcyDXwxhTysv3dPKwXCeXFAyMA5cc6ps8kFZxS2TY9nTytVfnrYJ4UHUvHJL2IPL1ArtGwmrdGNrsMCDkNxJJ5xilJCkKEnWUJqkSyMBNtW9AVsd7E128Fk9eDfdPdstSKwM4swKBhBoZtjcW8uAACUsWCNiZMD4WCD+1Kfm1LT4UwN5GzK7O6+yao6w1vg7z519ull/7fvl/d9ikyT00IfioZe0AroDb49yESF4K2WxxdwIJnVUIJX3KuiUvShue2uRJCrI5cii7tKr9NaBNFRJarwQANqB48qG/CkxTGy9SnuuV1nI6JdV8c35At3KAVITZtGtHCInQbeyKedm6FYOFt0du5Wccpb1tQSZJPMgOXeCGMK4MNx7KccC8R7dSlH5gZWY/KmhvBWh3TmWFfpxnDEBepboWaJniZ7l03iWRp/rWb6DcLtYzv4ATFwOm6WghzlMdoIeJnqY40V3xx4mUdEazgLJTqalgQRJgnPGe+qMDmY0EO/Pw9Rl0qpt+ieG9naFd+dxVt0xf95E6Hmi54meJ3qeT5TTPNvz3GjmQlLobw6Qs6C/OUyOgv4m+pvjRXfH/ial1nMBjEkqk0mMmuC9DT7wCCxazGjWh3h1l+mowZ8axlsQ2d0JyY18yyPDo0eJHiV6lOhRPpFHqc72KI8wgqd3KGmZQzkR3s2Qdw+Yk7TBu7eUxDSiJAdHR0aCjAQZCTKSJ2IkvDoj2erkQ2fCLX9azG9vhkBHVBkdsaCFE1JFxyExcCG/YhYc81p5m8xI6Ehf4e2/To1K0KwCdyXSLz9/XsDnfBHlYTmluYrMQ2AuOm81kOSUdtFmbR69YiOBHGOyv5yKOe/gyp2Smhhom4oLT6990V/MGU+vrYrqBqfXliRRjCGaFmkTZqmjygswJijLSAa0EKNJgPeH533ad+I84CkfN95IVmWottwo4ixTznsegAVlbNQm+sQM+ICorh2EKytU2E6yc37WT2NxsZhnurhcvnJTjsS1JLYyrLtU+LvSBKuz4gYtFRCrreCKyazUI2K9LtZrOe5rzlg8lN1zfAfL28vV9KDejtTu6qxZvcDzSVr/KOq8gLT9g5c3s0dhPAw+Y/AZg88DDD4Xya0Kcilb2x1KKZrgRSBKch29C9EVu6CyrJRnDExS1WLQp0+B/7Bws62iG0IMmpXmxKk1UUlGlDZEKObzigIqZDTCFCxFj4ShSGH64yj74joNmdeXbrl8O/sddrCZGkFpQWSlce/gieZAUrBE0mwtqMpGlTjCpWOg/UhQznh/KJe69iMryuQnCvCG0iqNeoMMxoM1OlInBGFM6WR4tv+ZKUY2Fh+T9xgmrJCjeO3CF9j86/xu2LXlnx62G4qrPFgoonZBRMO5z66QplSnFDXjzoQIYwkW9nhWQln92SNHfbrRwbPlVIbmkAhJAvLfaa1UiCk5qTWh3NMMbjWW9vGsvwyl2Lerx4K4E4byWTIqjWpr5j0I7gOniRpHKVBOlDDOEK/kWBgH7U8rl+5UKjOh00V1GyIrZR7ZPdSWUGNt4llDe+KJAfAGvNRWjaU6r0dVfTDeVXJq8OQgfYaEyhCcZEgselW0fFKRO8UiJB2k4BqiCW4kCO5xD+4jUnjQi/9ys337HlarPPZyckA+W05lcJaCksgY1ZbrWPxrnCDC8GgkEBLJSODc447yfb/9dEzq4lsKY8KlUe0JrryFQqQiEcdctFGB4yYrdE1l9hNBaDOWFgo9hvVqJBk2P36GyzzW5PB9vqBKW1AGEYTwQUYnBHNJeCApKq84kyT7jYjnunjeb9df8phez69u5hNGdANRlTqJlnswSUTqBbPBKWsV0aFQ0wSCGIuT+IT1fWWq58vN/quJwrslqZWyb6eBaZ7pN8TAvHE8hRRZMpwIbt1YYn49au+DCYZNxKrYmXt57+Vv/r/zXOsPJofts+VUhmaTtIDgPc0+JRAogtgaXJTGSQ/aIbeui2a7X1h42iV6f+t3sxelPK/n18uVu149fLf5i8mBvmtxlp5xzQiRkRBKog8mMMJd0kxHZ0UAG8dSEdjf2qCkfnVb9ac57VBMr7ItWzXeEGJoYM6ZZAyhMoFIljBjeAJmxhJs72/V6IN2/65UfTNE/tXxT6abG21VdqWdjCPjljhLbCBKgSsK7IORzvJkVXRiJKjvsaq2fmj5wXaDiQG9qbhKa8aVZVFzExTnLiQbqAESuaBMK0o1avTaGn1/w20dU/0rrL7M4/bHRNHevgBLGQ1LWbt7EY0mSminjHZUOMNpyu9H08K7P/yb+sqq7PFNm/h3K8zS6kdvBQ8qZvtgnLApMQArhbTBSknCWDhPj+uiSbDjYjHPw957MVHb0I0QS+sTGEibmClyt1IaDckZy6g0ibhg/Gj21PUXQ20Syjj8CKdtI7oX6K4jhqhw1n0t1+RER4ybLzfFf+svvLv/m/tNMhQ2ycAmGdgkA5tktNwko6hR7V5KsraUCqXYo6SsokRLYhOJJPjEnVGGEpZVjvIka6C1pGT3kiqY3xmSOmE+OhRcoFQwzaU3VrpAIngFjCYfE2MiElbtvMszOkQMoBcLwV4sL6R8wo112IsFe7FgLxbsxXK+tLAXC/ZiGS62sRcL9mIZHaixFwv2YhkHlLEXC/ZiGR+qsRdLKyDHXizDgTT2YjlLTWMvlqEBGXuxPAeFjL1YzqUe2IvlOdY6YS+Wquobe7E8CzxjLxbsxTIyTGMvlrMICfZieXZIx14sTRIx2ItlWGjGXizt7iLAXizjWRvYi6W7hYK9WMa6arAXyzPoxYL9KtpGPfaraAh97FfxnPGP/SpaXAvYr2I86wL7VWC/ClwH2K+i9UhTf/0qZBv9Kva2/WHPCuxZgT0rsGcF9qzAnhXYs+K8nhV3sb4dox1AzwqKPSteSNHfbn7sWVGbOWPPinZ8R+xZMVCAY88K7FkxWmxjzwrsWTE6UGPPCuxZMQ4oY88K7FkxPlRjz4pWQI49K4YDaexZcZaaxp4VQwMy9qx4DgoZe1acSz2wZ8VzrHfCnhVV1Tf2rHgWeMaeFdizYmSYxp4VZxES7Fnx7JCOPSuaJGKwZ8Ww0Iw9K9rdSYA9K8azNrBnRXcLBXtWjHXVYM8K7FkxQdRjz4qG0MeeFc8Z/9izosW18HQ9K0h0Ki8AaTXlKnsOlMqoBRGEa6IdH0vPikHvKXq0FW1i6G9DZNiXBfuyPC/UY1+WZ78OsC9L29HU/vqy2Db6suyZoWp9We6+hL1ZsDcL9mbB3izYm2WivVnEub1ZTpmQDoWnCRcJmFc+gs7Q4tYYK722NrAsUL+hoC3Z17P6nqF9RfuK9hXtK9pXtK9jta+aNe1/9sP17dUuaIStzwYRuJKSDDlNga3PsPUZtj4bMcCx9Rm2PhsttjtsfZYJLqUpEsKSCswlZxkTNvNdraVKhV85DnD32Pusvia6z2enhu1m0sKuftjVb3iYxq5+2NVvHFDGrn7Y1W98qMaufq2AHLv6DQfS2NXvLDWNXf2GBmTs6vccFDJ29TuXemBXv+dYLY9d/aqqb+zq9yzwjF39sKvfyDCNXf3OIiTY1e/ZIR27+jVJxGBXv2GhGbv6tbsPFbv6jWdtYFe/7hYKdvUb66rBrn7Y1W+CqMeufg2hj139njP+satfi2vh6br6YcezttcFdjzDjme4DrDjWeuRpt46nvFWOrJ82zhSrRlL8ffYhwX7sGAfFuzDgn1YptmHRdtz+7CUWI8O5eZ1dpSyqIBFIZxjlEIwmpjICXVsjbB1izPxZC3O0KqiVUWrilYVrSpa1ZFZ1aLeqLlVPVjvX9W27n8PjSsaVzSuaFzRuE7GuBapinON63Hz0aHgJDGKyiAdtWB1NrIiurwyFTDnuS9am6zbhvKmbUPX7uou9YJ9QweR/pGivwQQ9g2tneLBvqHtJDmxb+hAAY59Q7Fv6Gix3WHfUGyu2MuevoeTYHNFbK7YiIZgc8UhQbn15oqEKs+jzEyaBJ6JB03WCMp5JhtMejGaLRU9du2qXwb9IMowMUQ3FRd2DsXOoYMGOHYObQXk2Dl0OJDGzqFnqWnsHDo0IGPn0OegkLFz6LnUAzuHPsddZ9g5tKr6xs6hzwLP2DkUO4eODNPYOfQsQoKdQ58d0rFzaJMsI3YOHRaasXNou/0csHPoeNYGdg7tbqFg59CxrhrsHIqdQyeIeuwc2hD62Dn0OeMfO4e2uBawc+h41gV2DsXOobgOsHNo65Gm3jqHilZastwrUq7WiGX9Bexyho1YsBELNmLBRizYiKVeI5Yy89Gh4AKxEIJyWVCECGZBUh5lckGobEi53zUPlU/WPBTtKtpVtKtoV9Guol0dm121smmDswpxo6dve5Y/+efkY7jZYGEU9zlFrPqP4k6lNZrA1mjDhDy2RsPWaKPFdoet0bCZVOtNHLCZVP/NpLDfTuvbzLDfDvbbeRKQY7+d4UC65X47E+kT35+TiF3im2vplrvEY1OStr1FbEpS0U/spCkJbmtvG8+4rb0anLvY1j6RFmn9oRlbpJ3LQ1pskbYpH9atlA+fzATVKH7afRGLoLAICougsAgKi6AmWgRlGhVBnTAjXZ72KPNK1DQJKYSOMSSIJHKfigOVvTBhWwxF2yuGOrjBegCFUKXnP06kyQElpDdejW0OnlWbg6kUQOHZkAOFe5cFUEJq7zmEYJU30jhOs88iXWalxgcGI8E2FT2WudZoR1pFOU036d6hJLEoEIsCB4t7LArEosBxIRqLArEocHyoxqLAVkCORYHDgTQWBWJR4MggjUWB7TBqLAocGrKxKPB54BmLAqvBGYsCnwGasShwMEWBqpX+Z6Uh8xoFgZuvYTkglgNiOSCWA2I54ETLAVWjcsBSI9JlMSDn0Vuhs8+ujBY+SgFWJwlSuEST23YcJS22RqtwUN0AagNLm6RN5CBJ2mNrKDxKslXS/ZRHSU6lblD0GErBusGB1A1ijRTWSGGN1LMGd3+kBkuksEQKS6SmiGoskWoF5FgiNRxIY4nUsMkGlkg119JYIjXsJDyWSFV1E7FE6lngGUukqsEZS6SeAZqxRGowJVKm5b5pJ1NCNQqmdl/EkiksmcKSKSyZwpKpiZZMNeugdsKMdChAb52iKgbgiShrmU5OsJSy6pLeJRBb2snLa6buc4mLxbwgrZt3Q6h/0mXlT1FqaplkEL1IEIiXoCwLgXogSVE2EuJsZW/MmZdldffAMTFuXEc0mDHp0dvDjEnPGRMifHYSRLQqAiGBkSAShySsylSQc4UIrovg/XaKm0kubz/Prrc/fvgjf+XNbHlTcIIJat9zRFRaG6q5isxDYC46b3UmDE5pFzOL4tGrsVCH/vLWVerB3s3n2yjNt+mWPy3mtzeTw3NTcZXWhmrtaHBZL4MW1mhGBEk+EhGVpll3jwTbT5jtq/iwpofqswVVypi5UcRZppz3PAALytioTfSJZdIcLOK5bn7ksDF9XOqYnf3101hk/+bzApbLV24x4Vq6lsRWWjSaJDVemmC1CQq0VECstkUlkvTMYma7NtZrBarW1rV4KLvn+A6Wt5fTq+5vSWrbLGBx2aeSgEejKQcSeg8j1O4Fxzwd5ukwT1cjT1ccrMKqpwU215flFGfbYNHV1fx6/9Mf3eUS7t4OIXvAy7IH1mTHiAbmQXgNUoJzJjEVDaciKTKWEADtL3sgbYm0HmNo+2q6hLKxvMqYpKYqGBkgCqK9iz5SIYiAAMQILuJY8gw9wluX7RA7T0VODPAdSBD3kfaZqMB9pF3tI92USwpWz1M6Z808cqg2z3jvS/f9K4H+FfpX6F8Nrg7y4HKpt7i7LO+zQhvirSORAA3ceENZItFl5ypbX7tr6VWjPK2iusuy+pAFW8jXzQpHEV3SQREWytElHSh76dQlNZQGIoiRwmcP1FNhictGhUutDI1uLEfZctsbvE1ZGUFjbTkx7HcrTHRU0VEdFNwbOarFpoIOHNVjywd9VvRZ0WdFn3UYPmthJtp1WYuGASuIv1wPyleV6Kv2WWWKrupwXFURaaCguedSUGvyGyejtkzH6CWPY6k5Fbo/V/Vg65TGWnJioO9IirhhETcsDgjlLW9YDImAcEKCtlI7RSIV0grldFAxBY0bFmtTlYOhg5Lnk+fPX81q6JX7PDk0N5QWBg4xcDgoPDercFFdBA4fcxqMGGLEECOGGDEcSMTQdhQx/Ot8hUHDCfMVDBoOKGgIwfgYLPOESkOJcZT44qA5JyOjAsbSeKHPoKFoK9y1rygnhvvuBImhQwwdDgjoGDocNoIxdIihw3EiG0OHXYcObYehw4e0BqOHGD3E6CFGDwcSPaRtRw8/LG6xU8vQqArFsOFQeUunYUOuk4w8cq5kYjorTcm0EjEGl5x1XIwF3j12ainr1HiWhpwY3tsXILqi6IoOCuLNXNEKx9o1XDLogqILii4ouqDDcEE1aeKCbl9tzy5Ab3MIbAT7gg6WmnRbpJJXdSJUK5YE9wA6OkGskCxxrX0cS4d5QfuDd5nWOqUMpwbtJrJCHxJ9yEGhuZEPWdxBMx/y/upAdxHdRXQX0V0chrtIi1nK/MW37vrzbTZsP7vreJmldvHl5qieu3/I9v4vf1leLGZ/ZEFhNnNgTAWbfA6WtnTqX3rjWQwsMvCCyKS94ylRoWMgNHKN/mVteK9bJPemPSe2FvoVLnqw6MEOCv6NPFhV4Vy/7lYTerzo8aLHix7vQDxediJD2qYinGfhrCCizzswboM+72CJTrc+LyU2G5goYxDECSezwyuDZ8l5G1IaC7x79Xn31Va3+nNiq6Fv8aLfi37voBZAI79XV8jcdrme0PNFzxc9X/R8B+L5Ut2b53vrL2cB3d6BURt0ewfLczp1eyVzyoJOVlEZnFQRqEyWO69Mypp1LPDu1e3dF1eHynNiS6FX2aLDiw7voNDfLNGre3V4Hy4m9HbR20VvF73doXi7J1q5t6UH/2O2nPnZZRYG+rsDYzbo7w6W5nTbqClkpe00y5rBO8k1s5JSYjlhTArArbPn+Lv7fck7VZ8TWww9Sxd9XvR5B4X/Zj5vhW7DHS4n9HrR60WvF73eoXi9J1oQ19CEv8LqyzziRt7nwmnQ2x0swenW21WOGEN5MI4aTgwziShqFQQWjbR2JPDu0du1+111O9GaE1sD/QgVfVv0bQcF+2a+bYX2xR0sI/Rp0adFnxZ92qH4tLwHnxa36g6TzaBXO1hq06lXK0g0wpLELVNCa+6UDU7LbFykdimN5ozuHr1a04UDNvktun2JFT1b9GwHBfxmni3vybPFPbno26Jvi77tUH3b9rpRHdWBuBl3iGQGHdvBMptuHdtAEnNcqxiNckwEFgIzSmdK5BORZiTw7tOxbdAjqbLSnNgS6EWm6NKiSzso1DdzadvtNlVxFaE/i/4s+rPozw7En2WsY3/2t+vLrz8u5levbxeLfJO77Rro2w6J1dD+aA36tgPybRUzUqVIonCUUWZZii4knvUos9bQsZQi93gkMyX7lLRrDTqx9dC/gNHrRa93UEugWY9l1oPXW7qi0ANGDxg9YPSAB+IB0649YGw4NVhegzndwZKcTv1e4y1zjBljhA2GuWx1nRciK1AJgcNY/N4+c7qte2XYaKo3qaKHix7uoHDfLK/bh4eLnaXQr0W/Fv3aAfu17e3CvVgUAz26W+wtNVg6g47tYLlNp44tU0Cioc4xwZTjVEfQnGbLYjQhGh3bMxzbBttF6+jNia2CvsSKri26toMC/pB24VZfSOjbom+Lvi36tkPxbWUvvi32mBomo0HvdrD0plPvNijnbAJNrSXGxSjBgkghScG5llKPBN69nhO0b246U50TWwg9ShZ9XPRxB4X9Zj6u7M3HxV5T6OWil4te7lC93PYqk0u0IHabGiKhQRd3sOymUxfXsqSUYYKBDyIaA+A0GCa9UkwHNxZ4P5PK5Bpqc2KLoCepomuLru2gcD+kyuTK6wj9WvRr0a9Fv3Ygfi0Tnfu12HXqGTAb7Do1WJrTqY/rLYk6RM2sFyEqEjLIQ1LCppA4SWks8O6z69T+8+peh05sRTyFiNH7Re93UIugWecp0Yv3i72n0BNGTxg94efgCdPuPWHsPjVYboM53sESnU793wREJZkNbNLGFrpBAyNU0WC1McGpkcC7zxxvB74Z9p/qUa7o6aKnOyjkN8vz9uPpYg8q9G/Rv0X/drD+rT7h3tYl1U/vtjJ0W18wTNsOlbV0u/sWeTjy8GfFw1kFHl5vhSC/Rn6N/Br59TD4NS1maRBo2OrPi29c+pvKPqLpULWhakPVNmjVVkku+6u5U7yAFzF7CoZRZjT1kQWpLacuagJMbnUZaUWXrct9Nq9Rg6EGQw2GGqw/Dabb0GA/XN9eoQJDBYYKDBVYzwqMNtufvFVgd8Ey1GKoxVCLoRZ7lo7kh4WbrVCDoQZDDYYarGcNJkgbGuz9rb8fFMuyXK7c9erhO9RwqOFQw6GG69vT1GdvfKut3R6kNYdQRKjLiggZI0RGQiiJGVqBEe6SZjo6KwLYOJYzDigRf+mvO8a+vDqE18Tqs3qVbVl1onQ6m2mTiMj6RnEfqQVnmUmBBsG0Gc26Ib2tG1lBXK/ccjvWhBfB+YIqbQUMWjghVXQcEgMX8iuWQc28Vt6msSCa9YTnv04NlQXH+mVV/Hq+ePn58wI+54sohxy1JirJiNKGCMV8JvtAhYxGGMEVGwv56AtymzLDcypY3s5+344/OWXahshKd9/LkFj0ikqwKnKnWISkgxRcQzTBIcbr0gRa5YF9udm+fQ+rVR57OTlgny2nMjRzaZVgytOoXcy6m3pLPNFK6ZRZgvOI5ppo1jUOJt/N6cIX2Pzr8vd25dRff3Qhm97pafAuRFi2BkzSAoL3VFACBBI1ToOL0jjpQTs5kjWgelsDtsbRhfWTDZNbD12Lc7fdTbZSvnNmdAZTSJhCwhQSppD6SiFZ014G6VdYfZnHj2++XrurWdi82ynXp08XmbJ0EQipvecQglXeZMqTxQRRugwi4wODkXAfZvpLF5n953oGlO5jaLqb9zuUJDaqKPab9LYmsFVFZ60qSqLxQrtkuVQ6K3etBScuOsIoAFgS3VgilZL0F90xvLlGOkgTJob1zuRYmhClxOnsPhhrE8/a3BNPDIA34DM/VGNJiPbHdMRBBpv9iTT7fLsd7cG7yeH8DAmVanQaqUjEMRdtdvccN0kGTWUmJSC0GUukssfcU41k4ebHz3CZx5ockM8XFNYL9Bh5x3qB2sjuul5AKcui5iYozl1INlADJHJBmVaU6rGw8B4zrKrdqMDkEN++AMvwD1o7GhwjAbSwRjMiSPKRiKg0FX40EcZBldW+m8+36T0sqz1DULuMKOftZkSPe66Y/sT0J6Y/Mf3ZV/qTEt56/vOePhvcnrnSJKhnKTKepWY0UUI7ZTJlEc5wmvJ7O5awSlao/QXK69fw1cDTxIhMt8LEXXG4K26IqMddcc/AHcVdcbgrrvcICEa5BxflnsiuuP4INO6Kq8gScFfcM9DYuCvu2e2Km0plONaFP7ul8ER14RPJ5PfHcTCTP8BM/jbz2UoT5MpRSEx/YvoT05+Y/uwt/clU1/oNSzpQp6FOQ53Wn07jLbd9v1gUNRT3XqBeQ72Geg312hOci9hWqdphnTa4crXSFu+UgbSJGUK8ktJoSM5YRqVJxAXjx5KdoLS/2Kxt0oW8EqYmFpnqXqBYtoZla0NEPpatPYNsHJatYdlaz5DDsjUsWxt/ShfL1iqyBCxbewYaG8vWnl3ZmvNW8MyOVfb/nLApk2WwUkgbrJQkiJGsgf5aypgm3cePpBAmtwq6EeKuWEe03Li9QvwFk0CYBMIkECaB+ksCVdBxFfu7oO5C3YW6C3VXX7qrCGKV5a8PqK3Nj3v7Ep4+Jc3LUtJTaZkv+4s9YMv8J2iZP5EW4T2iGFuE99siHNttPkHhA7bbbCSobRzL6rNcvD0Fj94denfo3aF315d3Z2gF7+5ORhfZiBX3e7GYB1gu54t1LdijTwfv8BmuBBHJ2gIryhmanT5pfMhEI1ExmjQb7S/PpvcrAk4B59En0/UDW5VdGbuOUWRVmZIwElhRXcyyhZX5f4GEJEfTKZbb3mCv9lsYnKkvJ4b4tsSGwRAMhgwI1mcFQzZFEDtWedJ7rLtIdg4l/RTuz3zfoeToUKJDOUyH8ihqO5RL5CRZ7V1K2XFS0SpJrLEggHMfVdyl9GnVlP6doD7kK//441ZxfXyzcH/Pf3Z7lW9gfXO/wvUtrlZcrbhau1itsr3VCtsWOYVIcMHigsUF28WCrdAO5tSCLcjwq+KRh0X+2hLXKq5VXKtdrNUKBw2WrdWfYLVvW/+2uMTlissVl2sHy5XYZsu1CLJdXN5+nhWJuPVt4FLFpYpLtQvLWqGRddlSvVjMrh+VLL1cvp0tcc3imsU128maFa2x4fW9FV4s0mFcr7heO6LDtVOvD9drIaO8ZrdUGKNMuE5xnQ5pna6v9ePLGItryNe+mF+9hYT8F9cprtMO1qk9M7q0WaY/zv7xfrV4P/sfwPWJ6xPX5+Ds6MUCbtwC3s9vFwGwAgLXKa7TjuzomaHfzTL999t5vmFYOVyeuDxxeXZhRs+sKNysz3dwNf+jsJ/wauF+B4wa4TLFZdrJMqVNlmn2RT98vYEPc0zA4BLFJTpAopv90c+/FheCyxOXJy7PDpZno3DRL/lm5xGDubg4cXF2UmxUuevYumB3/Xr7crdVfLuX/OfV1eXm7eb3uGRxyeKSfcrdMieXLC5XXK64XLtdrqrCPtTNj6ItTNFvZR/odw1icOFtRCpOnIh+X5x3p2Y9fUdBWXqquXQmSeKJdBlLXGgljNM0UYjCRBhNR0HRX0tBvi+ug7iYWIupakIpPRg3Geqo1CxJoEFGSlWSzHLLWIarG8thB/0dGsr29c/9RzI5gJ6QBnbsw459A0Jry8cXKEE9T8qAChJ0VrSGaaEMpd5YnQk3Irgmgh8dNHzg+byDtNvYejPb/GpyOD5bTngYBx7GMUA4Nz2MQ1UIix9gzui8n3Tez93ecbJ5yH5EzL1gKHmMVx6MV7bR0bG86RT/tNh+7QAwMZCOwHzKQLo9HkgvwW2HkkmGiMwVvWKEK2I0dZowGiULIfEYd6ajaq66xP/C9YnrE9dnN+tT8zpnQd1Jac+I/ufC3eRBhpCxEWUZm8Stjc4opcHntQKcheiDyOvIWK6lHYl3a0h/7q2ptqyOAWZqTm5DcZUGImNxoFmMzHNmOCWeRpuC0JYAsSDDSMDdX5LnxBld+w/rw8JdL9N8ceX8bnw836wV2ZWhXjoNTHNGdVbozBvHU0iRJcOJ4NbFkaD+ycPvLnyBj2/nwV3ee/mb/+881/qDySH8bDmVodkbQgwNzDmTjCFUJhDJEmYMT8CMQzS3q8M3Q+RfHf8EdXgrsrs79KxCbV0tUoTRAYwOYHSgm+iAES1GB+577wMIFOiyQEE02hHNNVXcZQSZlIB6IiHGVEhoLHZY9BcoULaJ57uccGK8RcmVUU9uhVYyeeBORm+4MyElylLwgvLgxhI+6NGRqmZTdh9s308O3ueKCYMCGBQYHpi7CApo4byS3CQKnHrpSHREmCLSS4QVEStMa6O5/Cj6e8cH3n/9M1xOMmXRSFhluCbCZxdVRKsiEBIYCSJxSMIqFTTnCnFdE9fi4KPa7SNe//jhj/yVN7PlTeEgThDN54iodP8KzwrYBREN597SpCnVKUXNCv4cYSwZ5admGsfKgKcbnD1bTmVonkh9RI9oxvKIfssjNkkGVrsBZPUoCuYbMN+A+YZu8g1KnpNveBQaevrkAi9LLkwk0qp6rELEUOtThVqDBG6BOWopkxDywlYsSmnyIhc0cDoSMPdYscLrmobd7759NF23qGXpobPUY70tOktP4iwRdq6ztGco0DNCzwg9o248I0oqdxA9FQLEZYrLFJdpR8uUVe7NfcYyJfTTl/nfP8w3fOPDTjoHlq/A5YvLF5dvreU7e8G7l0zhn1aQTNWV3qHEpAYVYzJAYhTSEMuZp4IlF33khOw6m3PR/X4O1Huo91Dvod4bkt4TtVtRNUoxowpEFYgqEFXgkFQgq31KXPXAMeo71Heo71DfDUnf8YZtcCt3H0Xlh8oPlR8qvwEpP6XKKzPfuuvPt8WJou46Xmb5XXy5Kf7bvn0Pq9Xs+q5+Ybh9H5IMiUWvqASrIi9q2SDpIAXXEE0YS98HythfnmxDT1WoTK2c51w5lVZnJgLCCQnaSu0UiVRIK5TTQcUUNG6xrI1mXfPwoDx//mrW16/cBI+oaSYtbPHw5BsvscVDLy0erGFE0IxjEF6DlFA0gGQqGk5FUoSNBM2mPzQfbJq0nWRDoLPiibOdCtq8mm7dfGN5lTYwIT54TYW14LMnRlIApjzzjtLAkxsLq+5PV6uDwtoLO60f2sfXt8vV/GrzZtJd1FoQWWkzk8iVBmusCFZl3a1ZpD5wA1p4Thg26amN8fK+Mw9Dq9tHtn07aZy3JLbyQ3sFCdwX8VdZBNwE94RRwUWS3FmJe/5a3vO3GeJNWaflKUO+ZenddaqukO6pFqPZpXjYp5v1zX+/uH8s6/c3X24OpHYkpnYwtfOEqZ3j0riP497kIkLwVsqCVBnBpI4KpPJeBZ240Nz2ldhRtJJc7q/vHqUUTfAiECW5jt6F6EiQJMsqe1sMTFJrKYkepCRrS+mQFuxQUlZRoiWxiUQSfOLOKEMJyypHeZI10C7nX+G4goNG4KGVu3TL5dvZ71uLhvYA7QHaA7QHaA+enT2gVbdhlyS5UP2j+kf1j+of1f/zU/9VS4Arb+9HI4BGAI0AGgE0As/GCBSN15rHhN7f+vvRoSzd5cpdrx6+w3gR2gq0FWgr0FY8U1tBqp5EcI7DgE37UOWjym+i8qsu0bPrPHCJ4hLFJdp0idIKLarbyMLjasXViqu14Wq1VTuj1UuR4trEtYlrs6klFa3UszWLXeJKxpWMK7mx21q1EumcblSPFynDRYqL9OAiLShfhYzYEemUNgFHGCIMa8CQktod+k7g8HFTZoQkQrKOZqzAtw9L53CPXIQfwq+ORqx8EnqFYAx2KEV4PjvnDjuUTqRDaTEJbPuJ5su//Nbxk5lCDiwjYXt7+tP8dnVzu/pxvsiT39dW656h+ZruXrP9rqSbH0Uvgvlia36X63amsAl3Xe86I5R/MX9HFuK6Y5e77z3qjLpuRsDE3cXLT1nIy/klHLvudYNTIR6BZ/2l/PPqyl3Hj9trge37slupP1aNu8vDP26o9nD497D4o9J11huo1kXK/R4TL3+5G353++/ykvj1bolUuOAGg9aTcMk8L2PMH766nIffl1VkXHeoehf6uAvZwyf4gJdUudzzBqx10ezY8nh5c1OqIUq/V09uB3snl1C6UpnVH6yuNvumisWnm8vbz7Pr91+X2RTt+TV3Ki0r0/xGH+y8eLH+/vr19uVbt1xdrBv5XF3NVtkQPf6k7P5bnabWY1QH26U+nrmYozDjRW6myNOsri43bze/L7u51qaod2MHO/ScnLXyTbUxfL0bOthl6+SM75aryvfU0gy1bsvsT3owFfjoGl65JeTfvF/dep//6OHb07fa5ay1bt/u9yw760Lyy100cb6oLITu534CJOSXf7uerXpGwuFZ692+OetCsuK/mS/znC78nv94ubui6gLodN56Km7f/ax2KW/c7T/W/5Qqt8Zj17oVSs6b74ddn7gMpzSDeHHpAhz+9PSj7fEi6nk2+5C7b2h++CPfxa744xWk4rLym9n154vFPMByWereNBy5HlwP95u8P9ld6ORlWkcnind5vm/DlAC2hdHr3U4ZCd2bcCO9dYAmT5j/vogDld5N88Hb47Wl893B/OQttTVFe7z24Kx3uNhOWI66Nobv64YqLaM2hq91Q6XO3N6Mv11vgpxHcsFn+4x1p6n3xA4fm3Rk5p9gldVrcSjBXST3zWxR/szamaDeU3scGimfczfZhVt9efX13Tr6+0fx5eKD0gfX8kydKfn15IW+egfL+e0iwCaO346SPzJ4vZs5be3vzVd0DL7TvJs/er3JHZTeU2tz1IPjfhSxhLltrmIzbbHUv0D4/Zfl5v1rd/0KNr2SSzHZxXSdeX8PiNya+xRTFjzu26D32yu34/3VnbXe7Vc6iuvAhfx2/TLGdRH05gl8mFe8824mrBdDPphu3EWZ1j/uHfdREj6uNU6dyHG7OmadMjt87MmRitlivM0wywq6qvHQNYPqwtwF1e+nb+WnIqC+1+j/fpxd3U95ruPslY7K2F35m4X7+47JrLMBv8L1bX1Xqt7oLTCkChPuiNlJS9vOBPW89sPW/VQTgVLAnjtks7DSKWEVUe1XRbVBWOSvlVPVxmPXewZ1jtoovLFMsraruzxu0mjcek/jIP09vWNge1jfZ/jb4rL0ibQyfgsubK1NEPVd2JrD14NZhZNUvq3LaoTj/DHrXfo4zOsx4nFktovF7PqR5F4u386WZzg358xRz7mpknI4pkNny+wMf10T0Jc3s19h9WUeS3VbF7M1e5J1LiCbjPXsv7rSyo725mj/1h6u8do+WntztO+BH1fCG4Fu8PJqHvOSiaVUqJPpujPMD9l9JbLXzvg1vbdW/Iq13zYyI9+M0K8l8pxKwFp7fnztw5fbzRM7vOonMKuPXG/FlxOa6hvVSoHd3iT1iGC1Wva9PU+lz+bMEWuuygbcexNgep5+ests4lmLooitqYOxNXE/trY5LvZYBet6C0Ilx35zBu3LGIstEderHxfzq7eQytdCo3HrRYmruF2bqX6c/eP9avF+9j/l4eLzBqx30dXl88vVzeUJcnjOaPUut4ojuJngYgGffy32z5Re8FnjtR8Ku5vixi3gfaUkZrNxu5L6v9/OV3AFK9eS1O+NV0/qVQLPmynewdX8j0Is8Grhfi+v0mg0bAtR7IMz5ZX/4esNfJifoO5nD9kGXa905aN0YLYJxANGkn3y3yLsx/assQrm8V6g/v7rn+HyFI1vNO40sxs7Blh9Q+jdTtL/cIuZy1d5lAttHvY+Qvfp5d77anzw/EEx0oa8//EKOMz7T62Agn3Mrj8fw/86ajGxvV7P1rKNMEeK8TeMvz2L+Nu2RLa6Bk6LPE32X7O+LyUfzyhYPrJyLEwDnQB80b5nv/notiZ7HoreIcdcKHlcIFti9P7+MB/fzBb5guaLPPWDX5yxf6Pe8C0Y34MzFpVQv6w2DVaq31Er49fLZZflFB5O+Q7C7WJZ7C8442G1O08LKuvg1O8zUb6EQrbVn1kLo9e7nTJ3Y2/C+++qZeKbD143UCMeq5jyE8cONEY6srnzZGZs+dNifltaPdN05LoMg5+SRv5O8d+HhZut3t3/zV4T870AR30/ej3D5nUtAdUcudlSrn3OSq2lfMboNQO3jR8LPxjUqHZCVK2gRtUhp/s8nxWTb034CEAE4Lmtt9QB9+KgtbujF9Ut3hmyv5ulkyf7aPTpAvW8+znweFD5DOaZPi/lg9YPAfjk1o9VtH4/XN9e1XD19hNtp8VeTFDB02s28HSR+WcLDwUVzWAe5/NSNGjpEIBPbumqRjV33/sWRz2WOd1k3LDyaRqVT1Xxs15VnUbF77W3aTkq/mDk6Sq386Lie48FjdVgnufzMlbIlhCAT82WNK1j7S4W8xtYrL4etXqPWJOp1Pr5yBHbu+nuXpx+3t3MV29Vd3XPz263+7a2tDq+Np0jqqNLV+qbeETSm8m2P04jq/256qGqi3t9joiqp7GKk4VW7vp49cojTNkmq/fBnA/fnUZY1zPXw1tPcnhG6ENsfKvVJYcW4YETUB+uLV5W4Lbtnr15VyaLOqPUdAbPD1s8O1WK3gd6H08MQDQxaGKOmphC0PsmZnPFm+4Cefg424/aP9hZv3ERDm8F3dzG3kgfi+ML59f7n/7oLpdw97bUR2h/slrgeXSI1hnzzy7hA/xj3VbXbbqGnr7vbuetJ4IyE17tUtbbDCD+cl3t3ruZsN5Nl+3lqXUNf52vqt53Z3PWuvVHbnH9y/iwuK24vFufq9atHu5Oc3T67avTu06aDFvrBig51aXinol5NPN9m7L/y1+WF4vZH+tjois8x36vo6aI9p9Gm5c2z/Y0L7iKQur3SmqKqQazrntxt/5yFirKqMfLqCmgffXc1pX9x2w587PLWbEBrZKIer2Qely7Rkh1f/ZNKLWZHupn/noiqZEOr35JdfROX1dQTywNdOHRi6quZ3qZvqZ+qVFkWu2Sfru+/Fr05nx9u1jk+9+t/Soqpu9rqYed1q+upgru6QJ60zO7zGhD5dvTFdRcVjWCMHWuqh7z6+0ieltIJZdVQw33cwE1EVPpzMR6F9VAFfd/NfUw1MH11VXHfV1CveDCwf5cp6IA1Sp3mw7dQnJyc0kPQsUPspNi1CXeo6k+nup+syHvFh9JuxdMvNWPrNW+mspqstfLqJdrqRE7fnRh2zq8N1/zDLNQtfSwsymbJRebFSBWhkK38zZLNo213nSChdtZDzdROYcvoTLIu5+7nk1/vievirIajDvqttqv3zta73POcPXKoHD3Je7Gw3LEpy9HxL4ZiL1nVIuNLcoQgC0qP+wOi+DDjQBDEQrGI+92U3cXb3uGe7a6DsId9h+fhxLHTdLYgeCxaekhqPfMF82Ej3o/M1j47NbBw6oI+incH+rYlm1Gntltbo6tfDz+3blVu/Me83IOsFzOFx9fuSU8+rSUybc0QzPn5DkfhJYnPIiCChPujhc7dXh6SxPUu6mxHIA8usPljlWgHZnx7dzFzfmvheeyyhPXL26rMXS9J1N+LujD2S4Ws+tHRvvl8u1sWXpH7c1R79bGdtjsyePXH05ZbIDO025xUc4LG43b/i2sSzg/vozxl/zx9aqo1X0LqXzZNBq3XiisygrdTPXj7B/vV4v3s/8pTwmfN2BXcr9YwI1b7I75O2EZm41bT+5V9Mhmqn+/na/gClauVOxnjVdP6lV4w2aKd3A1/6MQS7az7ncoX69Nhq13AwfdpoMzZVx++HoDH+Yn9ObZQ3YFlozLz7+6VfjSEljujVfvkqsvpV+ubi7nsVypnDFaPft62NVds5H16+3Lna+ydWZ+Xl1dbt5ufl9qYtuaogW2enLWyjfVxvANk8FnuXujPCe6tTvaZCvLtcTr8kPpa5Wu1xy53gooJyQnJqu6caW9SeqZtHLfdzfv7oPt+9Jnc+aINaOq55viUa7cPzd//P27H16++fWHo027itdsny9tfmwOIC+7qRNfrIU7vq+E74/1oyvOCi/Nolb7ft0g7rdjvPinxfZhHei8yVpEEGpK1JRPoCnH2XV169o/XsOEfvoy//uH+eu8mFfwATLHzz+Xx9b2lGSGmgw12XPQZNswxunm9I/X9BqZ2I8ZyzCftgZ4UkYFi06x6PSoImd31TKPlXWb7jlSEqQkXVKSPzcfb+q9Pn1xyy+72AQHYqM11tNogBuiNDWcEGF1CkK6sP67/NVZoeav3eWn4MKXbNE/Lb8uV3D16Y8szbUYZy/YXzYtCtPsEpafItwUl3wd8jV8qqWsPp2uT8vrZfaC/OW3UyUxdzjYXczXdSL829vvNqVuVG0u+5ftXe7ynIWE/vm/Vjs37FOcLf7Xn49iV/n7Zi3cIrW+Cea9g8/wj91vvv+vf/u3f/vX//tf//b//r///a/55f/+fv2bfOlXRcKpSGv/oxAgLVT7i+/uPx6iLU0sUCWcBaVVsJIpy6Pi0UEM+fH8WXyve0HoQ4I4qBk7lIZKlAsmVLKMyygtoUwlEZLXQgsKaS0N1r00xHFpHEdth3KJnCSrvUuJZYlEqyTJSxoEcO6jinKtA/5/T5ERGQ==
\ No newline at end of file
diff --git a/docs/tech/01_configuration.md b/docs/tech/01_configuration.md
index 26daec63..0c236b5e 100644
--- a/docs/tech/01_configuration.md
+++ b/docs/tech/01_configuration.md
@@ -1,68 +1,70 @@
-
+[BumbleDocGen](../README.md) **/**
+[Technical description of the project](readme.md) **/**
+About configuration
-
+---
+
+
+# About configuration
Documentation generator configuration can be stored in special files.
They can be in different formats: yaml, json, php arrays, ini, xml
But it is not necessary to use files to store the configuration; you can also initialize the documentation generator instance by passing there an array of configuration parameters (see demo-5)
-During the instance creation process, configuration data is loaded into Configuration class, and the code works directly with it.
+During the instance creation process, configuration data is loaded into [Configuration](classes/Configuration.md) class, and the code works directly with it.
-
+# Configuration file example
Let's look at an example of a real configuration in more detail:
```yaml
- project_root: '%WORKING_DIR%'
- templates_dir: '%project_root%/selfdoc/templates'
- output_dir: "%project_root%/docs"
- cache_dir: '%project_root%/.bumbleDocGenCache'
- output_dir_base_url: "/docs"
- language_handlers:
- php:
- class: \BumbleDocGen\LanguageHandler\Php\PhpHandler
- settings:
- file_source_base_url: 'https://github.com/bumble-tech/bumble-doc-gen/blob/master'
- source_locators:
- - class: \BumbleDocGen\Core\Parser\SourceLocator\RecursiveDirectoriesSourceLocator
- arguments:
- directories:
- - "%project_root%/src"
- - "%project_root%/selfdoc"
- twig_filters:
- - class: \SelfDocConfig\Twig\CustomFilter\EvalString
- twig_functions:
- - class: \SelfDocConfig\Twig\CustomFunction\FindEntitiesClassesByCollectionClassName
- - class: \SelfDocConfig\Twig\CustomFunction\PrintClassCollectionAsGroupedTable
- - class: \SelfDocConfig\Twig\CustomFunction\GetConfigParametersDescription
- - class: \SelfDocConfig\Twig\CustomFunction\GetConsoleCommands
- plugins:
- - class: \SelfDocConfig\Plugin\TwigFilterClassParser\TwigFilterClassParserPlugin
- - class: \SelfDocConfig\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin
- - class: \BumbleDocGen\Core\Plugin\CorePlugin\LastPageCommitter\LastPageCommitter
-
-```
+project_root: '%WORKING_DIR%'
+templates_dir: '%project_root%/selfdoc/templates'
+output_dir: "%project_root%/docs"
+cache_dir: '%project_root%/.bumbleDocGenCache'
+output_dir_base_url: "/docs"
+language_handlers:
+ php:
+ class: \BumbleDocGen\LanguageHandler\Php\PhpHandler
+ settings:
+ file_source_base_url: 'https://github.com/bumble-tech/bumble-doc-gen/blob/master'
+source_locators:
+ - class: \BumbleDocGen\Core\Parser\SourceLocator\RecursiveDirectoriesSourceLocator
+ arguments:
+ directories:
+ - "%project_root%/src"
+ - "%project_root%/selfdoc"
+twig_filters:
+ - class: \SelfDocConfig\Twig\CustomFilter\EvalString
+twig_functions:
+ - class: \SelfDocConfig\Twig\CustomFunction\FindEntitiesClassesByCollectionClassName
+ - class: \SelfDocConfig\Twig\CustomFunction\PrintClassCollectionAsGroupedTable
+ - class: \SelfDocConfig\Twig\CustomFunction\GetConfigParametersDescription
+ - class: \SelfDocConfig\Twig\CustomFunction\GetConsoleCommands
+plugins:
+ - class: \SelfDocConfig\Plugin\TwigFilterClassParser\TwigFilterClassParserPlugin
+ - class: \SelfDocConfig\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin
+ - class: \BumbleDocGen\Core\Plugin\CorePlugin\LastPageCommitter\LastPageCommitter
+```
In this example, we see the real configuration of the self-documentation of this project.
**Here is an example of loading this configuration in PHP code:**
```php
- // Single file
- $docGenerator = (new DocGeneratorFactory())->create('config.yaml');
-
- // Multiple files
- $docGenerator = (new DocGeneratorFactory())->create('config.yaml', 'config2.yaml', 'config3.xml');
-
- // Passing configuration as an array
- $docGenerator = (new DocGeneratorFactory())->createByConfigArray($configArray);
-
-```
+// Single file
+$docGenerator = (new DocGeneratorFactory())->create('config.yaml');
+
+// Multiple files
+$docGenerator = (new DocGeneratorFactory())->create('config.yaml', 'config2.yaml', 'config3.xml');
+// Passing configuration as an array
+$docGenerator = (new DocGeneratorFactory())->createByConfigArray($configArray);
+```
-
+## Handling and inheritance of configuration files
The documentation generator can work with several configuration files at once.
When processing configuration files, each subsequent file has a higher priority and overwrites the previously defined parameters, but if the parameter has not yet been defined before, it will be added.
@@ -70,167 +72,30 @@ When processing configuration files, each subsequent file has a higher priority
Each default configuration file inherits the base configuration: `BumbleDocGen/Core/Configuration/defaultConfiguration.yaml`, but the parent configuration file can be changed using the `parent_configuration` parameter.
The inheritance algorithm is as follows: scalar types can be overwritten by each subsequent configuration, while arrays are supplemented with new data instead of overwriting.
-
-
-
-
-
- Key |
- Type |
- Default value |
- Description |
-
-
- parent_configuration |
- string|null |
- NULL |
- Path to parent configuration file |
-
-
- project_root |
- string |
- NULL |
- Path to the directory of the documented project (or part of the project) |
-
-
- templates_dir |
- string |
- NULL |
- Path to directory with documentation templates |
-
-
- output_dir |
- string |
- '%project_root%/docs' |
- Path to the directory where the finished documentation will be generated |
-
-
- cache_dir |
- string|null |
- '%WORKING_DIR%/.bumbleDocGenCache' |
- Path to the directory where the documentation generator cache will be saved |
-
-
- output_dir_base_url |
- string |
- '/docs' |
- Basic part of url documentation. Used to form links in generated documents. |
-
-
- git_client_path |
- string |
- 'git' |
- Path to git client |
-
-
- render_with_front_matter |
- bool |
- false |
- Do not remove the front matter block from templates when creating documents |
-
-
- check_file_in_git_before_creating_doc |
- bool |
- true |
- Checking if a document exists in GIT before creating a document |
-
-
- page_link_processor |
- PageLinkProcessorInterface |
- BasePageLinkProcessor |
- Link handler class on documentation pages |
-
-
- language_handlers |
- array<LanguageHandlerInterface> |
- NULL |
- List of programming language handlers |
-
-
- source_locators |
- array<SourceLocatorInterface> |
- NULL |
- List of source locators |
-
-
- use_shared_cache |
- bool |
- true |
- Enable cache usage of generated documents |
-
-
- twig_functions |
- array<CustomFunctionInterface> |
-
-
-- DrawDocumentationMenu
-
-- DrawDocumentedEntityLink
-
-- GeneratePageBreadcrumbs
-
-- GetDocumentedEntityUrl
-
-- LoadPluginsContent
-
-- PrintEntityCollectionAsList
-
-- GetDocumentationPageUrl
-
-- FileGetContents
-
- |
- Functions that can be used in document templates |
-
-
- twig_filters |
- array<CustomFilterInterface> |
-
-
-- AddIndentFromLeft
-
-- FixStrSize
-
-- PrepareSourceLink
-
-- Quotemeta
-
-- RemoveLineBrakes
-
-- StrTypeToUrl
-
-- TextToCodeBlock
-
-- TextToHeading
-
-- PregMatch
-
-- Implode
-
- |
- Filters that can be used in document templates |
-
-
- plugins |
- array<PluginInterface>|null |
-
-
-- PageHtmlLinkerPlugin
-
-- PageLinkerPlugin
-
- |
- List of plugins |
-
-
- additional_console_commands |
- array<Command> |
- NULL |
- Additional console commands |
-
-
-
-
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+## Configuration parameters
+
+| Key | Type | Default value | Description |
+|-|-|-|-|
+| **`parent_configuration`** | string \| null | NULL | Path to parent configuration file |
+| **`project_root`** | string | NULL | Path to the directory of the documented project (or part of the project) |
+| **`templates_dir`** | string | NULL | Path to directory with documentation templates |
+| **`output_dir`** | string | '%project_root%/docs' | Path to the directory where the finished documentation will be generated |
+| **`cache_dir`** | string \| null | '%WORKING_DIR%/.bumbleDocGenCache' | Path to the directory where the documentation generator cache will be saved |
+| **`output_dir_base_url`** | string | '/docs' | Basic part of url documentation. Used to form links in generated documents. |
+| **`git_client_path`** | string | 'git' | Path to git client |
+| **`render_with_front_matter`** | bool | false | Do not remove the front matter block from templates when creating documents |
+| **`check_file_in_git_before_creating_doc`** | bool | true | Checking if a document exists in GIT before creating a document |
+| **`page_link_processor`** | PageLinkProcessorInterface | [BasePageLinkProcessor](classes/BasePageLinkProcessor.md) | Link handler class on documentation pages |
+| **`language_handlers`** | array<LanguageHandlerInterface> | NULL | List of programming language handlers |
+| **`source_locators`** | array<SourceLocatorInterface> | NULL | List of source locators |
+| **`use_shared_cache`** | bool | true | Enable cache usage of generated documents |
+| **`twig_functions`** | array<CustomFunctionInterface> | - [DrawDocumentationMenu](classes/DrawDocumentationMenu.md)
- [DrawDocumentedEntityLink](classes/DrawDocumentedEntityLink.md)
- [DrawPageBreadcrumbs](classes/DrawPageBreadcrumbs.md)
- [GetDocumentedEntityUrl](classes/GetDocumentedEntityUrl.md)
- [LoadPluginsContent](classes/LoadPluginsContent.md)
- [PrintEntityCollectionAsList](classes/PrintEntityCollectionAsList.md)
- [GetDocumentationPageUrl](classes/GetDocumentationPageUrl.md)
- [FileGetContents](classes/FileGetContents.md)
| Functions that can be used in document templates |
+| **`twig_filters`** | array<CustomFilterInterface> | - [AddIndentFromLeft](classes/AddIndentFromLeft.md)
- [FixStrSize](classes/FixStrSize.md)
- [PrepareSourceLink](classes/PrepareSourceLink.md)
- [Quotemeta](classes/Quotemeta.md)
- [RemoveLineBrakes](classes/RemoveLineBrakes.md)
- [StrTypeToUrl](classes/StrTypeToUrl.md)
- [PregMatch](classes/PregMatch.md)
- [Implode](classes/Implode.md)
| Filters that can be used in document templates |
+| **`plugins`** | array<PluginInterface> \| null | - [PageHtmlLinkerPlugin](classes/PageHtmlLinkerPlugin.md)
- [PageLinkerPlugin](classes/PageLinkerPlugin.md)
| List of plugins |
+| **`additional_console_commands`** | array<Command> | NULL | Additional console commands |
+
+
+
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:45:03 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/classes/ClassConstantEntitiesCollection.md b/docs/tech/02_parser/classes/ClassConstantEntitiesCollection.md
index a0ce2089..47b303cb 100644
--- a/docs/tech/02_parser/classes/ClassConstantEntitiesCollection.md
+++ b/docs/tech/02_parser/classes/ClassConstantEntitiesCollection.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+ClassConstantEntitiesCollection
+---
+# [ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant;
@@ -14,394 +15,147 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant
final class ClassConstantEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [add](#madd)
+1. [get](#mget)
+1. [getIterator](#mgetiterator)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadConstantEntities](#mloadconstantentities)
+1. [remove](#mremove) - Remove an entity from a collection
+1. [unsafeGet](#munsafeget)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
-
--
- get
-
--
- getIterator
-
--
- has
- - Check if an entity has been added to the collection
--
- isEmpty
- - Check if the collection is empty or not
--
- loadConstantEntities
-
--
- remove
- - Remove an entity from a collection
--
- unsafeGet
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php#L17)
```php
public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php#L50)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity $constantEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php) | - |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
-
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
+---
+
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php#L62)
```php
public function get(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
+---
-
-
-
-
-
-
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L11)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- loadConstantEntities
- :warning: Is internal | source code
-
+---
+
# `loadConstantEntities` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php#L32)
```php
public function loadConstantEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-
+
# `unsafeGet` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php#L75)
```php
public function unsafeGet(string $constantName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/ClassConstantEntity.md b/docs/tech/02_parser/classes/ClassConstantEntity.md
index 9d7979b8..08afe7a6 100644
--- a/docs/tech/02_parser/classes/ClassConstantEntity.md
+++ b/docs/tech/02_parser/classes/ClassConstantEntity.md
@@ -1,1502 +1,605 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+ClassConstantEntity
+---
+# [ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L24) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant;
class ClassConstantEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Class constant entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a constant's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
-
--
- getName
- - Constant name
--
- getNamespaceName
- - Get the name of the namespace where the current class is implemented
--
- getObjectId
- - Get entity unique ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntity
- - Get the class like entity where this constant was obtained
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Constant short name
--
- getStartLine
- - Get the line number of the beginning of the constant code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getValue
- - Get the compiled value of a constant
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a constant is a private constant
--
- isProtected
- - Check if a constant is a protected constant
--
- isPublic
- - Check if a constant is a public constant
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class constant entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a constant's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname)
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of class constant modifiers
+1. [getName](#mgetname) - Constant name
+1. [getNamespaceName](#mgetnamespacename) - Get the name of the namespace where the current class is implemented
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntity](#mgetrootentity) - Get the class like entity where this constant was obtained
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Constant short name
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the constant code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getType](#mgettype) - Get current class constant type
+1. [getValue](#mgetvalue) - Get the compiled value of a constant
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a constant is a private constant
+1. [isProtected](#misprotected) - Check if a constant is a protected constant
+1. [isPublic](#mispublic) - Check if a constant is a public constant
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L55)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $constantName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L93)
```php
public function getAst(): \PhpParser\Node\Stmt\ClassConst;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\ClassConst
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\PhpParser\Node\Stmt\ClassConst](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/ClassConst.php)
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
-
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L129)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
-
-
-
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L275)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a constant's code in a file
-
Get the line number of the end of a constant's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L121)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L113)
```php
public function getImplementingClassName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L169)
+```php
+public function getModifiersString(): string;
+```
+Get a text representation of class constant modifiers
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L137)
```php
public function getName(): string;
```
+Constant name
-
Constant name
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L157)
```php
public function getNamespaceName(): string;
```
+Get the name of the namespace where the current class is implemented
-
Get the name of the namespace where the current class is implemented
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L92)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L83)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity where this constant was obtained
-
Get the class like entity where this constant was obtained
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L75)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L147)
```php
public function getShortName(): string;
```
+Constant short name
-
Constant short name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::getName()](ClassConstantEntity_2.md#mgetname)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L263)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the constant code in a file
-
Get the line number of the beginning of the constant code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L191)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getType(): string;
```
+Get current class constant type
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L290)
```php
public function getValue(): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters: not specified
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L251)
```php
public function isPrivate(): bool;
```
+Check if a constant is a private constant
-
Check if a constant is a private constant
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L239)
```php
public function isProtected(): bool;
```
+Check if a constant is a protected constant
-
Check if a constant is a protected constant
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L227)
```php
public function isPublic(): bool;
```
+Check if a constant is a public constant
-
Check if a constant is a public constant
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/ClassConstantEntity_2.md b/docs/tech/02_parser/classes/ClassConstantEntity_2.md
index bbc713c9..4301ad87 100644
--- a/docs/tech/02_parser/classes/ClassConstantEntity_2.md
+++ b/docs/tech/02_parser/classes/ClassConstantEntity_2.md
@@ -1,1502 +1,604 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+ClassConstantEntity
+---
+# [ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L24) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant;
class ClassConstantEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Class constant entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a constant's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
-
--
- getName
- - Constant name
--
- getNamespaceName
- - Get the name of the namespace where the current class is implemented
--
- getObjectId
- - Get entity unique ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntity
- - Get the class like entity where this constant was obtained
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Constant short name
--
- getStartLine
- - Get the line number of the beginning of the constant code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getValue
- - Get the compiled value of a constant
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a constant is a private constant
--
- isProtected
- - Check if a constant is a protected constant
--
- isPublic
- - Check if a constant is a public constant
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class constant entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a constant's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname)
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of class constant modifiers
+1. [getName](#mgetname) - Constant name
+1. [getNamespaceName](#mgetnamespacename) - Get the name of the namespace where the current class is implemented
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntity](#mgetrootentity) - Get the class like entity where this constant was obtained
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Constant short name
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the constant code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getType](#mgettype) - Get current class constant type
+1. [getValue](#mgetvalue) - Get the compiled value of a constant
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a constant is a private constant
+1. [isProtected](#misprotected) - Check if a constant is a protected constant
+1. [isPublic](#mispublic) - Check if a constant is a public constant
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L55)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $constantName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L93)
```php
public function getAst(): \PhpParser\Node\Stmt\ClassConst;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\ClassConst
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\PhpParser\Node\Stmt\ClassConst](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/ClassConst.php)
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
-
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L129)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
-
-
-
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L275)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a constant's code in a file
-
Get the line number of the end of a constant's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L121)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L113)
```php
public function getImplementingClassName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L169)
+```php
+public function getModifiersString(): string;
+```
+Get a text representation of class constant modifiers
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L137)
```php
public function getName(): string;
```
+Constant name
-
Constant name
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L157)
```php
public function getNamespaceName(): string;
```
+Get the name of the namespace where the current class is implemented
-
Get the name of the namespace where the current class is implemented
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L92)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L83)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity where this constant was obtained
-
Get the class like entity where this constant was obtained
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L75)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L147)
```php
public function getShortName(): string;
```
+Constant short name
-
Constant short name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::getName()](ClassConstantEntity_2.md#mgetname)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L263)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the constant code in a file
-
Get the line number of the beginning of the constant code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L191)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getType(): string;
```
+Get current class constant type
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L290)
```php
public function getValue(): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters: not specified
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L251)
```php
public function isPrivate(): bool;
```
+Check if a constant is a private constant
-
Check if a constant is a private constant
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L239)
```php
public function isProtected(): bool;
```
+Check if a constant is a protected constant
-
Check if a constant is a protected constant
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L227)
```php
public function isPublic(): bool;
```
+Check if a constant is a public constant
-
Check if a constant is a public constant
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/ClassEntity.md b/docs/tech/02_parser/classes/ClassEntity.md
index ce12ff6b..456262d1 100644
--- a/docs/tech/02_parser/classes/ClassEntity.md
+++ b/docs/tech/02_parser/classes/ClassEntity.md
@@ -1,3463 +1,1352 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+ClassEntity
+---
+# [ClassEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class ClassEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-PHP Class
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isAttribute
- - Check if a class is an attribute
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+PHP Class
+
+***Links:***
+- [https://www.php.net/manual/en/language.oop5.php](https://www.php.net/manual/en/language.oop5.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isAttribute](#misattribute) - Check if a class is an attribute
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
-
-
Throws:
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
See:
-
-
-
-
-
-
-
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get values only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get values only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfaceNames(): array;
```
+Get a list of class interface names
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
-```
-
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a collection of property entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+public function getMethods(): array;
+```
+Get all methods that are available according to the configuration as an array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
See:
-
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRelativeFileName(): null|string;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
File name relative to project_root configuration parameter
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
-
Return value: null |
string
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L120)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getName(): string;
```
+Full name of the entity
-
Get the collection of root entities to which this entity belongs
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getShortName(): string;
+public function getObjectId(): string;
```
+Get entity unique ID
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
+---
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L106)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getStartLine(): int;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Get the line number of the start of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L93)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L72)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrows(): array;
+public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get parsed throws from `throws` doc block
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPluginData(string $pluginKey): mixed;
+```
+Get additional information added using the plugin
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
+---
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getThrowsDocBlockLinks(): array;
+public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
+```
+Get a list of all properties and classes where they are implemented
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraits(): array;
+public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
-
Get a list of trait entities of the current class
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: array
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
+---
-
Throws:
-
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
+```
+Get the compiled value of a property
+
+***Parameters:***
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraitsNames(): array;
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a list of class traits names
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Return value: array
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Check if a constant exists in a class
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L386)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getShortName(): string;
+```
+Short name of the entity
-
Throws:
-
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasDescriptionLinks(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has links in its description
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: bool
+---
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
Throws:
-
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasExamples(): bool;
+public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Checking if an entity has `example` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
+```
+Check if a constant exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
+
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Check if a method exists in a class
+---
-
Parameters:
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L43)
```php
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isAttribute` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L55)
```php
public function isAttribute(): bool;
```
+Check if a class is an attribute
-
Check if a class is an attribute
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L20)
```php
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L30)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/ClassLikeEntity.md b/docs/tech/02_parser/classes/ClassLikeEntity.md
index 569f46b7..c368148b 100644
--- a/docs/tech/02_parser/classes/ClassLikeEntity.md
+++ b/docs/tech/02_parser/classes/ClassLikeEntity.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+ClassLikeEntity
+---
+# [ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L44) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
@@ -14,3301 +14,1211 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
abstract class ClassLikeEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
-public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocCommentLine(): null|int;
-```
-
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocNote(): string;
-```
-
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getEndLine(): int;
-```
-
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getEntityDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getExamples(): array;
-```
-
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getFileContent(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFileSourceLink(bool $withLine = true): null|string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFirstExample(): string;
-```
-
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
-```
-
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
+public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Link to an entity where docBlock is implemented for this entity
-
See:
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
-public function getRelativeFileName(): null|string;
-```
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
File name relative to project_root configuration parameter
+public function getDocCommentLine(): null|int;
+```
+Get the code line number where the docBlock of the current entity begins
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
string
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getDocNote(): string;
+```
+Get the note annotation value
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
+```php
+public function getEndLine(): int;
+```
+Get the line number of the end of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
-public function getShortName(): string;
+public function getEntityDependencies(): array;
```
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getExamples(): array;
+```
+Get parsed examples from `examples` doc block
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
-public function getStartLine(): int;
+public function getFileContent(): string;
```
-
Get the line number of the start of a class code in a file
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getFileSourceLink(bool $withLine = true): null|string;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function getThrows(): array;
+public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get parsed throws from `throws` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
+```php
+public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the class like entity in which the current entity was implemented
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
-public function getTraits(): array;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
-public function getTraitsNames(): array;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of class traits names
-
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L79)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getName(): string;
```
+Full name of the entity
-
Check if a constant exists in a class
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
Return value: bool
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasDescriptionLinks(): bool;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
+```php
+public function getParentClassNames(): array;
+```
+Get a list of entity names of parent classes
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasExamples(): bool;
+public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Checking if an entity has `example` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Check if a method exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: bool
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
-public function hasParentClass(string $parentClassName): bool;
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Return value: bool
+---
+
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
+```php
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+```
+Get a collection of property entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
-public function hasProperty(string $propertyName, bool $unsafe = false): bool;
+public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
Check if a property exists in a class
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+---
+
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
+```php
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get the collection of root entities to which this entity belongs
-
Return value: bool
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
+```php
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasThrows(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has `throws` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
+```php
+public function getTraitsNames(): array;
+```
+Get a list of class traits names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
-public function hasTraits(): bool;
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if the class contains traits
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasDescriptionLinks(): bool;
+```
+Checking if an entity has links in its description
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
-public function implementsInterface(string $interfaceName): bool;
-```
-
-
Check if a class implements an interface
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Parameters:
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
+```php
+public function hasMethod(string $methodName, bool $unsafe = false): bool;
+```
+Check if a method exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
-public function isAbstract(): bool;
+public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function isApi(): bool;
+public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Checking if an entity has `api` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasThrows(): bool;
+```
+Checking if an entity has `throws` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
-public function isClass(): bool;
+public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
-public function isClassLoad(): bool;
+public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
+```php
+public function isAbstract(): bool;
+```
+Check that an entity is abstract
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function isDeprecated(): bool;
+public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
+```php
+public function isClass(): bool;
+```
+Check if an entity is a Class
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
-public function isDocumentCreationAllowed(): bool;
+public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Return value: bool
+public function isDeprecated(): bool;
+```
+Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
+```php
+public function isDocumentCreationAllowed(): bool;
+```
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/ConditionGroup.md b/docs/tech/02_parser/classes/ConditionGroup.md
index b21aab22..d904a5c2 100644
--- a/docs/tech/02_parser/classes/ConditionGroup.md
+++ b/docs/tech/02_parser/classes/ConditionGroup.md
@@ -1,128 +1,56 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+ConditionGroup
+---
+# [ConditionGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionGroup.php#L13) class:
```php
namespace BumbleDocGen\Core\Parser\FilterCondition;
final class ConditionGroup implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Filter condition to group other filter conditions. A group can have an OR/AND condition test;
+In the case of OR, it is enough to successfully check at least one condition, in the case of AND, all checks must be successfully completed.
-Filter condition to group other filter conditions. A group can have an OR/AND condition test;
-In the case of OR, it is enough to successfully check at least one condition, in the case of AND, all checks must be successfully completed.
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionGroup.php#L20)
```php
public function __construct(string $groupType, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface ...$conditions);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$groupType | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$conditions
(variadic) | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionGroup.php#L25)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/ConditionInterface.md b/docs/tech/02_parser/classes/ConditionInterface.md
index 7990b2ad..ed7d6748 100644
--- a/docs/tech/02_parser/classes/ConditionInterface.md
+++ b/docs/tech/02_parser/classes/ConditionInterface.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+ConditionInterface
+---
+# [ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php#L9) class:
```php
namespace BumbleDocGen\Core\Parser\FilterCondition;
@@ -14,65 +15,23 @@ namespace BumbleDocGen\Core\Parser\FilterCondition;
interface ConditionInterface
```
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php#L11)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/Configuration.md b/docs/tech/02_parser/classes/Configuration.md
index ec4f2530..d9b5884b 100644
--- a/docs/tech/02_parser/classes/Configuration.md
+++ b/docs/tech/02_parser/classes/Configuration.md
@@ -1,763 +1,245 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+Configuration
+---
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
```php
namespace BumbleDocGen\Core\Configuration;
final class Configuration
```
-
-Configuration project documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAdditionalConsoleCommands
-
--
- getCacheDir
-
--
- getConfigurationVersion
-
--
- getDocGenLibDir
-
--
- getGitClientPath
-
--
- getIfExists
-
--
- getLanguageHandlersCollection
-
--
- getOutputDir
-
--
- getOutputDirBaseUrl
-
--
- getPageLinkProcessor
-
--
- getPlugins
-
--
- getProjectRoot
-
--
- getSourceLocators
-
--
- getTemplatesDir
-
--
- getTwigFilters
-
--
- getTwigFunctions
-
--
- getWorkingDir
-
--
- isCheckFileInGitBeforeCreatingDocEnabled
-
--
- renderWithFrontMatter
-
--
- useSharedCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
```php
public function getCacheDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
```php
public function getConfigurationVersion(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
```php
public function getDocGenLibDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
```php
public function getGitClientPath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
```php
public function getIfExists(mixed $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- mixed |
- - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
```php
public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
```php
public function getOutputDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
```php
public function getOutputDirBaseUrl(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
```php
public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
```php
public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
```php
public function getProjectRoot(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
```php
public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
```php
public function getTemplatesDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
```php
public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
```php
public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
```php
public function getWorkingDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isCheckFileInGitBeforeCreatingDocEnabled
- | source code
-
-
+
# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
```php
public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
```php
public function renderWithFrontMatter(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
```php
public function useSharedCache(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/DirectoriesSourceLocator.md b/docs/tech/02_parser/classes/DirectoriesSourceLocator.md
index d72ad4e5..f9d3f726 100644
--- a/docs/tech/02_parser/classes/DirectoriesSourceLocator.md
+++ b/docs/tech/02_parser/classes/DirectoriesSourceLocator.md
@@ -1,107 +1,50 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Source locators](../sourceLocator.md) **/**
+DirectoriesSourceLocator
+---
+# [DirectoriesSourceLocator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/DirectoriesSourceLocator.php#L10) class:
```php
namespace BumbleDocGen\Core\Parser\SourceLocator;
final class DirectoriesSourceLocator extends \BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator implements \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface
```
+Loads all files from the specified directory
-Loads all files from the specified directory
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getFinder
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getFinder](#mgetfinder)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/DirectoriesSourceLocator.php#L12)
```php
public function __construct(array $directories);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$directories | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $directories |
- array |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getFinder` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/BaseSourceLocator.php#L19)
```php
// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator
public function getFinder(): \Symfony\Component\Finder\Finder;
```
+***Return value:*** [\Symfony\Component\Finder\Finder](https://github.com/symfony/finder/blob/master/Finder.php)
-
-
Parameters: not specified
-
-
Return value: \Symfony\Component\Finder\Finder
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/DynamicMethodEntity.md b/docs/tech/02_parser/classes/DynamicMethodEntity.md
index 2cba8ff7..76baa2d3 100644
--- a/docs/tech/02_parser/classes/DynamicMethodEntity.md
+++ b/docs/tech/02_parser/classes/DynamicMethodEntity.md
@@ -1,839 +1,373 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+DynamicMethodEntity
+---
+# [DynamicMethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L18) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method;
class DynamicMethodEntity implements \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Method obtained by parsing the "method" annotation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getBodyCode
- - Get the code for this method
--
- getCallMethod
- - Get the entity of the magic method that will be called instead of the current virtual one
--
- getDescription
- - Get a description of this method
--
- getEndLine
- - Get the line number of the end of a method's code in a file
--
- getFirstReturnValue
- - Get the compiled first return value of a method (if possible)
--
- getImplementingClass
- - Get the ClassLike entity in which this method was implemented
--
- getImplementingClassName
- - Get the name of the class in which this method is implemented
--
- getModifiersString
- - Get a text representation of method modifiers
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Namespace of the class that contains this method
--
- getObjectId
- - Entity object ID
--
- getParameters
- - Get a list of method parameters
--
- getParametersString
- - Get a list of method parameters as a string
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getReturnType
- - Get the return type of method
--
- getRootEntity
- - Get the class like entity where this method was obtained
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- getSignature
- - Get the method signature as a string
--
- getStartColumn
- - Get the column number of the beginning of the method code in a file
--
- getStartLine
- - Get the line number of the beginning of the method code in a file
--
- isDynamic
- - Check if a method is a dynamic method, that is, implementable using __call or __callStatic
--
- isEntityCacheOutdated
-
--
- isImplementedInParentClass
- - Check if this method is implemented in the parent class
--
- isInitialization
- - Check if a method is an initialization method
--
- isPrivate
- - Check if a method is a private method
--
- isProtected
- - Check if a method is a protected method
--
- isPublic
- - Check if a method is a public method
--
- isStatic
- - Check if this method is static
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Method obtained by parsing the "method" annotation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getBodyCode](#mgetbodycode) - Get the code for this method
+1. [getCallMethod](#mgetcallmethod) - Get the entity of the magic method that will be called instead of the current virtual one
+1. [getDescription](#mgetdescription) - Get a description of this method
+1. [getEndLine](#mgetendline) - Get the line number of the end of a method's code in a file
+1. [getFirstReturnValue](#mgetfirstreturnvalue) - Get the compiled first return value of a method (if possible)
+1. [getImplementingClass](#mgetimplementingclass) - Get the ClassLike entity in which this method was implemented
+1. [getImplementingClassName](#mgetimplementingclassname) - Get the name of the class in which this method is implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of method modifiers
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Namespace of the class that contains this method
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getParameters](#mgetparameters) - Get a list of method parameters
+1. [getParametersString](#mgetparametersstring) - Get a list of method parameters as a string
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getReturnType](#mgetreturntype) - Get the return type of method
+1. [getRootEntity](#mgetrootentity) - Get the class like entity where this method was obtained
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getSignature](#mgetsignature) - Get the method signature as a string
+1. [getStartColumn](#mgetstartcolumn) - Get the column number of the beginning of the method code in a file
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the method code in a file
+1. [isDynamic](#misdynamic) - Check if a method is a dynamic method, that is, implementable using __call or __callStatic
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+1. [isImplementedInParentClass](#misimplementedinparentclass) - Check if this method is implemented in the parent class
+1. [isInitialization](#misinitialization) - Check if a method is an initialization method
+1. [isPrivate](#misprivate) - Check if a method is a private method
+1. [isProtected](#misprotected) - Check if a method is a protected method
+1. [isPublic](#mispublic) - Check if a method is a public method
+1. [isStatic](#misstatic) - Check if this method is static
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \phpDocumentor\Reflection\DocBlock\Tags\Method $annotationMethod);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$annotationMethod | [\phpDocumentor\Reflection\DocBlock\Tags\Method](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock/Tags/Method.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L327)
```php
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
-
-
-
-
+---
+
# `getBodyCode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L304)
```php
public function getBodyCode(): string;
```
+Get the code for this method
-
Get the code for this method
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getCallMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L67)
```php
public function getCallMethod(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the entity of the magic method that will be called instead of the current virtual one
-
Get the entity of the magic method that will be called instead of the current virtual one
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
-
-
-
-
+---
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L214)
```php
public function getDescription(): string;
```
+Get a description of this method
-
Get a description of this method
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L115)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a method's code in a file
-
Get the line number of the end of a method's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getFirstReturnValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L296)
```php
public function getFirstReturnValue(): mixed;
```
+Get the compiled first return value of a method (if possible)
-
Get the compiled first return value of a method (if possible)
-
-
Parameters: not specified
-
-
Return value: mixed
-
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L240)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the ClassLike entity in which this method was implemented
-
Get the ClassLike entity in which this method was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
-
-
-
-
+---
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L196)
```php
public function getImplementingClassName(): string;
```
+Get the name of the class in which this method is implemented
-
Get the name of the class in which this method is implemented
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L124)
```php
public function getModifiersString(): string;
```
+Get a text representation of method modifiers
-
Get a text representation of method modifiers
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L39)
```php
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L256)
```php
public function getNamespaceName(): string;
```
+Namespace of the class that contains this method
-
Namespace of the class that contains this method
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L309)
```php
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getParameters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L161)
```php
public function getParameters(): array;
```
+Get a list of method parameters
-
Get a list of method parameters
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getParametersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L181)
```php
public function getParametersString(): string;
```
+Get a list of method parameters as a string
-
Get a list of method parameters as a string
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L83)
```php
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
See:
-
-
-
-
-
-
+---
+
# `getReturnType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L140)
```php
public function getReturnType(): string;
```
+Get the return type of method
-
Get the return type of method
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L31)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity where this method was obtained
-
Get the class like entity where this method was obtained
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
-
-
-
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L317)
```php
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L248)
```php
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getSignature` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L49)
```php
public function getSignature(): string;
```
+Get the method signature as a string
-
Get the method signature as a string
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getStartColumn` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L104)
```php
public function getStartColumn(): int;
```
+Get the column number of the beginning of the method code in a file
-
Get the column number of the beginning of the method code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L93)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the method code in a file
-
Get the line number of the beginning of the method code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `isDynamic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L288)
```php
public function isDynamic(): bool;
```
+Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-
Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L339)
```php
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isImplementedInParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L206)
```php
public function isImplementedInParentClass(): bool;
```
+Check if this method is implemented in the parent class
-
Check if this method is implemented in the parent class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isInitialization` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L225)
```php
public function isInitialization(): bool;
```
+Check if a method is an initialization method
-
Check if a method is an initialization method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L280)
```php
public function isPrivate(): bool;
```
+Check if a method is a private method
-
Check if a method is a private method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L272)
```php
public function isProtected(): bool;
```
+Check if a method is a protected method
-
Check if a method is a protected method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L264)
```php
public function isPublic(): bool;
```
+Check if a method is a public method
-
Check if a method is a public method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isStatic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/DynamicMethodEntity.php#L57)
```php
public function isStatic(): bool;
```
+Check if this method is static
-
Check if this method is static
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/EntityInterface.md b/docs/tech/02_parser/classes/EntityInterface.md
index 6d185a4e..98373367 100644
--- a/docs/tech/02_parser/classes/EntityInterface.md
+++ b/docs/tech/02_parser/classes/EntityInterface.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+EntityInterface
+---
+# [EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L9) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
@@ -14,198 +15,86 @@ namespace BumbleDocGen\Core\Parser\Entity;
interface EntityInterface
```
+## Methods
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getName](#mgetname) - Full name of the entity
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+## Methods details:
-
-
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getName
- - Full name of the entity
--
- getObjectId
- - Entity object ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- isEntityCacheOutdated
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L53)
```php
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L30)
```php
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L16)
```php
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L46)
```php
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L23)
```php
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L37)
```php
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L58)
```php
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/EnumEntity.md b/docs/tech/02_parser/classes/EnumEntity.md
index 71ae969a..00ba0591 100644
--- a/docs/tech/02_parser/classes/EnumEntity.md
+++ b/docs/tech/02_parser/classes/EnumEntity.md
@@ -1,3559 +1,1388 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+EnumEntity
+---
+# [EnumEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L19) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class EnumEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Enumeration
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCasesNames
- - Get enum cases names
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getEnumCaseValue
- - Get enum case value
--
- getEnumCases
- - Get enum cases values
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Enumeration
+
+***Links:***
+- [https://www.php.net/manual/en/language.enumerations.php](https://www.php.net/manual/en/language.enumerations.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCasesNames](#mgetcasesnames) - Get enum cases names
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getEnumCaseValue](#mgetenumcasevalue) - Get enum case value
+1. [getEnumCases](#mgetenumcases) - Get enum cases values
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCasesNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L74)
```php
public function getCasesNames(): array;
```
+Get enum cases names
-
Get enum cases names
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getConstantEntitiesCollection()](ClassLikeEntity.md#mgetconstantentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get values only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get values only for constants corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getEnumCaseValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L87)
```php
public function getEnumCaseValue(string $name): mixed;
```
+Get enum case value
-
Get enum case value
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
+***Parameters:***
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEnumCases` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L45)
```php
public function getEnumCases(): array;
```
+Get enum cases values
-
Get enum cases values
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
-```
-
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Get the entity of the parent class if it exists
-
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L32)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Get the compiled value of a property
+---
-
Parameters:
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
Throws:
-
--
- \PhpParser\ConstExprEvaluationException
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
--
- \DI\DependencyException
+---
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
--
- \DI\NotFoundException
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
+```
+Get a collection of method entities
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethods` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1162)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+public function getMethods(): array;
```
+Get all methods that are available according to the configuration as an array
-
Get a collection of property entities
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
+```
+Get a list of all methods and classes where they are implemented
-
Throws:
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L95)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRelativeFileName(): null|string;
+public function getName(): string;
```
+Full name of the entity
-
File name relative to project_root configuration parameter
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: null |
string
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getObjectId(): string;
```
+Get entity unique ID
-
Get the collection of root entities to which this entity belongs
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getShortName(): string;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getStartLine(): int;
+public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get the line number of the start of a class code in a file
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPluginData(string $pluginKey): mixed;
+```
+Get additional information added using the plugin
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
+---
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getThrows(): array;
+public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Get parsed throws from `throws` doc block
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
+```
+Get a list of all properties and classes where they are implemented
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getThrowsDocBlockLinks(): array;
+public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
+
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
+```
+Get the compiled value of a property
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraits(): array;
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a list of trait entities of the current class
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Return value: array
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraitsNames(): array;
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get a list of class traits names
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+public function getShortName(): string;
+```
+Short name of the entity
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getStartLine(): int;
```
+Get the line number of the start of a class code in a file
-
Check if a constant exists in a class
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getThrows(): array;
+```
+Get parsed throws from `throws` doc block
-
Throws:
-
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasDescriptionLinks(): bool;
+public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
+```
+Check if a constant exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasExamples(): bool;
+public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Throws:
-
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasMethod(string $methodName, bool $unsafe = false): bool;
```
+Check if a method exists in a class
-
Check if a method exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: bool
-
-
-
Throws:
-
--
- \DI\DependencyException
+***Parameters:***
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
--
- \DI\NotFoundException
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L24)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/FalseCondition.md b/docs/tech/02_parser/classes/FalseCondition.md
index feaa26e7..1d396c76 100644
--- a/docs/tech/02_parser/classes/FalseCondition.md
+++ b/docs/tech/02_parser/classes/FalseCondition.md
@@ -1,78 +1,38 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+FalseCondition
+---
+# [FalseCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/FalseCondition.php#L13) class:
```php
namespace BumbleDocGen\Core\Parser\FilterCondition\CommonFilterCondition;
final class FalseCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+False conditions, any object is not available
-False conditions, any object is not available
-
-
-
-
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/FalseCondition.php#L15)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/FileIteratorSourceLocator.md b/docs/tech/02_parser/classes/FileIteratorSourceLocator.md
index 27d9441c..8e6fbcd2 100644
--- a/docs/tech/02_parser/classes/FileIteratorSourceLocator.md
+++ b/docs/tech/02_parser/classes/FileIteratorSourceLocator.md
@@ -1,107 +1,50 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Source locators](../sourceLocator.md) **/**
+FileIteratorSourceLocator
+---
+# [FileIteratorSourceLocator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/FileIteratorSourceLocator.php#L10) class:
```php
namespace BumbleDocGen\Core\Parser\SourceLocator;
final class FileIteratorSourceLocator extends \BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator implements \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface
```
+Loads all files using an iterator
-Loads all files using an iterator
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getFinder
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getFinder](#mgetfinder)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/FileIteratorSourceLocator.php#L12)
```php
public function __construct(\Iterator $fileInfoIterator);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$fileInfoIterator | [\Iterator](https://www.php.net/manual/en/class.iterator.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $fileInfoIterator |
- \Iterator |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getFinder` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/BaseSourceLocator.php#L19)
```php
// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator
public function getFinder(): \Symfony\Component\Finder\Finder;
```
+***Return value:*** [\Symfony\Component\Finder\Finder](https://github.com/symfony/finder/blob/master/Finder.php)
-
-
Parameters: not specified
-
-
Return value: \Symfony\Component\Finder\Finder
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/FileTextContainsCondition.md b/docs/tech/02_parser/classes/FileTextContainsCondition.md
index 3dd496f7..9113eb5b 100644
--- a/docs/tech/02_parser/classes/FileTextContainsCondition.md
+++ b/docs/tech/02_parser/classes/FileTextContainsCondition.md
@@ -1,122 +1,54 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+FileTextContainsCondition
+---
+# [FileTextContainsCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/FileTextContainsCondition.php#L14) class:
```php
namespace BumbleDocGen\Core\Parser\FilterCondition\CommonFilterCondition;
final class FileTextContainsCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Checking if a file contains a substring
-Checking if a file contains a substring
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/FileTextContainsCondition.php#L16)
```php
public function __construct(string $substring);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$substring | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $substring |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/FileTextContainsCondition.php#L20)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/InterfaceEntity.md b/docs/tech/02_parser/classes/InterfaceEntity.md
index 2e61e64a..4e4dfa14 100644
--- a/docs/tech/02_parser/classes/InterfaceEntity.md
+++ b/docs/tech/02_parser/classes/InterfaceEntity.md
@@ -1,3438 +1,1347 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+InterfaceEntity
+---
+# [InterfaceEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L12) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class InterfaceEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Object interface
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Object interface
+
+***Links:***
+- [https://www.php.net/manual/en/language.oop5.interfaces.php](https://www.php.net/manual/en/language.oop5.interfaces.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Return value: string |
array |
int |
bool |
null |
float
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getConstantEntitiesCollection()](ClassLikeEntity.md#mgetconstantentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
-
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
+***Parameters:***
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfaceNames(): array;
```
+Get a list of class interface names
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethods` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1162)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethods(): array;
```
+Get all methods that are available according to the configuration as an array
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L33)
```php
public function getModifiersString(): string;
```
+Get entity modifiers as a string
-
Get entity modifiers as a string
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getNamespaceName(): string;
```
+Get the entity namespace name
-
Get the entity namespace name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the entity of the parent class if it exists
-
Get the entity of the parent class if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Get a list of parent class entities
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassName(): null|string;
```
+Get the name of the parent class entity if it exists
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
-
-
-
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Get additional information added using the plugin
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: mixed
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
-
-
-
-
-
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
+***Parameters:***
-
Throws:
-
--
- \DI\DependencyException
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
--
- \DI\NotFoundException
-
-
-
-
-
-
-
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L386)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getStartLine(): int;
```
+Get the line number of the start of a class code in a file
-
Get the line number of the start of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getTraits(): array;
```
+Get a list of trait entities of the current class
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L41)
```php
public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Get a list of class traits names
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if a constant exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
--
- \Exception
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasMethod(string $methodName, bool $unsafe = false): bool;
```
+Check if a method exists in a class
-
Check if a method exists in a class
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L25)
```php
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L17)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: string
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/InvalidConfigurationParameterException.md b/docs/tech/02_parser/classes/InvalidConfigurationParameterException.md
deleted file mode 100644
index 57e5652d..00000000
--- a/docs/tech/02_parser/classes/InvalidConfigurationParameterException.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception
-```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/02_parser/classes/IsPrivateCondition.md b/docs/tech/02_parser/classes/IsPrivateCondition.md
index 46e5ef0f..af9d9e88 100644
--- a/docs/tech/02_parser/classes/IsPrivateCondition.md
+++ b/docs/tech/02_parser/classes/IsPrivateCondition.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsPrivateCondition
+---
+# [IsPrivateCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsPrivateCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\ClassConstantFilterCondition;
final class IsPrivateCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a private constant or not
-Check is a private constant or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsPrivateCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsPrivateCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsPrivateCondition_2.md b/docs/tech/02_parser/classes/IsPrivateCondition_2.md
index 301bd358..71cab7e6 100644
--- a/docs/tech/02_parser/classes/IsPrivateCondition_2.md
+++ b/docs/tech/02_parser/classes/IsPrivateCondition_2.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsPrivateCondition
+---
+# [IsPrivateCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsPrivateCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\MethodFilterCondition;
final class IsPrivateCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a private method or not
-Check is a private method or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsPrivateCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsPrivateCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsPrivateCondition_3.md b/docs/tech/02_parser/classes/IsPrivateCondition_3.md
index 22861f3d..e0c3c7f4 100644
--- a/docs/tech/02_parser/classes/IsPrivateCondition_3.md
+++ b/docs/tech/02_parser/classes/IsPrivateCondition_3.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsPrivateCondition
+---
+# [IsPrivateCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsPrivateCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition;
final class IsPrivateCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a private property or not
-Check is a private property or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsPrivateCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsPrivateCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsProtectedCondition.md b/docs/tech/02_parser/classes/IsProtectedCondition.md
index d8db64d7..c93dc86d 100644
--- a/docs/tech/02_parser/classes/IsProtectedCondition.md
+++ b/docs/tech/02_parser/classes/IsProtectedCondition.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsProtectedCondition
+---
+# [IsProtectedCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsProtectedCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\ClassConstantFilterCondition;
final class IsProtectedCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a protected constant or not
-Check is a protected constant or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsProtectedCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsProtectedCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsProtectedCondition_2.md b/docs/tech/02_parser/classes/IsProtectedCondition_2.md
index 315db5e9..7aa7c3d0 100644
--- a/docs/tech/02_parser/classes/IsProtectedCondition_2.md
+++ b/docs/tech/02_parser/classes/IsProtectedCondition_2.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsProtectedCondition
+---
+# [IsProtectedCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsProtectedCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\MethodFilterCondition;
final class IsProtectedCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a protected method or not
-Check is a protected method or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsProtectedCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsProtectedCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsProtectedCondition_3.md b/docs/tech/02_parser/classes/IsProtectedCondition_3.md
index 78bda0ec..8fbbb322 100644
--- a/docs/tech/02_parser/classes/IsProtectedCondition_3.md
+++ b/docs/tech/02_parser/classes/IsProtectedCondition_3.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsProtectedCondition
+---
+# [IsProtectedCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsProtectedCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition;
final class IsProtectedCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a protected property or not
-Check is a protected property or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsProtectedCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsProtectedCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsPublicCondition.md b/docs/tech/02_parser/classes/IsPublicCondition.md
index e93c169f..8f21b19b 100644
--- a/docs/tech/02_parser/classes/IsPublicCondition.md
+++ b/docs/tech/02_parser/classes/IsPublicCondition.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsPublicCondition
+---
+# [IsPublicCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsPublicCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\ClassConstantFilterCondition;
final class IsPublicCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a public constant or not
-Check is a public constant or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsPublicCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/IsPublicCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsPublicCondition_2.md b/docs/tech/02_parser/classes/IsPublicCondition_2.md
index 3333cc43..1dda1957 100644
--- a/docs/tech/02_parser/classes/IsPublicCondition_2.md
+++ b/docs/tech/02_parser/classes/IsPublicCondition_2.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsPublicCondition
+---
+# [IsPublicCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsPublicCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\MethodFilterCondition;
final class IsPublicCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a public method or not
-Check is a public method or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsPublicCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/IsPublicCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/IsPublicCondition_3.md b/docs/tech/02_parser/classes/IsPublicCondition_3.md
index cd3693ef..8d8efa2b 100644
--- a/docs/tech/02_parser/classes/IsPublicCondition_3.md
+++ b/docs/tech/02_parser/classes/IsPublicCondition_3.md
@@ -1,105 +1,48 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+IsPublicCondition
+---
+# [IsPublicCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsPublicCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition;
final class IsPublicCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Check is a public property or not
-Check is a public property or not
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsPublicCondition.php#L18)
```php
public function __construct();
```
+---
-
-
Parameters: not specified
-
-
-
-
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/IsPublicCondition.php#L23)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/LocatedInCondition.md b/docs/tech/02_parser/classes/LocatedInCondition.md
index 0d42026c..ca0ef1c3 100644
--- a/docs/tech/02_parser/classes/LocatedInCondition.md
+++ b/docs/tech/02_parser/classes/LocatedInCondition.md
@@ -1,139 +1,56 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+LocatedInCondition
+---
+# [LocatedInCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php#L16) class:
```php
namespace BumbleDocGen\Core\Parser\FilterCondition\CommonFilterCondition;
final class LocatedInCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Checking the existence of an entity in the specified directories
-Checking the existence of an entity in the specified directories
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php#L18)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = []);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$directories | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedInCondition.php#L28)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/LocatedNotInCondition.md b/docs/tech/02_parser/classes/LocatedNotInCondition.md
index 31d91c10..80caae69 100644
--- a/docs/tech/02_parser/classes/LocatedNotInCondition.md
+++ b/docs/tech/02_parser/classes/LocatedNotInCondition.md
@@ -1,139 +1,56 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+LocatedNotInCondition
+---
+# [LocatedNotInCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedNotInCondition.php#L16) class:
```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
-Checking the existence of an entity not in the specified directories
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedNotInCondition.php#L18)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = []);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$directories | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/LocatedNotInCondition.php#L28)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/MethodEntitiesCollection.md b/docs/tech/02_parser/classes/MethodEntitiesCollection.md
index dd2a9b0e..cf745920 100644
--- a/docs/tech/02_parser/classes/MethodEntitiesCollection.md
+++ b/docs/tech/02_parser/classes/MethodEntitiesCollection.md
@@ -1,466 +1,192 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+MethodEntitiesCollection
+---
+# [MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L22) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method;
final class MethodEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate
```
+Collection of PHP class method entities
-Collection of PHP class method entities
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
- - Add an entity to a collection
--
- get
- - Get the loaded method entity if it exists
--
- getAllExceptInitializations
- - Get a copy of the collection containing only those methods that are not initialization methods
--
- getInitializations
- - Get a copy of the collection containing only those methods that are initialization methods
--
- getIterator
-
--
- has
- - Check if an entity has been added to the collection
--
- isEmpty
- - Check if the collection is empty or not
--
- loadMethodEntities
- - Load method entities into the collection according to the project configuration
--
- remove
- - Remove an entity from a collection
--
- unsafeGet
- - Get the method entity if it exists. If the method exists but has not been loaded into the collection, a new entity object will be created
-
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [add](#madd) - Add an entity to a collection
+1. [get](#mget) - Get the loaded method entity if it exists
+1. [getAllExceptInitializations](#mgetallexceptinitializations) - Get a copy of the collection containing only those methods that are not initialization methods
+1. [getInitializations](#mgetinitializations) - Get a copy of the collection containing only those methods that are initialization methods
+1. [getIterator](#mgetiterator)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadMethodEntities](#mloadmethodentities) - Load method entities into the collection according to the project configuration
+1. [remove](#mremove) - Remove an entity from a collection
+1. [unsafeGet](#munsafeget) - Get the method entity if it exists. If the method exists but has not been loaded into the collection, a new entity object will be created
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L26)
```php
public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L82)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntityInterface $methodEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Add an entity to a collection
-
Add an entity to a collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
-
-
-
-
-
-
+***Parameters:***
-```php
-public function get(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
+| Name | Type | Description |
+|:-|:-|:-|
+$methodEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntityInterface.php) | Entity to be added to the collection |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Replace an entity with a new one if one has already been loaded previously |
-
Get the loaded method entity if it exists
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- Method entity name |
-
-
-
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L98)
+```php
+public function get(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the loaded method entity if it exists
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | Method entity name |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getAllExceptInitializations` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L162)
```php
public function getAllExceptInitializations(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a copy of the collection containing only those methods that are not initialization methods
-
Get a copy of the collection containing only those methods that are not initialization methods
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getInitializations` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L140)
```php
public function getInitializations(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a copy of the collection containing only those methods that are initialization methods
-
Get a copy of the collection containing only those methods that are initialization methods
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L11)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- loadMethodEntities
- :warning: Is internal | source code
-
+---
+
# `loadMethodEntities` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L45)
```php
public function loadMethodEntities(): void;
```
+Load method entities into the collection according to the project configuration
-
Load method entities into the collection according to the project configuration
-
-
Parameters: not specified
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
+---
+
# `unsafeGet` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php#L114)
```php
public function unsafeGet(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the method entity if it exists. If the method exists but has not been loaded into the collection, a new entity object will be created
-
Get the method entity if it exists. If the method exists but has not been loaded into the collection, a new entity object will be created
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- Method entity name |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/MethodEntity.md b/docs/tech/02_parser/classes/MethodEntity.md
index abc48f0e..1ecce588 100644
--- a/docs/tech/02_parser/classes/MethodEntity.md
+++ b/docs/tech/02_parser/classes/MethodEntity.md
@@ -1,1777 +1,719 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+MethodEntity
+---
+# [MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L31) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method;
class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Class method entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getBodyCode
- - Get the code for this method
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
-
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a method's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getFirstReturnValue
- - Get the compiled first return value of a method (if possible)
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
- - Get the name of the class in which this method is implemented
--
- getModifiersString
- - Get a text representation of method modifiers
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Namespace of the class that contains this method
--
- getObjectId
- - Get entity unique ID
--
- getParameters
- - Get a list of method parameters
--
- getParametersString
- - Get a list of method parameters as a string
--
- getParentMethod
- - Get the parent method for this method
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getReturnType
- - Get the return type of method
--
- getRootEntity
-
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getSignature
- - Get the method signature as a string
--
- getStartColumn
- - Get the column number of the beginning of the method code in a file
--
- getStartLine
- - Get the line number of the beginning of the entity code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isConstructor
- - Checking that a method is a constructor
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDynamic
- - Check if a method is a dynamic method, that is, implementable using __call or __callStatic
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isImplementedInParentClass
- - Check if this method is implemented in the parent class
--
- isInitialization
- - Check if a method is an initialization method
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a method is a private method
--
- isProtected
- - Check if a method is a protected method
--
- isPublic
- - Check if a method is a public method
--
- isStatic
- - Check if this method is static
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class method entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getBodyCode](#mgetbodycode) - Get the code for this method
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline)
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a method's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getFirstReturnValue](#mgetfirstreturnvalue) - Get the compiled first return value of a method (if possible)
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname) - Get the name of the class in which this method is implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of method modifiers
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Namespace of the class that contains this method
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParameters](#mgetparameters) - Get a list of method parameters
+1. [getParametersString](#mgetparametersstring) - Get a list of method parameters as a string
+1. [getParentMethod](#mgetparentmethod) - Get the parent method for this method
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getReturnType](#mgetreturntype) - Get the return type of method
+1. [getRootEntity](#mgetrootentity)
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getSignature](#mgetsignature) - Get the method signature as a string
+1. [getStartColumn](#mgetstartcolumn) - Get the column number of the beginning of the method code in a file
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the entity code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isConstructor](#misconstructor) - Checking that a method is a constructor
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDynamic](#misdynamic) - Check if a method is a dynamic method, that is, implementable using __call or __callStatic
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isImplementedInParentClass](#misimplementedinparentclass) - Check if this method is implemented in the parent class
+1. [isInitialization](#misinitialization) - Check if a method is an initialization method
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a method is a private method
+1. [isProtected](#misprotected) - Check if a method is a protected method
+1. [isPublic](#mispublic) - Check if a method is a public method
+1. [isStatic](#misstatic) - Check if this method is static
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L55)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \PhpParser\PrettyPrinter\Standard $astPrinter, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $methodName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$astPrinter | [\PhpParser\PrettyPrinter\Standard](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/PrettyPrinter/Standard.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L78)
```php
public function getAst(): \PhpParser\Node\Stmt\ClassMethod;
```
+Get AST for this entity
-
Get AST for this entity
+***Return value:*** [\PhpParser\Node\Stmt\ClassMethod](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/ClassMethod.php)
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\ClassMethod
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getBodyCode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L545)
```php
public function getBodyCode(): string;
```
+Get the code for this method
-
Get the code for this method
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L142)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
-
-
-
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L200)
```php
public function getDocCommentLine(): null|int;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L518)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a method's code in a file
-
Get the line number of the end of a method's code in a file
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstReturnValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L529)
```php
public function getFirstReturnValue(): mixed;
```
+Get the compiled first return value of a method (if possible)
-
Get the compiled first return value of a method (if possible)
-
-
Parameters: not specified
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
Return value: mixed
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L106)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L414)
```php
public function getImplementingClassName(): string;
```
+Get the name of the class in which this method is implemented
-
Get the name of the class in which this method is implemented
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L242)
```php
public function getModifiersString(): string;
```
+Get a text representation of method modifiers
-
Get a text representation of method modifiers
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L114)
```php
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L130)
```php
public function getNamespaceName(): string;
```
+Namespace of the class that contains this method
-
Namespace of the class that contains this method
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParameters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L300)
```php
public function getParameters(): array;
```
+Get a list of method parameters
-
Get a list of method parameters
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getParametersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L392)
```php
public function getParametersString(): string;
```
+Get a list of method parameters as a string
-
Get a list of method parameters as a string
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getParentMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L184)
```php
public function getParentMethod(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the parent method for this method
-
Get the parent method for this method
-
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L232)
```php
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
See:
-
-
-
-
-
-
+---
+
# `getReturnType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L269)
```php
public function getReturnType(): string;
```
+Get the return type of method
-
Get the return type of method
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L90)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L98)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L122)
```php
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getSignature` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L212)
```php
public function getSignature(): string;
```
+Get the method signature as a string
-
Get the method signature as a string
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getStartColumn` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L508)
```php
public function getStartColumn(): int;
```
+Get the column number of the beginning of the method code in a file
-
Get the column number of the beginning of the method code in a file
-
-
Parameters: not specified
-
-
Return value: int
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L498)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the entity code in a file
-
Get the line number of the beginning of the entity code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isConstructor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L222)
```php
public function isConstructor(): bool;
```
+Checking that a method is a constructor
-
Checking that a method is a constructor
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `isDynamic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L448)
```php
public function isDynamic(): bool;
```
+Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-
Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isImplementedInParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L406)
```php
public function isImplementedInParentClass(): bool;
```
+Check if this method is implemented in the parent class
-
Check if this method is implemented in the parent class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isInitialization` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L426)
```php
public function isInitialization(): bool;
```
+Check if a method is an initialization method
-
Check if a method is an initialization method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L488)
```php
public function isPrivate(): bool;
```
+Check if a method is a private method
-
Check if a method is a private method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L478)
```php
public function isProtected(): bool;
```
+Check if a method is a protected method
-
Check if a method is a protected method
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L458)
```php
public function isPublic(): bool;
```
+Check if a method is a public method
-
Check if a method is a public method
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isStatic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L468)
```php
public function isStatic(): bool;
```
+Check if this method is static
-
Check if this method is static
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition.md b/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition.md
index dfcd5eb3..424a7719 100644
--- a/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition.md
+++ b/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition.md
@@ -1,78 +1,38 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+OnlyFromCurrentClassCondition
+---
+# [OnlyFromCurrentClassCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/OnlyFromCurrentClassCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\MethodFilterCondition;
final class OnlyFromCurrentClassCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Only methods that belong to the current class (not parent)
-Only methods that belong to the current class (not parent)
-
-
-
-
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/OnlyFromCurrentClassCondition.php#L16)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition_2.md b/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition_2.md
index 6ca28f92..24c32a32 100644
--- a/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition_2.md
+++ b/docs/tech/02_parser/classes/OnlyFromCurrentClassCondition_2.md
@@ -1,78 +1,38 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+OnlyFromCurrentClassCondition
+---
+# [OnlyFromCurrentClassCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/OnlyFromCurrentClassCondition.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition;
final class OnlyFromCurrentClassCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Only properties that belong to the current class (not parent)
-Only properties that belong to the current class (not parent)
-
-
-
-
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/OnlyFromCurrentClassCondition.php#L16)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/PhpEntitiesCollection.md b/docs/tech/02_parser/classes/PhpEntitiesCollection.md
index b6328938..29398213 100644
--- a/docs/tech/02_parser/classes/PhpEntitiesCollection.md
+++ b/docs/tech/02_parser/classes/PhpEntitiesCollection.md
@@ -1,883 +1,352 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+PhpEntitiesCollection
+---
+# [PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L43) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
final class PhpEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection implements \IteratorAggregate
```
-
-Collection of php root entities
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
- - Add an entity to the collection
--
- clearOperationsLogCollection
-
--
- filterByInterfaces
- - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
--
- filterByNameRegularExpression
- - Get a copy of the current collection with only entities whose names match the regular expression
--
- filterByParentClassNames
- - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
--
- filterByPaths
- - Get a copy of the current collection only with entities filtered by file paths (from project_root)
--
- findEntity
- - Find an entity in a collection
--
- get
- - Get an entity from a collection (only previously added)
--
- getEntityCollectionName
- - Get collection name
--
- getEntityLinkData
-
--
- getIterator
-
--
- getLoadedOrCreateNew
- - Get an entity from the collection or create a new one if it has not yet been added
--
- getOnlyAbstractClasses
- - Get a copy of the current collection with only abstract classes
--
- getOnlyInstantiable
- - Get a copy of the current collection with only instantiable entities
--
- getOnlyInterfaces
- - Get a copy of the current collection with only interfaces
--
- getOnlyTraits
- - Get a copy of the current collection with only traits
--
- getOperationsLogCollection
-
--
- has
- - Check if an entity has been added to the collection
--
- internalFindEntity
-
--
- internalGetLoadedOrCreateNew
-
--
- isEmpty
- - Check if the collection is empty or not
--
- loadEntities
- - Load entities into a collection
--
- loadEntitiesByConfiguration
- - Load entities into a collection by configuration
--
- remove
- - Remove an entity from a collection
--
- removeAllNotLoadedEntities
-
--
- toArray
- - Convert collection to array
--
- updateEntitiesCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Collection of php root entities
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [add](#madd) - Add an entity to the collection
+1. [clearOperationsLogCollection](#mclearoperationslogcollection)
+1. [filterByInterfaces](#mfilterbyinterfaces) - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
+1. [filterByNameRegularExpression](#mfilterbynameregularexpression) - Get a copy of the current collection with only entities whose names match the regular expression
+1. [filterByParentClassNames](#mfilterbyparentclassnames) - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
+1. [filterByPaths](#mfilterbypaths) - Get a copy of the current collection only with entities filtered by file paths (from project_root)
+1. [findEntity](#mfindentity) - Find an entity in a collection
+1. [get](#mget) - Get an entity from a collection (only previously added)
+1. [getEntityCollectionName](#mgetentitycollectionname) - Get collection name
+1. [getEntityLinkData](#mgetentitylinkdata)
+1. [getIterator](#mgetiterator)
+1. [getLoadedOrCreateNew](#mgetloadedorcreatenew) - Get an entity from the collection or create a new one if it has not yet been added
+1. [getOnlyAbstractClasses](#mgetonlyabstractclasses) - Get a copy of the current collection with only abstract classes
+1. [getOnlyInstantiable](#mgetonlyinstantiable) - Get a copy of the current collection with only instantiable entities
+1. [getOnlyInterfaces](#mgetonlyinterfaces) - Get a copy of the current collection with only interfaces
+1. [getOnlyTraits](#mgetonlytraits) - Get a copy of the current collection with only traits
+1. [getOperationsLogCollection](#mgetoperationslogcollection)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [internalFindEntity](#minternalfindentity)
+1. [internalGetLoadedOrCreateNew](#minternalgetloadedorcreatenew)
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadEntities](#mloadentities) - Load entities into a collection
+1. [loadEntitiesByConfiguration](#mloadentitiesbyconfiguration) - Load entities into a collection by configuration
+1. [remove](#mremove) - Remove an entity from a collection
+1. [removeAllNotLoadedEntities](#mremoveallnotloadedentities)
+1. [toArray](#mtoarray) - Convert collection to array
+1. [updateEntitiesCache](#mupdateentitiescache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L50)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
+$docRendererHelper | [\BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/EntityDocRenderer/EntityDocRendererHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L190)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Add an entity to the collection
-
Add an entity to the collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
Throws:
-
-
-
-
-
-
-
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+
+---
+
+
# `clearOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L28)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function clearOperationsLogCollection(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `filterByInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L244)
```php
public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaces |
- string[] |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByNameRegularExpression` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L321)
```php
public function filterByNameRegularExpression(string $regexPattern): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only entities whose names match the regular expression
-
Get a copy of the current collection with only entities whose names match the regular expression
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $regexPattern |
- string |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$regexPattern | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `filterByParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L270)
```php
public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassNames |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByPaths` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L298)
```php
public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $paths |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$paths | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `findEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L118)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function findEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Find an entity in a collection
+
+***Parameters:***
-
Find an entity in a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- - |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
+
+---
+
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L86)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from a collection (only previously added)
-
Get an entity from a collection (only previously added)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
-
-
-
-
+---
+
# `getEntityCollectionName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L66)
```php
public function getEntityCollectionName(): string;
```
+Get collection name
-
Get collection name
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- getEntityLinkData
- :warning: Is internal | source code
-
+---
+
# `getEntityLinkData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L508)
```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$rawLink | [string](https://www.php.net/manual/en/language.types.string.php) | Raw link to an entity or entity element |
+$defaultEntityName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Entity name to use if the link does not contain a valid or existing entity name,
+ but only a cursor on an entity element |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rawLink |
- string |
- Raw link to an entity or entity element |
-
-
- $defaultEntityName |
- string | null |
- Entity name to use if the link does not contain a valid or existing entity name,
- but only a cursor on an entity element |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `getLoadedOrCreateNew` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L102)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from the collection or create a new one if it has not yet been added
-
Get an entity from the collection or create a new one if it has not yet been added
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
See:
-
-
-
-
-
-
+***Parameters:***
-```php
-public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
-```
-
-
Get a copy of the current collection with only abstract classes
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Links:***
+- [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface::isEntityDataCanBeLoaded()](RootEntityInterface.md#misentitydatacanbeloaded)
+---
-
Throws:
-
+
# `getOnlyAbstractClasses` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L388)
+```php
+public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get a copy of the current collection with only abstract classes
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `getOnlyInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L338)
```php
public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only instantiable entities
-
Get a copy of the current collection with only instantiable entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getOnlyInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L354)
```php
public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only interfaces
-
Get a copy of the current collection with only interfaces
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOnlyTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L370)
```php
public function getOnlyTraits(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only traits
-
Get a copy of the current collection with only traits
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getOperationsLogCollection(): \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLogOperation/OperationsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- internalFindEntity
- :warning: Is internal | source code
-
+---
+
# `internalFindEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L421)
```php
public function internalFindEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
If the request refers to multiple existing entities and if unsafe keys are allowed,
- a warning will be shown and the first entity found will be used. |
-
-
- $useUnsafeKeys |
- bool |
- Whether to use search keys that can be used to find several entities |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+ a warning will be shown and the first entity found will be used. |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Whether to use search keys that can be used to find several entities |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
-
-
Examples of using:
-
+***Examples of using:***
```php
$entitiesCollection->findEntity('App'); // class name
$entitiesCollection->findEntity('BumbleDocGen\Console\App'); // class with namespace
@@ -889,318 +358,118 @@ $entitiesCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen
$entitiesCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/App.php'); // source link
```
-
-
-
-
-
-- #
- internalGetLoadedOrCreateNew
- :warning: Is internal | source code
-
+---
+
# `internalGetLoadedOrCreateNew` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L214)
```php
public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `loadEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L100)
```php
public function loadEntities(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection $sourceLocatorsCollection, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface|null $filters = null, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+Load entities into a collection
-
Load entities into a collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- loadEntitiesByConfiguration
- :warning: Is internal | source code
-
-
-```php
-public function loadEntitiesByConfiguration(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
-```
-
-
Load entities into a collection by configuration
-
-
Parameters:
-
-
+***Parameters:***
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
+| Name | Type | Description |
+|:-|:-|:-|
+$sourceLocatorsCollection | [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php) | - |
+$filters | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `removeAllNotLoadedEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L132)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function removeAllNotLoadedEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `toArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L127)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function toArray(): array;
```
+Convert collection to array
-
Convert collection to array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- updateEntitiesCache
- :warning: Is internal | source code
-
+---
+
# `updateEntitiesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L97)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function updateEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/PhpHandlerSettings.md b/docs/tech/02_parser/classes/PhpHandlerSettings.md
index b3acb783..400be619 100644
--- a/docs/tech/02_parser/classes/PhpHandlerSettings.md
+++ b/docs/tech/02_parser/classes/PhpHandlerSettings.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+PhpHandlerSettings
+---
+# [PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L21) class:
```php
namespace BumbleDocGen\LanguageHandler\Php;
@@ -14,498 +14,171 @@ namespace BumbleDocGen\LanguageHandler\Php;
final class PhpHandlerSettings
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getClassConstantEntityFilter
-
--
- getClassEntityFilter
-
--
- getComposerConfigFile
-
--
- getComposerVendorDir
-
--
- getCustomTwigFilters
-
--
- getCustomTwigFunctions
-
--
- getEntityDocRenderersCollection
-
--
- getFileSourceBaseUrl
-
--
- getMethodEntityFilter
-
--
- getPropertyEntityFilter
-
--
- getPsr4Map
-
--
- getUseComposerAutoload
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [changePropRefsInternalLinksMode](#mchangeproprefsinternallinksmode)
+1. [getClassConstantEntityFilter](#mgetclassconstantentityfilter)
+1. [getClassEntityFilter](#mgetclassentityfilter)
+1. [getComposerConfigFile](#mgetcomposerconfigfile)
+1. [getComposerVendorDir](#mgetcomposervendordir)
+1. [getCustomTwigFilters](#mgetcustomtwigfilters)
+1. [getCustomTwigFunctions](#mgetcustomtwigfunctions)
+1. [getEntityDocRenderersCollection](#mgetentitydocrendererscollection)
+1. [getFileSourceBaseUrl](#mgetfilesourcebaseurl)
+1. [getMethodEntityFilter](#mgetmethodentityfilter)
+1. [getPropRefsInternalLinksMode](#mgetproprefsinternallinksmode) - If `true` - parameters and properties in class documents refer to generated documents and not to external sources
+1. [getPropertyEntityFilter](#mgetpropertyentityfilter)
+1. [getPsr4Map](#mgetpsr4map)
+1. [getUseComposerAutoload](#mgetusecomposerautoload)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L26)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
-
Parameters:
+---
-
+
# `changePropRefsInternalLinksMode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L175)
+```php
+public function changePropRefsInternalLinksMode(bool $propRefsInternalLinksMode): void;
+```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$propRefsInternalLinksMode | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `getClassConstantEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L63)
```php
public function getClassConstantEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getClassEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L43)
```php
public function getClassEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getComposerConfigFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L199)
```php
public function getComposerConfigFile(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getComposerVendorDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L216)
```php
public function getComposerVendorDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCustomTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L273)
```php
public function getCustomTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCustomTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L250)
```php
public function getCustomTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEntityDocRenderersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L123)
```php
public function getEntityDocRenderersCollection(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRenderersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getFileSourceBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L144)
```php
public function getFileSourceBaseUrl(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getMethodEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L83)
```php
public function getMethodEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
+
# `getPropRefsInternalLinksMode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L162)
+```php
+public function getPropRefsInternalLinksMode(): bool;
+```
+If `true` - parameters and properties in class documents refer to generated documents and not to external sources
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `getPropertyEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L103)
```php
public function getPropertyEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPsr4Map` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L232)
```php
public function getPsr4Map(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getUseComposerAutoload` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L183)
```php
public function getUseComposerAutoload(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/ProjectParser.md b/docs/tech/02_parser/classes/ProjectParser.md
index 4b1e91cd..3ca2966a 100644
--- a/docs/tech/02_parser/classes/ProjectParser.md
+++ b/docs/tech/02_parser/classes/ProjectParser.md
@@ -1,223 +1,81 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+ProjectParser
+---
+# [ProjectParser](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php#L21) class:
```php
namespace BumbleDocGen\Core\Parser;
final class ProjectParser
```
+Entity for project parsing using source locators
-Entity for project parsing using source locators
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
+## Initialization methods
-
--
- getEntityCollectionForPL
-
--
- getRootEntityCollectionsGroup
-
--
- parse
-
-
+1. [__construct](#m-construct)
+## Methods
+1. [getEntityCollectionForPL](#mgetentitycollectionforpl)
+1. [getRootEntityCollectionsGroup](#mgetrootentitycollectionsgroup)
+1. [parse](#mparse)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php#L23)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getEntityCollectionForPL` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php#L58)
```php
public function getEntityCollectionForPL(string $plHandlerClassName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$plHandlerClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $plHandlerClassName |
- string |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getRootEntityCollectionsGroup` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php#L46)
```php
public function getRootEntityCollectionsGroup(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup
-
-
-
-
-
-
-
-
+
# `parse` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php#L37)
```php
public function parse(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionGroupLoadEntitiesResult;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionGroupLoadEntitiesResult
-
-
-
Throws:
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionGroupLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionGroupLoadEntitiesResult.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/PropertyEntitiesCollection.md b/docs/tech/02_parser/classes/PropertyEntitiesCollection.md
index c759783c..5fbe018c 100644
--- a/docs/tech/02_parser/classes/PropertyEntitiesCollection.md
+++ b/docs/tech/02_parser/classes/PropertyEntitiesCollection.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+PropertyEntitiesCollection
+---
+# [PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property;
@@ -14,400 +15,154 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property;
final class PropertyEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [add](#madd) - Add an entity to a collection
+1. [get](#mget) - Get the loaded property entity if it exists
+1. [getIterator](#mgetiterator)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadPropertyEntities](#mloadpropertyentities) - Load property entities into the collection according to the project configuration
+1. [remove](#mremove) - Remove an entity from a collection
+1. [unsafeGet](#munsafeget) - Get the property entity if it exists. If the property exists but has not been loaded into the collection, a new entity object will be created
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
- - Add an entity to a collection
--
- get
- - Get the loaded property entity if it exists
--
- getIterator
-
--
- has
- - Check if an entity has been added to the collection
--
- isEmpty
- - Check if the collection is empty or not
--
- loadPropertyEntities
- - Load property entities into the collection according to the project configuration
--
- remove
- - Remove an entity from a collection
--
- unsafeGet
- - Get the property entity if it exists. If the property exists but has not been loaded into the collection, a new entity object will be created
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php#L17)
```php
public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php#L58)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity $propertyEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Add an entity to a collection
-
Add an entity to a collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
-
-
-
-
+***Parameters:***
-```php
-public function get(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php) | Entity to be added to the collection |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Replace an entity with a new one if one has already been loaded previously |
-
Get the loaded property entity if it exists
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- Property entity name |
-
-
-
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php#L74)
+```php
+public function get(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
+```
+Get the loaded property entity if it exists
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | Property entity name |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L11)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-- #
- loadPropertyEntities
- :warning: Is internal | source code
-
-
+
# `loadPropertyEntities` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php#L35)
```php
public function loadPropertyEntities(): void;
```
+Load property entities into the collection according to the project configuration
-
Load property entities into the collection according to the project configuration
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `unsafeGet` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php#L90)
```php
public function unsafeGet(string $objectName): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity if it exists. If the property exists but has not been loaded into the collection, a new entity object will be created
-
Get the property entity if it exists. If the property exists but has not been loaded into the collection, a new entity object will be created
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- Property entity name |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/PropertyEntity.md b/docs/tech/02_parser/classes/PropertyEntity.md
index fe25d5b0..b2ca8024 100644
--- a/docs/tech/02_parser/classes/PropertyEntity.md
+++ b/docs/tech/02_parser/classes/PropertyEntity.md
@@ -1,1585 +1,611 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+PropertyEntity
+---
+# [PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L28) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property;
class PropertyEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Class property entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDefaultValue
- - Get the compiled default value of a property
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a property's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
- - Get the name of the class in which this property is implemented
--
- getModifiersString
- - Get a text representation of property modifiers
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Namespace of the class that contains this property
--
- getObjectId
- - Get entity unique ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntity
-
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the beginning of the entity code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getType
- - Get current property type
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isImplementedInParentClass
- - Check if this property is implemented in the parent class
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a private is a public private
--
- isProtected
- - Check if a protected is a public protected
--
- isPublic
- - Check if a property is a public property
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class property entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDefaultValue](#mgetdefaultvalue) - Get the compiled default value of a property
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a property's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname) - Get the name of the class in which this property is implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of property modifiers
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Namespace of the class that contains this property
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntity](#mgetrootentity)
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the entity code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getType](#mgettype) - Get current property type
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isImplementedInParentClass](#misimplementedinparentclass) - Check if this property is implemented in the parent class
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a private is a public private
+1. [isProtected](#misprotected) - Check if a protected is a public protected
+1. [isPublic](#mispublic) - Check if a property is a public property
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L59)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $propertyName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L86)
```php
public function getAst(): \PhpParser\Node\Stmt\Property;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Property
-
+***Return value:*** [\PhpParser\Node\Stmt\Property](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Property.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L370)
```php
public function getDefaultValue(): string|array|int|bool|null|float;
```
+Get the compiled default value of a property
-
Get the compiled default value of a property
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Parameters: not specified
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L135)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L352)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a property's code in a file
-
Get the line number of the end of a property's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L207)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L199)
```php
public function getImplementingClassName(): string;
```
+Get the name of the class in which this property is implemented
-
Get the name of the class in which this property is implemented
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L265)
```php
public function getModifiersString(): string;
```
+Get a text representation of property modifiers
-
Get a text representation of property modifiers
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L171)
```php
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L189)
```php
public function getNamespaceName(): string;
```
+Namespace of the class that contains this property
-
Namespace of the class that contains this property
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L217)
```php
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L76)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L123)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L179)
```php
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L337)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the entity code in a file
-
Get the line number of the beginning of the entity code in a file
-
-
Parameters: not specified
-
-
Return value: int
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
-
-
-
-
-
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L231)
```php
public function getType(): string;
```
+Get current property type
-
Get current property type
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
--
- \Exception
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isImplementedInParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L291)
```php
public function isImplementedInParentClass(): bool;
```
+Check if this property is implemented in the parent class
-
Check if this property is implemented in the parent class
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L327)
```php
public function isPrivate(): bool;
```
+Check if a private is a public private
-
Check if a private is a public private
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L315)
```php
public function isProtected(): bool;
```
+Check if a protected is a public protected
-
Check if a protected is a public protected
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L303)
```php
public function isPublic(): bool;
```
+Check if a property is a public property
-
Check if a property is a public property
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/RecursiveDirectoriesSourceLocator.md b/docs/tech/02_parser/classes/RecursiveDirectoriesSourceLocator.md
index 5e15b9ba..9ba79b42 100644
--- a/docs/tech/02_parser/classes/RecursiveDirectoriesSourceLocator.md
+++ b/docs/tech/02_parser/classes/RecursiveDirectoriesSourceLocator.md
@@ -1,117 +1,52 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Source locators](../sourceLocator.md) **/**
+RecursiveDirectoriesSourceLocator
+---
+# [RecursiveDirectoriesSourceLocator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/RecursiveDirectoriesSourceLocator.php#L10) class:
```php
namespace BumbleDocGen\Core\Parser\SourceLocator;
final class RecursiveDirectoriesSourceLocator extends \BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator implements \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface
```
+Loads all files from the specified directories, which are traversed recursively
-Loads all files from the specified directories, which are traversed recursively
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getFinder
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getFinder](#mgetfinder)
+## Methods details:
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/RecursiveDirectoriesSourceLocator.php#L12)
```php
public function __construct(array $directories, array $exclude = [], bool $abortExecutionIfPartOfDirsNotExists = true);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$directories | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$exclude | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$abortExecutionIfPartOfDirsNotExists | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $directories |
- array |
- - |
-
-
- $exclude |
- array |
- - |
-
-
- $abortExecutionIfPartOfDirsNotExists |
- bool |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getFinder` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/BaseSourceLocator.php#L19)
```php
// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator
public function getFinder(): \Symfony\Component\Finder\Finder;
```
+***Return value:*** [\Symfony\Component\Finder\Finder](https://github.com/symfony/finder/blob/master/Finder.php)
-
-
Parameters: not specified
-
-
Return value: \Symfony\Component\Finder\Finder
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/RootEntityCollection.md b/docs/tech/02_parser/classes/RootEntityCollection.md
index 9c667f81..abbc8612 100644
--- a/docs/tech/02_parser/classes/RootEntityCollection.md
+++ b/docs/tech/02_parser/classes/RootEntityCollection.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+RootEntityCollection
+---
+# [RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L18) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
@@ -14,548 +15,221 @@ namespace BumbleDocGen\Core\Parser\Entity;
abstract class RootEntityCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate
```
-
-
-
-
-
-
-
-
-Methods:
-
-
--
- findEntity
- - Find an entity in a collection
--
- get
- - Get an entity from a collection (only previously added)
--
- getEntityCollectionName
- - Get collection name
--
- getEntityLinkData
-
--
- getIterator
-
--
- getLoadedOrCreateNew
- - Get an entity from the collection or create a new one if it has not yet been added
--
- has
- - Check if an entity has been added to the collection
--
- isEmpty
- - Check if the collection is empty or not
--
- loadEntities
-
--
- loadEntitiesByConfiguration
-
--
- remove
- - Remove an entity from a collection
--
- removeAllNotLoadedEntities
-
--
- toArray
- - Convert collection to array
--
- updateEntitiesCache
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Methods
+
+1. [findEntity](#mfindentity) - Find an entity in a collection
+1. [get](#mget) - Get an entity from a collection (only previously added)
+1. [getEntityCollectionName](#mgetentitycollectionname) - Get collection name
+1. [getEntityLinkData](#mgetentitylinkdata)
+1. [getIterator](#mgetiterator)
+1. [getLoadedOrCreateNew](#mgetloadedorcreatenew) - Get an entity from the collection or create a new one if it has not yet been added
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadEntities](#mloadentities)
+1. [loadEntitiesByConfiguration](#mloadentitiesbyconfiguration)
+1. [remove](#mremove) - Remove an entity from a collection
+1. [removeAllNotLoadedEntities](#mremoveallnotloadedentities)
+1. [toArray](#mtoarray) - Convert collection to array
+1. [updateEntitiesCache](#mupdateentitiescache)
+
+## Methods details:
+
+
# `findEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L76)
```php
public function findEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Find an entity in a collection
-
Find an entity in a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- - |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
+***Parameters:***
-```php
-public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
-```
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Get an entity from a collection (only previously added)
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L49)
+```php
+public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
+```
+Get an entity from a collection (only previously added)
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
+---
+
# `getEntityCollectionName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L39)
```php
public function getEntityCollectionName(): string;
```
+Get collection name
-
Get collection name
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getEntityLinkData
- :warning: Is internal | source code
-
+---
+
# `getEntityLinkData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L90)
```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rawLink | [string](https://www.php.net/manual/en/language.types.string.php) | Raw link to an entity or entity element |
+$defaultEntityName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Entity name to use if the link does not contain a valid or existing entity name,
+ but only a cursor on an entity element |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rawLink |
- string |
- Raw link to an entity or entity element |
-
-
- $defaultEntityName |
- string | null |
- Entity name to use if the link does not contain a valid or existing entity name,
- but only a cursor on an entity element |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L11)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
+
# `getLoadedOrCreateNew` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L67)
+```php
+public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
+```
+Get an entity from the collection or create a new one if it has not yet been added
+***Parameters:***
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-```php
-public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
-```
+***Links:***
+- [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface::isEntityDataCanBeLoaded()](RootEntityInterface.md#misentitydatacanbeloaded)
-
Get an entity from the collection or create a new one if it has not yet been added
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `loadEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L28)
```php
public function loadEntities(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection $sourceLocatorsCollection, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface|null $filters = null, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$sourceLocatorsCollection | [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php) | - |
+$filters | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
+---
+
+
# `loadEntitiesByConfiguration` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L26)
```php
public function loadEntitiesByConfiguration(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
-
-
-
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-
+
# `removeAllNotLoadedEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L132)
```php
public function removeAllNotLoadedEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `toArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L127)
```php
public function toArray(): array;
```
+Convert collection to array
-
Convert collection to array
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- updateEntitiesCache
- :warning: Is internal | source code
-
-
+
# `updateEntitiesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L97)
```php
public function updateEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/RootEntityInterface.md b/docs/tech/02_parser/classes/RootEntityInterface.md
index 2d506c9b..e5c932ac 100644
--- a/docs/tech/02_parser/classes/RootEntityInterface.md
+++ b/docs/tech/02_parser/classes/RootEntityInterface.md
@@ -1,469 +1,217 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+RootEntityInterface
+---
+# [RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L11) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
interface RootEntityInterface extends \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
+Since the documentation generator supports several programming languages,
+their entities need to correspond to the same interfaces
-Since the documentation generator supports several programming languages,
-their entities need to correspond to the same interfaces
-
-
-
-
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getEntityDependencies
-
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getName
- - Full name of the entity
--
- getObjectId
- - Entity object ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- isEntityCacheOutdated
-
--
- isEntityDataCanBeLoaded
- - Checking if it is possible to get the entity data
--
- isEntityNameValid
- - Check if entity name is valid
--
- isExternalLibraryEntity
- - The entity is loaded from a third party library and should not be treated the same as a standard one
--
- isInGit
- - The entity file is in the git repository
--
- normalizeClassName
-
-
+## Methods
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getName](#mgetname) - Full name of the entity
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded) - Checking if it is possible to get the entity data
+1. [isEntityNameValid](#misentitynamevalid) - Check if entity name is valid
+1. [isExternalLibraryEntity](#misexternallibraryentity) - The entity is loaded from a third party library and should not be treated the same as a standard one
+1. [isInGit](#misingit) - The entity file is in the git repository
+1. [normalizeClassName](#mnormalizeclassname)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L53)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L33)
```php
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L40)
```php
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileSourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L42)
```php
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L30)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L16)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L37)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L58)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L23)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+Checking if it is possible to get the entity data
-
Checking if it is possible to get the entity data
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L18)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if entity name is valid
-
Check if entity name is valid
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isExternalLibraryEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L28)
```php
public function isExternalLibraryEntity(): bool;
```
+The entity is loaded from a third party library and should not be treated the same as a standard one
-
The entity is loaded from a third party library and should not be treated the same as a standard one
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isInGit` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L38)
```php
public function isInGit(): bool;
```
+The entity file is in the git repository
-
The entity file is in the git repository
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L13)
```php
public static function normalizeClassName(string $name): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/SingleFileSourceLocator.md b/docs/tech/02_parser/classes/SingleFileSourceLocator.md
index 8ec0205f..9627512f 100644
--- a/docs/tech/02_parser/classes/SingleFileSourceLocator.md
+++ b/docs/tech/02_parser/classes/SingleFileSourceLocator.md
@@ -1,107 +1,50 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Source locators](../sourceLocator.md) **/**
+SingleFileSourceLocator
+---
+# [SingleFileSourceLocator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SingleFileSourceLocator.php#L10) class:
```php
namespace BumbleDocGen\Core\Parser\SourceLocator;
final class SingleFileSourceLocator extends \BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator implements \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface
```
+Loads one specific file by its path
-Loads one specific file by its path
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getFinder
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getFinder](#mgetfinder)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SingleFileSourceLocator.php#L12)
```php
public function __construct(string $filename);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$filename | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $filename |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getFinder` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/BaseSourceLocator.php#L19)
```php
// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator
public function getFinder(): \Symfony\Component\Finder\Finder;
```
+***Return value:*** [\Symfony\Component\Finder\Finder](https://github.com/symfony/finder/blob/master/Finder.php)
-
-
Parameters: not specified
-
-
Return value: \Symfony\Component\Finder\Finder
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/SourceLocatorInterface.md b/docs/tech/02_parser/classes/SourceLocatorInterface.md
index 65dbdcd1..6ea09a51 100644
--- a/docs/tech/02_parser/classes/SourceLocatorInterface.md
+++ b/docs/tech/02_parser/classes/SourceLocatorInterface.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Source locators](../sourceLocator.md) **/**
+SourceLocatorInterface
+---
+# [SourceLocatorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorInterface.php#L9) class:
```php
namespace BumbleDocGen\Core\Parser\SourceLocator;
@@ -14,48 +15,17 @@ namespace BumbleDocGen\Core\Parser\SourceLocator;
interface SourceLocatorInterface
```
+## Methods
+1. [getFinder](#mgetfinder)
+## Methods details:
-
-
-
-
-
-Methods:
-
-
--
- getFinder
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getFinder` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorInterface.php#L11)
```php
public function getFinder(): null|\Symfony\Component\Finder\Finder;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\Symfony\Component\Finder\Finder](https://github.com/symfony/finder/blob/master/Finder.php)
-
-
Parameters: not specified
-
-
Return value: null |
\Symfony\Component\Finder\Finder
-
-
-
-
+---
diff --git a/docs/tech/02_parser/classes/TraitEntity.md b/docs/tech/02_parser/classes/TraitEntity.md
index c3d74282..f5286785 100644
--- a/docs/tech/02_parser/classes/TraitEntity.md
+++ b/docs/tech/02_parser/classes/TraitEntity.md
@@ -1,3438 +1,1347 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entities and entities collections](../entity.md) **/**
+TraitEntity
+---
+# [TraitEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L12) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class TraitEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Trait
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Trait
+
+***Links:***
+- [https://www.php.net/manual/en/language.oop5.traits.php](https://www.php.net/manual/en/language.oop5.traits.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Return value: string |
array |
int |
bool |
null |
float
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getConstantEntitiesCollection()](ClassLikeEntity.md#mgetconstantentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
-
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
+***Parameters:***
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L25)
```php
public function getInterfaceNames(): array;
```
+Get a list of class interface names
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethods` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1162)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethods(): array;
```
+Get all methods that are available according to the configuration as an array
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L33)
```php
public function getModifiersString(): string;
```
+Get entity modifiers as a string
-
Get entity modifiers as a string
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getNamespaceName(): string;
```
+Get the entity namespace name
-
Get the entity namespace name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the entity of the parent class if it exists
-
Get the entity of the parent class if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Get a list of parent class entities
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassName(): null|string;
```
+Get the name of the parent class entity if it exists
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
-
-
-
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Get additional information added using the plugin
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: mixed
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
-
-
-
-
-
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
+***Parameters:***
-
Throws:
-
--
- \DI\DependencyException
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
--
- \DI\NotFoundException
-
-
-
-
-
-
-
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L386)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getStartLine(): int;
```
+Get the line number of the start of a class code in a file
-
Get the line number of the start of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getTraits(): array;
```
+Get a list of trait entities of the current class
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Get a list of class traits names
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if a constant exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
--
- \Exception
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasMethod(string $methodName, bool $unsafe = false): bool;
```
+Check if a method exists in a class
-
Check if a method exists in a class
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L41)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L17)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: string
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/TrueCondition.md b/docs/tech/02_parser/classes/TrueCondition.md
index 99aaf064..033e6975 100644
--- a/docs/tech/02_parser/classes/TrueCondition.md
+++ b/docs/tech/02_parser/classes/TrueCondition.md
@@ -1,78 +1,38 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+TrueCondition
+---
+# [TrueCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/TrueCondition.php#L13) class:
```php
namespace BumbleDocGen\Core\Parser\FilterCondition\CommonFilterCondition;
final class TrueCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+True conditions, any object is available
-True conditions, any object is available
-
-
-
-
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/CommonFilterCondition/TrueCondition.php#L15)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/VisibilityCondition.md b/docs/tech/02_parser/classes/VisibilityCondition.md
index 72274d8b..2a418c5d 100644
--- a/docs/tech/02_parser/classes/VisibilityCondition.md
+++ b/docs/tech/02_parser/classes/VisibilityCondition.md
@@ -1,122 +1,54 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+VisibilityCondition
+---
+# [VisibilityCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/VisibilityCondition.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\ClassConstantFilterCondition;
final class VisibilityCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Constant access modifier check
-Constant access modifier check
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/VisibilityCondition.php#L19)
```php
public function __construct(string ...$visibilityModifiers);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$visibilityModifiers
(variadic) | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $visibilityModifiers (variadic) |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/ClassConstantFilterCondition/VisibilityCondition.php#L24)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/VisibilityCondition_2.md b/docs/tech/02_parser/classes/VisibilityCondition_2.md
index d00e2f85..a7e85599 100644
--- a/docs/tech/02_parser/classes/VisibilityCondition_2.md
+++ b/docs/tech/02_parser/classes/VisibilityCondition_2.md
@@ -1,122 +1,54 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+VisibilityCondition
+---
+# [VisibilityCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/VisibilityCondition.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\MethodFilterCondition;
final class VisibilityCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Method access modifier check
-Method access modifier check
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/VisibilityCondition.php#L19)
```php
public function __construct(string ...$visibilityModifiers);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$visibilityModifiers
(variadic) | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $visibilityModifiers (variadic) |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/MethodFilterCondition/VisibilityCondition.php#L24)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/classes/VisibilityCondition_3.md b/docs/tech/02_parser/classes/VisibilityCondition_3.md
index fc485d02..ee1cfa7b 100644
--- a/docs/tech/02_parser/classes/VisibilityCondition_3.md
+++ b/docs/tech/02_parser/classes/VisibilityCondition_3.md
@@ -1,122 +1,54 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+[Entity filter conditions](../entityFilterCondition.md) **/**
+VisibilityCondition
+---
+# [VisibilityCondition](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/VisibilityCondition.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition;
final class VisibilityCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
```
+Property access modifier check
-Property access modifier check
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- canAddToCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [canAddToCollection](#mcanaddtocollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/VisibilityCondition.php#L19)
```php
public function __construct(string ...$visibilityModifiers);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$visibilityModifiers
(variadic) | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $visibilityModifiers (variadic) |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `canAddToCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/FilterCondition/PropertyFilterCondition/VisibilityCondition.php#L24)
```php
public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterface $entity): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\EntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
+---
diff --git a/docs/tech/02_parser/entity.md b/docs/tech/02_parser/entity.md
index 5491e99f..17fd1306 100644
--- a/docs/tech/02_parser/entity.md
+++ b/docs/tech/02_parser/entity.md
@@ -1,147 +1,83 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Parser](readme.md) **/**
+Entities and entities collections
-
+---
+
+
+# Entities and entities collections
Entities are organized outcomes from parsing source code.
They help easily extract details about specific items from templates, allowing users to quickly access and display the information they need.
Entities are always handled through collections. Collections are the result of the project parsing process and are available in both documentation templates and code.
-
+## Examples of using collections in twig templates
* Passing a collection to a function:
```twig
- {{ printEntityCollectionAsList(phpEntities) }}
+{{ printEntityCollectionAsList(phpEntities) }}
```
-
* Filtering a collection and passing it to a function:
```twig
- {{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['BumbleDocGen\Core\Parser\Entity\EntityInterface'])) }}
+{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['BumbleDocGen\Core\Parser\Entity\EntityInterface'])) }}
```
-
* Saving a filtered collection to a variable:
```twig
- {{ {% set filteredCollection = phpEntities.getOnlyInstantiable() %} }}
+{% set filteredCollection = phpEntities.getOnlyInstantiable() %}
```
-
* Using a collection in a for loop:
```twig
- {% for someClassEntity in phpEntities %}
- * {{ someClassEntity.getName() }}
- {% endfor %}
+{% for someClassEntity in phpEntities %}
+ * {{ someClassEntity.getName() }}
+{% endfor %}
```
-
* Output of all methods of all found entities in `className::methodName()` format:
```twig
- {% for someClassEntity in phpEntities %}
- {% for methodEntity in someClassEntity.getMethodEntitiesCollection() %}
- * {{ someClassEntity.getName() }}::{{ methodEntity.getName() }}()
- {% endfor %}
- {% endfor %}
+{% for someClassEntity in phpEntities %}
+ {% for methodEntity in someClassEntity.getMethodEntitiesCollection() %}
+ * {{ someClassEntity.getName() }}::{{ methodEntity.getName() }}()
+ {% endfor %}
+{% endfor %}
```
-
-
+## Root entities collections
To further facilitate the handling of these entities, we utilize entity collections.
These collections not only group relevant entities together but also provide convenient methods for filtering and manipulating these entities.
-The root collections (RootEntityCollection), which are directly accessible in your templates, are as follows:
-
-
-
- Collection class |
- Name in twig template |
- PL |
- Description |
-
-
- PhpEntitiesCollection |
- phpEntities |
- PHP |
- Collection of php root entities |
-
-
-
-
-
-Following is the list of available entities that are consistent with EntityInterface and can be created.
+The root collections ([RootEntityCollection](classes/RootEntityCollection.md)), which are directly accessible in your templates, are as follows:
+
+| Collection class | Name in twig template | PL | Description |
+|-|-|-|-|
+| [PhpEntitiesCollection](classes/PhpEntitiesCollection.md) | **phpEntities** | PHP | Collection of php root entities |
+
+## Available entities
+
+Following is the list of available entities that are consistent with [EntityInterface](classes/EntityInterface.md) and can be created.
These classes are a convenient wrapper for accessing data in templates:
-
-
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+| Entity name | Collection name | Is root | PL | Description |
+|-|-|-|-|-|
+| [ClassEntity](classes/ClassEntity.md) | [PhpEntitiesCollection](classes/PhpEntitiesCollection.md) | yes | PHP | PHP Class |
+| [EnumEntity](classes/EnumEntity.md) | [PhpEntitiesCollection](classes/PhpEntitiesCollection.md) | yes | PHP | Enumeration |
+| [InterfaceEntity](classes/InterfaceEntity.md) | [PhpEntitiesCollection](classes/PhpEntitiesCollection.md) | yes | PHP | Object interface |
+| [TraitEntity](classes/TraitEntity.md) | [PhpEntitiesCollection](classes/PhpEntitiesCollection.md) | yes | PHP | Trait |
+| [ClassConstantEntity](classes/ClassConstantEntity.md) | [ClassConstantEntitiesCollection](classes/ClassConstantEntitiesCollection.md) | no | PHP | Class constant entity |
+| [DynamicMethodEntity](classes/DynamicMethodEntity.md) | [MethodEntitiesCollection](classes/MethodEntitiesCollection.md) | no | PHP | Method obtained by parsing the "method" annotation |
+| [MethodEntity](classes/MethodEntity.md) | [MethodEntitiesCollection](classes/MethodEntitiesCollection.md) | no | PHP | Class method entity |
+| [PropertyEntity](classes/PropertyEntity.md) | [PropertyEntitiesCollection](classes/PropertyEntitiesCollection.md) | no | PHP | Class property entity |
+
+
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/entityFilterCondition.md b/docs/tech/02_parser/entityFilterCondition.md
index c8dbf646..e69a3381 100644
--- a/docs/tech/02_parser/entityFilterCondition.md
+++ b/docs/tech/02_parser/entityFilterCondition.md
@@ -1,15 +1,21 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Parser](readme.md) **/**
+Entity filter conditions
-
+---
+
+
+# Entity filter conditions
Filters serve as a foundational mechanism within our documentation generator, dictating which segments of the source code are selected during the initial parsing phase.
These rules facilitate a strategic extraction of elements, such as classes, methods, or constants, from the underlying codebase.
By implementing these filters, users are endowed with the capability to customize the documentation output, ensuring that it precisely aligns with their requirements and expectations.
This level of granularity not only streamlines the documentation process but also guarantees that the resultant documents are devoid of superfluous details, focusing solely on pertinent information.
-All filter conditions implement the ConditionInterface interface.
+All filter conditions implement the [ConditionInterface](classes/ConditionInterface.md) interface.
-
+## Mechanism for adding entities to the collection
For each language handler, according to the configuration, the following scheme is applicable:
@@ -31,7 +37,7 @@ flowchart LR
The diagram shows the mechanism for adding root entities, but this also applies to the attributes of each entity,
for example, for PHP there are rules for checking the possibility of adding methods, properties and constants.
-
+## Filter conditions configuration
Filter conditions are configured separately for language handlers.
@@ -63,19 +69,43 @@ language_handlers:
- class: \BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition\OnlyFromCurrentClassCondition
```
-
+## Available filters
Common filtering conditions that are available for any entity:
-
+- [FalseCondition](classes/FalseCondition.md) - False conditions, any object is not available
+- [FileTextContainsCondition](classes/FileTextContainsCondition.md) - Checking if a file contains a substring
+- [LocatedInCondition](classes/LocatedInCondition.md) - Checking the existence of an entity in the specified directories
+- [LocatedNotInCondition](classes/LocatedNotInCondition.md) - Checking the existence of an entity not in the specified directories
+- [TrueCondition](classes/TrueCondition.md) - True conditions, any object is available
+- [ConditionGroup](classes/ConditionGroup.md) - Filter condition to group other filter conditions. A group can have an OR/AND condition test; In the case of OR, it is enough to successfully check at least one condition, in the case of AND, all checks must be successfully completed.
-Filter condition for working with entities PHP language handler:
-
-
+Filter condition for working with entities PHP language handler:
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+| Group name | Class short name | Description |
+|-|-|-|
+| **ClassConstantFilterCondition** | [IsPrivateCondition](classes/IsPrivateCondition.md) | Check is a private constant or not |
+| | [IsProtectedCondition](classes/IsProtectedCondition.md) | Check is a protected constant or not |
+| | [IsPublicCondition](classes/IsPublicCondition.md) | Check is a public constant or not |
+| | [VisibilityCondition](classes/VisibilityCondition.md) | Constant access modifier check |
+| | | |
+| **MethodFilterCondition** | [IsPrivateCondition](classes/IsPrivateCondition_2.md) | Check is a private method or not |
+| | [IsProtectedCondition](classes/IsProtectedCondition_2.md) | Check is a protected method or not |
+| | [IsPublicCondition](classes/IsPublicCondition_2.md) | Check is a public method or not |
+| | [OnlyFromCurrentClassCondition](classes/OnlyFromCurrentClassCondition.md) | Only methods that belong to the current class (not parent) |
+| | [VisibilityCondition](classes/VisibilityCondition_2.md) | Method access modifier check |
+| | | |
+| **PropertyFilterCondition** | [IsPrivateCondition](classes/IsPrivateCondition_3.md) | Check is a private property or not |
+| | [IsProtectedCondition](classes/IsProtectedCondition_3.md) | Check is a protected property or not |
+| | [IsPublicCondition](classes/IsPublicCondition_3.md) | Check is a public property or not |
+| | [OnlyFromCurrentClassCondition](classes/OnlyFromCurrentClassCondition_2.md) | Only properties that belong to the current class (not parent) |
+| | [VisibilityCondition](classes/VisibilityCondition_3.md) | Property access modifier check |
+| | | |
+
+
+
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/readme.md b/docs/tech/02_parser/readme.md
index eb86f695..30192a2a 100644
--- a/docs/tech/02_parser/readme.md
+++ b/docs/tech/02_parser/readme.md
@@ -1,30 +1,47 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+Parser
-
+---
-Most often, we need ProjectParser in order to get a list of entities for documentation.
+
+# Documentation parser
+
+Most often, we need [ProjectParser](classes/ProjectParser.md) in order to get a list of entities for documentation.
But this is not the only use of this tool. The result of the parser's work (a collection of entities) can be used to programmatically analyze the project and perform any operations based on this analysis.
For example, in our documentation generator, we also use the result of the parser in the tasks of generating documentation using AI tools.
You can also use the parser for your own purposes other than generating documentation.
In this section, we show how the parser works and what components it consists of.
-
+## Description of the main components of the parser
+
-
+- [Entities and entities collections](entity.md)
+- [Entity filter conditions](entityFilterCondition.md)
+- [Reflection API](reflectionApi/readme.md)
+ - [Reflection API for PHP](reflectionApi/php/readme.md)
+ - [PHP class constant reflection API](reflectionApi/php/phpClassConstantReflectionApi.md)
+ - [PHP class method reflection API](reflectionApi/php/phpClassMethodReflectionApi.md)
+ - [PHP class property reflection API](reflectionApi/php/phpClassPropertyReflectionApi.md)
+ - [PHP class reflection API](reflectionApi/php/phpClassReflectionApi.md)
+ - [PHP entities collection](reflectionApi/php/phpEntitiesCollection.md)
+ - [PHP enum reflection API](reflectionApi/php/phpEnumReflectionApi.md)
+ - [PHP interface reflection API](reflectionApi/php/phpInterfaceReflectionApi.md)
+ - [PHP trait reflection API](reflectionApi/php/phpTraitReflectionApi.md)
+- [Source locators](sourceLocator.md)
-
+## Starting the parsing process
```php
- $parser = new ProjectParser($configuration, $rootEntityCollectionsGroup);
-
- // Parsing the project and filling RootEntityCollectionsGroup with data
- $this->parser->parse();
- $rootEntityCollectionsGroup = $this->parser->getRootEntityCollectionsGroup();
-```
+$parser = new ProjectParser($configuration, $rootEntityCollectionsGroup);
+// Parsing the project and filling RootEntityCollectionsGroup with data
+$this->parser->parse();
+$rootEntityCollectionsGroup = $this->parser->getRootEntityCollectionsGroup();
+```
-
+## How it works
```mermaid
flowchart TD
@@ -40,6 +57,6 @@ In this section, we show how the parser works and what components it consists of
ReturnResult --> Exit(((Exit)))
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/classes/RootEntityCollectionsGroup.md b/docs/tech/02_parser/reflectionApi/classes/RootEntityCollectionsGroup.md
index ae563dc6..4ea1432c 100644
--- a/docs/tech/02_parser/reflectionApi/classes/RootEntityCollectionsGroup.md
+++ b/docs/tech/02_parser/reflectionApi/classes/RootEntityCollectionsGroup.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+RootEntityCollectionsGroup
+---
+# [RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L10) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
@@ -14,320 +15,122 @@ namespace BumbleDocGen\Core\Parser\Entity;
final class RootEntityCollectionsGroup implements \IteratorAggregate
```
+## Methods
+1. [add](#madd)
+1. [clearOperationsLog](#mclearoperationslog)
+1. [get](#mget)
+1. [getIterator](#mgetiterator)
+1. [getOperationsLog](#mgetoperationslog)
+1. [getOperationsLogWithoutDuplicates](#mgetoperationslogwithoutduplicates)
+1. [isFoundEntitiesOperationsLogCacheOutdated](#misfoundentitiesoperationslogcacheoutdated)
+1. [loadByLanguageHandlers](#mloadbylanguagehandlers)
+1. [updateAllEntitiesCache](#mupdateallentitiescache)
+## Methods details:
-
-
-
-
-
-Methods:
-
-
--
- add
-
--
- clearOperationsLog
-
--
- get
-
--
- getIterator
-
--
- getOperationsLog
-
--
- getOperationsLogWithoutDuplicates
-
--
- isFoundEntitiesOperationsLogCacheOutdated
-
--
- loadByLanguageHandlers
-
--
- updateAllEntitiesCache
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L36)
```php
public function add(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
-
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `clearOperationsLog` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L46)
```php
public function clearOperationsLog(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L41)
```php
public function get(string $collectionName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$collectionName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $collectionName |
- string |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
-
-
-
-
-
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L17)
```php
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `getOperationsLog` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L55)
```php
public function getOperationsLog(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getOperationsLogWithoutDuplicates` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L68)
```php
public function getOperationsLogWithoutDuplicates(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-- #
- isFoundEntitiesOperationsLogCacheOutdated
- | source code
-
-
+
# `isFoundEntitiesOperationsLogCacheOutdated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L82)
```php
public function isFoundEntitiesOperationsLogCacheOutdated(array $entitiesCollectionOperationsLog): bool;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entitiesCollectionOperationsLog | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entitiesCollectionOperationsLog |
- array |
- - |
-
-
-
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `loadByLanguageHandlers` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L22)
```php
public function loadByLanguageHandlers(\BumbleDocGen\LanguageHandler\LanguageHandlersCollection $languageHandlersCollection, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionGroupLoadEntitiesResult;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$languageHandlersCollection | [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionGroupLoadEntitiesResult
-
-
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionGroupLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionGroupLoadEntitiesResult.php)
+---
+
+
# `updateAllEntitiesCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php#L96)
```php
public function updateAllEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md
index bf4f2465..b50acec7 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md
@@ -1,1502 +1,607 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP class constant reflection API](../phpClassConstantReflectionApi.md) **/**
+ClassConstantEntity
+---
+# [ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L24) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant;
class ClassConstantEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Class constant entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a constant's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
-
--
- getName
- - Constant name
--
- getNamespaceName
- - Get the name of the namespace where the current class is implemented
--
- getObjectId
- - Get entity unique ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntity
- - Get the class like entity where this constant was obtained
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Constant short name
--
- getStartLine
- - Get the line number of the beginning of the constant code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getValue
- - Get the compiled value of a constant
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a constant is a private constant
--
- isProtected
- - Check if a constant is a protected constant
--
- isPublic
- - Check if a constant is a public constant
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class constant entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a constant's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname)
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of class constant modifiers
+1. [getName](#mgetname) - Constant name
+1. [getNamespaceName](#mgetnamespacename) - Get the name of the namespace where the current class is implemented
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntity](#mgetrootentity) - Get the class like entity where this constant was obtained
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Constant short name
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the constant code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getType](#mgettype) - Get current class constant type
+1. [getValue](#mgetvalue) - Get the compiled value of a constant
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a constant is a private constant
+1. [isProtected](#misprotected) - Check if a constant is a protected constant
+1. [isPublic](#mispublic) - Check if a constant is a public constant
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L55)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $constantName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L93)
```php
public function getAst(): \PhpParser\Node\Stmt\ClassConst;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\ClassConst
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\PhpParser\Node\Stmt\ClassConst](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/ClassConst.php)
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
-
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L129)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
-
-
-
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L275)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a constant's code in a file
-
Get the line number of the end of a constant's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L121)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L113)
```php
public function getImplementingClassName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L169)
+```php
+public function getModifiersString(): string;
+```
+Get a text representation of class constant modifiers
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L137)
```php
public function getName(): string;
```
+Constant name
-
Constant name
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L157)
```php
public function getNamespaceName(): string;
```
+Get the name of the namespace where the current class is implemented
-
Get the name of the namespace where the current class is implemented
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L92)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L83)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity where this constant was obtained
-
Get the class like entity where this constant was obtained
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L75)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L147)
```php
public function getShortName(): string;
```
+Constant short name
-
Constant short name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::getName()](ClassConstantEntity_2.md#mgetname)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L263)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the constant code in a file
-
Get the line number of the beginning of the constant code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L191)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getType(): string;
```
+Get current class constant type
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L290)
```php
public function getValue(): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters: not specified
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L251)
```php
public function isPrivate(): bool;
```
+Check if a constant is a private constant
-
Check if a constant is a private constant
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L239)
```php
public function isProtected(): bool;
```
+Check if a constant is a protected constant
-
Check if a constant is a protected constant
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L227)
```php
public function isPublic(): bool;
```
+Check if a constant is a public constant
-
Check if a constant is a public constant
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity_2.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity_2.md
index 0254d7cc..b69a1610 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity_2.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity_2.md
@@ -1,1502 +1,606 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+ClassConstantEntity
+---
+# [ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L24) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant;
class ClassConstantEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Class constant entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a constant's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
-
--
- getName
- - Constant name
--
- getNamespaceName
- - Get the name of the namespace where the current class is implemented
--
- getObjectId
- - Get entity unique ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntity
- - Get the class like entity where this constant was obtained
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Constant short name
--
- getStartLine
- - Get the line number of the beginning of the constant code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getValue
- - Get the compiled value of a constant
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a constant is a private constant
--
- isProtected
- - Check if a constant is a protected constant
--
- isPublic
- - Check if a constant is a public constant
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class constant entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a constant's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname)
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of class constant modifiers
+1. [getName](#mgetname) - Constant name
+1. [getNamespaceName](#mgetnamespacename) - Get the name of the namespace where the current class is implemented
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntity](#mgetrootentity) - Get the class like entity where this constant was obtained
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Constant short name
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the constant code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getType](#mgettype) - Get current class constant type
+1. [getValue](#mgetvalue) - Get the compiled value of a constant
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a constant is a private constant
+1. [isProtected](#misprotected) - Check if a constant is a protected constant
+1. [isPublic](#mispublic) - Check if a constant is a public constant
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L55)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $constantName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L93)
```php
public function getAst(): \PhpParser\Node\Stmt\ClassConst;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\ClassConst
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\PhpParser\Node\Stmt\ClassConst](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/ClassConst.php)
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
-
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L129)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
-
-
-
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L275)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a constant's code in a file
-
Get the line number of the end of a constant's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L121)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L113)
```php
public function getImplementingClassName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L169)
+```php
+public function getModifiersString(): string;
+```
+Get a text representation of class constant modifiers
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L137)
```php
public function getName(): string;
```
+Constant name
-
Constant name
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L157)
```php
public function getNamespaceName(): string;
```
+Get the name of the namespace where the current class is implemented
-
Get the name of the namespace where the current class is implemented
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L92)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L83)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity where this constant was obtained
-
Get the class like entity where this constant was obtained
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L75)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L147)
```php
public function getShortName(): string;
```
+Constant short name
-
Constant short name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::getName()](ClassConstantEntity_2.md#mgetname)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L263)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the constant code in a file
-
Get the line number of the beginning of the constant code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L191)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getType(): string;
```
+Get current class constant type
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L290)
```php
public function getValue(): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters: not specified
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L251)
```php
public function isPrivate(): bool;
```
+Check if a constant is a private constant
-
Check if a constant is a private constant
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L239)
```php
public function isProtected(): bool;
```
+Check if a constant is a protected constant
-
Check if a constant is a protected constant
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php#L227)
```php
public function isPublic(): bool;
```
+Check if a constant is a public constant
-
Check if a constant is a public constant
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md
index 7401aedc..e1b20340 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md
@@ -1,3463 +1,1354 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP class reflection API](../phpClassReflectionApi.md) **/**
+ClassEntity
+---
+# [ClassEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class ClassEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-PHP Class
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isAttribute
- - Check if a class is an attribute
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+PHP Class
+
+***Links:***
+- [https://www.php.net/manual/en/language.oop5.php](https://www.php.net/manual/en/language.oop5.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isAttribute](#misattribute) - Check if a class is an attribute
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
-
-
Throws:
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
See:
-
-
-
-
-
-
-
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get values only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get values only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfaceNames(): array;
```
+Get a list of class interface names
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
-```
-
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a collection of property entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+public function getMethods(): array;
+```
+Get all methods that are available according to the configuration as an array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
See:
-
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRelativeFileName(): null|string;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
File name relative to project_root configuration parameter
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
-
Return value: null |
string
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L120)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getName(): string;
```
+Full name of the entity
-
Get the collection of root entities to which this entity belongs
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getShortName(): string;
+public function getObjectId(): string;
```
+Get entity unique ID
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
+---
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L106)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getStartLine(): int;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Get the line number of the start of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L93)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L72)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrows(): array;
+public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get parsed throws from `throws` doc block
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPluginData(string $pluginKey): mixed;
+```
+Get additional information added using the plugin
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
+---
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getThrowsDocBlockLinks(): array;
+public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
+```
+Get a list of all properties and classes where they are implemented
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraits(): array;
+public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
-
Get a list of trait entities of the current class
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: array
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
+---
-
Throws:
-
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
+```
+Get the compiled value of a property
+
+***Parameters:***
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraitsNames(): array;
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a list of class traits names
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Return value: array
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Check if a constant exists in a class
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L386)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getShortName(): string;
+```
+Short name of the entity
-
Throws:
-
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasDescriptionLinks(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has links in its description
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: bool
+---
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
Throws:
-
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasExamples(): bool;
+public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Checking if an entity has `example` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
+```
+Check if a constant exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
+
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Check if a method exists in a class
+---
-
Parameters:
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L43)
```php
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isAttribute` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L55)
```php
public function isAttribute(): bool;
```
+Check if a class is an attribute
-
Check if a class is an attribute
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L20)
```php
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassEntity.php#L30)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity.md
index f46f99aa..3eb970e4 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity.md
@@ -1,12 +1,15 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP trait reflection API](../phpTraitReflectionApi.md) **/**
+ClassLikeEntity
+---
+# [ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L44) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
@@ -14,3301 +17,1211 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
abstract class ClassLikeEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
-public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocCommentLine(): null|int;
-```
-
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocNote(): string;
-```
-
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getEndLine(): int;
-```
-
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getEntityDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getExamples(): array;
-```
-
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getFileContent(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFileSourceLink(bool $withLine = true): null|string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFirstExample(): string;
-```
-
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
-```
-
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
+public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Link to an entity where docBlock is implemented for this entity
-
See:
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
-public function getRelativeFileName(): null|string;
-```
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
File name relative to project_root configuration parameter
+public function getDocCommentLine(): null|int;
+```
+Get the code line number where the docBlock of the current entity begins
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
string
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getDocNote(): string;
+```
+Get the note annotation value
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
+```php
+public function getEndLine(): int;
+```
+Get the line number of the end of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
-public function getShortName(): string;
+public function getEntityDependencies(): array;
```
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getExamples(): array;
+```
+Get parsed examples from `examples` doc block
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
-public function getStartLine(): int;
+public function getFileContent(): string;
```
-
Get the line number of the start of a class code in a file
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getFileSourceLink(bool $withLine = true): null|string;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function getThrows(): array;
+public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get parsed throws from `throws` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
+```php
+public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the class like entity in which the current entity was implemented
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
-public function getTraits(): array;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
-public function getTraitsNames(): array;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of class traits names
-
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L79)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getName(): string;
```
+Full name of the entity
-
Check if a constant exists in a class
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
Return value: bool
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasDescriptionLinks(): bool;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
+```php
+public function getParentClassNames(): array;
+```
+Get a list of entity names of parent classes
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasExamples(): bool;
+public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Checking if an entity has `example` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Check if a method exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: bool
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
-public function hasParentClass(string $parentClassName): bool;
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Return value: bool
+---
+
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
+```php
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+```
+Get a collection of property entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
-public function hasProperty(string $propertyName, bool $unsafe = false): bool;
+public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
Check if a property exists in a class
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+---
+
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
+```php
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get the collection of root entities to which this entity belongs
-
Return value: bool
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
+```php
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasThrows(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has `throws` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
+```php
+public function getTraitsNames(): array;
+```
+Get a list of class traits names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
-public function hasTraits(): bool;
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if the class contains traits
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasDescriptionLinks(): bool;
+```
+Checking if an entity has links in its description
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
-public function implementsInterface(string $interfaceName): bool;
-```
-
-
Check if a class implements an interface
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Parameters:
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
+```php
+public function hasMethod(string $methodName, bool $unsafe = false): bool;
+```
+Check if a method exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
-public function isAbstract(): bool;
+public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function isApi(): bool;
+public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Checking if an entity has `api` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasThrows(): bool;
+```
+Checking if an entity has `throws` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
-public function isClass(): bool;
+public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
-public function isClassLoad(): bool;
+public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
+```php
+public function isAbstract(): bool;
+```
+Check that an entity is abstract
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function isDeprecated(): bool;
+public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
+```php
+public function isClass(): bool;
+```
+Check if an entity is a Class
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
-public function isDocumentCreationAllowed(): bool;
+public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Return value: bool
+public function isDeprecated(): bool;
+```
+Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
+```php
+public function isDocumentCreationAllowed(): bool;
+```
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_2.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_2.md
index 89480354..b39f1ccd 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_2.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_2.md
@@ -1,12 +1,15 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP interface reflection API](../phpInterfaceReflectionApi.md) **/**
+ClassLikeEntity
+---
+# [ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L44) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
@@ -14,3301 +17,1211 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
abstract class ClassLikeEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
-public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocCommentLine(): null|int;
-```
-
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocNote(): string;
-```
-
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getEndLine(): int;
-```
-
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getEntityDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getExamples(): array;
-```
-
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getFileContent(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFileSourceLink(bool $withLine = true): null|string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFirstExample(): string;
-```
-
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
-```
-
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
+public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Link to an entity where docBlock is implemented for this entity
-
See:
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
-public function getRelativeFileName(): null|string;
-```
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
File name relative to project_root configuration parameter
+public function getDocCommentLine(): null|int;
+```
+Get the code line number where the docBlock of the current entity begins
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
string
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getDocNote(): string;
+```
+Get the note annotation value
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
+```php
+public function getEndLine(): int;
+```
+Get the line number of the end of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
-public function getShortName(): string;
+public function getEntityDependencies(): array;
```
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getExamples(): array;
+```
+Get parsed examples from `examples` doc block
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
-public function getStartLine(): int;
+public function getFileContent(): string;
```
-
Get the line number of the start of a class code in a file
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getFileSourceLink(bool $withLine = true): null|string;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function getThrows(): array;
+public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get parsed throws from `throws` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
+```php
+public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the class like entity in which the current entity was implemented
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
-public function getTraits(): array;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
-public function getTraitsNames(): array;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of class traits names
-
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L79)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getName(): string;
```
+Full name of the entity
-
Check if a constant exists in a class
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
Return value: bool
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasDescriptionLinks(): bool;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
+```php
+public function getParentClassNames(): array;
+```
+Get a list of entity names of parent classes
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasExamples(): bool;
+public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Checking if an entity has `example` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Check if a method exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: bool
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
-public function hasParentClass(string $parentClassName): bool;
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Return value: bool
+---
+
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
+```php
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+```
+Get a collection of property entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
-public function hasProperty(string $propertyName, bool $unsafe = false): bool;
+public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
Check if a property exists in a class
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+---
+
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
+```php
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get the collection of root entities to which this entity belongs
-
Return value: bool
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
+```php
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasThrows(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has `throws` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
+```php
+public function getTraitsNames(): array;
+```
+Get a list of class traits names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
-public function hasTraits(): bool;
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if the class contains traits
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasDescriptionLinks(): bool;
+```
+Checking if an entity has links in its description
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
-public function implementsInterface(string $interfaceName): bool;
-```
-
-
Check if a class implements an interface
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Parameters:
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
+```php
+public function hasMethod(string $methodName, bool $unsafe = false): bool;
+```
+Check if a method exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
-public function isAbstract(): bool;
+public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function isApi(): bool;
+public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Checking if an entity has `api` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasThrows(): bool;
+```
+Checking if an entity has `throws` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
-public function isClass(): bool;
+public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
-public function isClassLoad(): bool;
+public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
+```php
+public function isAbstract(): bool;
+```
+Check that an entity is abstract
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function isDeprecated(): bool;
+public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
+```php
+public function isClass(): bool;
+```
+Check if an entity is a Class
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
-public function isDocumentCreationAllowed(): bool;
+public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Return value: bool
+public function isDeprecated(): bool;
+```
+Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
+```php
+public function isDocumentCreationAllowed(): bool;
+```
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_3.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_3.md
index 9730b3fa..205123f0 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_3.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_3.md
@@ -1,12 +1,15 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP enum reflection API](../phpEnumReflectionApi.md) **/**
+ClassLikeEntity
+---
+# [ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L44) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
@@ -14,3301 +17,1211 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
abstract class ClassLikeEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
-public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocCommentLine(): null|int;
-```
-
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocNote(): string;
-```
-
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getEndLine(): int;
-```
-
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getEntityDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getExamples(): array;
-```
-
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getFileContent(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFileSourceLink(bool $withLine = true): null|string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFirstExample(): string;
-```
-
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
-```
-
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
+public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Link to an entity where docBlock is implemented for this entity
-
See:
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
-public function getRelativeFileName(): null|string;
-```
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
File name relative to project_root configuration parameter
+public function getDocCommentLine(): null|int;
+```
+Get the code line number where the docBlock of the current entity begins
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
string
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getDocNote(): string;
+```
+Get the note annotation value
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
+```php
+public function getEndLine(): int;
+```
+Get the line number of the end of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
-public function getShortName(): string;
+public function getEntityDependencies(): array;
```
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getExamples(): array;
+```
+Get parsed examples from `examples` doc block
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
-public function getStartLine(): int;
+public function getFileContent(): string;
```
-
Get the line number of the start of a class code in a file
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getFileSourceLink(bool $withLine = true): null|string;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function getThrows(): array;
+public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get parsed throws from `throws` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
+```php
+public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the class like entity in which the current entity was implemented
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
-public function getTraits(): array;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
-public function getTraitsNames(): array;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of class traits names
-
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L79)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getName(): string;
```
+Full name of the entity
-
Check if a constant exists in a class
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
Return value: bool
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasDescriptionLinks(): bool;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
+```php
+public function getParentClassNames(): array;
+```
+Get a list of entity names of parent classes
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasExamples(): bool;
+public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Checking if an entity has `example` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Check if a method exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: bool
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
-public function hasParentClass(string $parentClassName): bool;
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Return value: bool
+---
+
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
+```php
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+```
+Get a collection of property entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
-public function hasProperty(string $propertyName, bool $unsafe = false): bool;
+public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
Check if a property exists in a class
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+---
+
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
+```php
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get the collection of root entities to which this entity belongs
-
Return value: bool
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
+```php
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasThrows(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has `throws` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
+```php
+public function getTraitsNames(): array;
+```
+Get a list of class traits names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
-public function hasTraits(): bool;
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if the class contains traits
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasDescriptionLinks(): bool;
+```
+Checking if an entity has links in its description
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
-public function implementsInterface(string $interfaceName): bool;
-```
-
-
Check if a class implements an interface
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Parameters:
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
+```php
+public function hasMethod(string $methodName, bool $unsafe = false): bool;
+```
+Check if a method exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
-public function isAbstract(): bool;
+public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function isApi(): bool;
+public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Checking if an entity has `api` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasThrows(): bool;
+```
+Checking if an entity has `throws` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
-public function isClass(): bool;
+public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
-public function isClassLoad(): bool;
+public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
+```php
+public function isAbstract(): bool;
+```
+Check that an entity is abstract
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function isDeprecated(): bool;
+public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
+```php
+public function isClass(): bool;
+```
+Check if an entity is a Class
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
-public function isDocumentCreationAllowed(): bool;
+public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Return value: bool
+public function isDeprecated(): bool;
+```
+Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
+```php
+public function isDocumentCreationAllowed(): bool;
+```
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_4.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_4.md
index 8f9d9810..0511ddb3 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_4.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_4.md
@@ -1,12 +1,15 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP class reflection API](../phpClassReflectionApi.md) **/**
+ClassLikeEntity
+---
+# [ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L44) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
@@ -14,3301 +17,1211 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
abstract class ClassLikeEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
-public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocCommentLine(): null|int;
-```
-
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocNote(): string;
-```
-
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getEndLine(): int;
-```
-
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getEntityDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getExamples(): array;
-```
-
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getFileContent(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFileSourceLink(bool $withLine = true): null|string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFirstExample(): string;
-```
-
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
-```
-
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
+public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Link to an entity where docBlock is implemented for this entity
-
See:
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
-public function getRelativeFileName(): null|string;
-```
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
File name relative to project_root configuration parameter
+public function getDocCommentLine(): null|int;
+```
+Get the code line number where the docBlock of the current entity begins
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
string
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getDocNote(): string;
+```
+Get the note annotation value
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
+```php
+public function getEndLine(): int;
+```
+Get the line number of the end of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
-public function getShortName(): string;
+public function getEntityDependencies(): array;
```
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getExamples(): array;
+```
+Get parsed examples from `examples` doc block
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
-public function getStartLine(): int;
+public function getFileContent(): string;
```
-
Get the line number of the start of a class code in a file
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getFileSourceLink(bool $withLine = true): null|string;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function getThrows(): array;
+public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get parsed throws from `throws` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
+```php
+public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the class like entity in which the current entity was implemented
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
-public function getTraits(): array;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
-public function getTraitsNames(): array;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of class traits names
-
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L79)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getName(): string;
```
+Full name of the entity
-
Check if a constant exists in a class
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
Return value: bool
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasDescriptionLinks(): bool;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
+```php
+public function getParentClassNames(): array;
+```
+Get a list of entity names of parent classes
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasExamples(): bool;
+public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Checking if an entity has `example` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Check if a method exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: bool
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
-public function hasParentClass(string $parentClassName): bool;
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Return value: bool
+---
+
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
+```php
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+```
+Get a collection of property entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
-public function hasProperty(string $propertyName, bool $unsafe = false): bool;
+public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
Check if a property exists in a class
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+---
+
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
+```php
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get the collection of root entities to which this entity belongs
-
Return value: bool
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
+```php
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasThrows(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has `throws` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
+```php
+public function getTraitsNames(): array;
+```
+Get a list of class traits names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
-public function hasTraits(): bool;
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if the class contains traits
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasDescriptionLinks(): bool;
+```
+Checking if an entity has links in its description
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
-public function implementsInterface(string $interfaceName): bool;
-```
-
-
Check if a class implements an interface
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Parameters:
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
+```php
+public function hasMethod(string $methodName, bool $unsafe = false): bool;
+```
+Check if a method exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
-public function isAbstract(): bool;
+public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function isApi(): bool;
+public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Checking if an entity has `api` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasThrows(): bool;
+```
+Checking if an entity has `throws` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
-public function isClass(): bool;
+public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
-public function isClassLoad(): bool;
+public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
+```php
+public function isAbstract(): bool;
+```
+Check that an entity is abstract
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function isDeprecated(): bool;
+public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
+```php
+public function isClass(): bool;
+```
+Check if an entity is a Class
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
-public function isDocumentCreationAllowed(): bool;
+public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Return value: bool
+public function isDeprecated(): bool;
+```
+Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
+```php
+public function isDocumentCreationAllowed(): bool;
+```
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_5.md b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_5.md
index b18e9778..898b8430 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_5.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/ClassLikeEntity_5.md
@@ -1,12 +1,14 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+ClassLikeEntity
+---
+# [ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L44) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
@@ -14,3301 +16,1211 @@ namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
abstract class ClassLikeEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
-public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocCommentLine(): null|int;
-```
-
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getDocNote(): string;
-```
-
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getEndLine(): int;
-```
-
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getEntityDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getExamples(): array;
-```
-
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getFileContent(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFileSourceLink(bool $withLine = true): null|string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getFirstExample(): string;
-```
-
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-
-
-```php
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-
-
-```php
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
-```
-
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
-```
-
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
+public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Link to an entity where docBlock is implemented for this entity
-
See:
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
-public function getRelativeFileName(): null|string;
-```
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
File name relative to project_root configuration parameter
+public function getDocCommentLine(): null|int;
+```
+Get the code line number where the docBlock of the current entity begins
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: null |
string
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getDocNote(): string;
+```
+Get the note annotation value
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
+```php
+public function getEndLine(): int;
+```
+Get the line number of the end of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
-public function getShortName(): string;
+public function getEntityDependencies(): array;
```
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getExamples(): array;
+```
+Get parsed examples from `examples` doc block
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
-public function getStartLine(): int;
+public function getFileContent(): string;
```
-
Get the line number of the start of a class code in a file
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getFileSourceLink(bool $withLine = true): null|string;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function getThrows(): array;
+public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get parsed throws from `throws` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
+```php
+public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the class like entity in which the current entity was implemented
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
+---
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
-public function getTraits(): array;
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
-public function getTraitsNames(): array;
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of class traits names
-
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L79)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getName(): string;
```
+Full name of the entity
-
Check if a constant exists in a class
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
Return value: bool
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasDescriptionLinks(): bool;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
+```php
+public function getParentClassNames(): array;
+```
+Get a list of entity names of parent classes
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function hasExamples(): bool;
+public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Checking if an entity has `example` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
-public function hasMethod(string $methodName, bool $unsafe = false): bool;
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Check if a method exists in a class
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: bool
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
-public function hasParentClass(string $parentClassName): bool;
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Check if a certain parent class exists in a chain of parent classes
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Return value: bool
+---
+
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
+```php
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+```
+Get a collection of property entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
-public function hasProperty(string $propertyName, bool $unsafe = false): bool;
+public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
Check if a property exists in a class
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters:
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
+---
+
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
+```php
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get the collection of root entities to which this entity belongs
-
Return value: bool
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
+```php
+public function getStartLine(): int;
+```
+Get the line number of the start of a class code in a file
-
-
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasThrows(): bool;
+public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Checking if an entity has `throws` docBlock
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
+```php
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
+```php
+public function getTraitsNames(): array;
+```
+Get a list of class traits names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
-public function hasTraits(): bool;
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if the class contains traits
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasDescriptionLinks(): bool;
+```
+Checking if an entity has links in its description
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
-public function implementsInterface(string $interfaceName): bool;
-```
-
-
Check if a class implements an interface
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Parameters:
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
+```php
+public function hasMethod(string $methodName, bool $unsafe = false): bool;
+```
+Check if a method exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
-public function isAbstract(): bool;
+public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function isApi(): bool;
+public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Checking if an entity has `api` docBlock
+***Parameters:***
-
Parameters: not specified
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+public function hasThrows(): bool;
+```
+Checking if an entity has `throws` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
-public function isClass(): bool;
+public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
-public function isClassLoad(): bool;
+public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
+```php
+public function isAbstract(): bool;
+```
+Check that an entity is abstract
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function isDeprecated(): bool;
+public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
+```php
+public function isClass(): bool;
+```
+Check if an entity is a Class
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
-public function isDocumentCreationAllowed(): bool;
+public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Return value: bool
+public function isDeprecated(): bool;
+```
+Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
+```php
+public function isDocumentCreationAllowed(): bool;
+```
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/Configuration.md b/docs/tech/02_parser/reflectionApi/php/classes/Configuration.md
index 96f0b795..4d5a93db 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/Configuration.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/Configuration.md
@@ -1,763 +1,247 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+Configuration
+---
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
```php
namespace BumbleDocGen\Core\Configuration;
final class Configuration
```
-
-Configuration project documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAdditionalConsoleCommands
-
--
- getCacheDir
-
--
- getConfigurationVersion
-
--
- getDocGenLibDir
-
--
- getGitClientPath
-
--
- getIfExists
-
--
- getLanguageHandlersCollection
-
--
- getOutputDir
-
--
- getOutputDirBaseUrl
-
--
- getPageLinkProcessor
-
--
- getPlugins
-
--
- getProjectRoot
-
--
- getSourceLocators
-
--
- getTemplatesDir
-
--
- getTwigFilters
-
--
- getTwigFunctions
-
--
- getWorkingDir
-
--
- isCheckFileInGitBeforeCreatingDocEnabled
-
--
- renderWithFrontMatter
-
--
- useSharedCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
```php
public function getCacheDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
```php
public function getConfigurationVersion(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
```php
public function getDocGenLibDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
```php
public function getGitClientPath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
```php
public function getIfExists(mixed $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- mixed |
- - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
```php
public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
```php
public function getOutputDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
```php
public function getOutputDirBaseUrl(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
```php
public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
```php
public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
```php
public function getProjectRoot(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
```php
public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
```php
public function getTemplatesDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
```php
public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
```php
public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
```php
public function getWorkingDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isCheckFileInGitBeforeCreatingDocEnabled
- | source code
-
-
+
# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
```php
public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
```php
public function renderWithFrontMatter(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
```php
public function useSharedCache(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md
index 5ae0f989..a6a78ea3 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md
@@ -1,3559 +1,1390 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP enum reflection API](../phpEnumReflectionApi.md) **/**
+EnumEntity
+---
+# [EnumEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L19) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class EnumEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Enumeration
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCasesNames
- - Get enum cases names
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getEnumCaseValue
- - Get enum case value
--
- getEnumCases
- - Get enum cases values
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Enumeration
+
+***Links:***
+- [https://www.php.net/manual/en/language.enumerations.php](https://www.php.net/manual/en/language.enumerations.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCasesNames](#mgetcasesnames) - Get enum cases names
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getEnumCaseValue](#mgetenumcasevalue) - Get enum case value
+1. [getEnumCases](#mgetenumcases) - Get enum cases values
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCasesNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L74)
```php
public function getCasesNames(): array;
```
+Get enum cases names
-
Get enum cases names
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getConstantEntitiesCollection()](ClassLikeEntity_5.md#mgetconstantentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
+---
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get values only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get values only for constants corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getEnumCaseValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L87)
```php
public function getEnumCaseValue(string $name): mixed;
```
+Get enum case value
-
Get enum case value
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
+***Parameters:***
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEnumCases` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L45)
```php
public function getEnumCases(): array;
```
+Get enum cases values
-
Get enum cases values
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-public function getInterfaceNames(): array;
-```
-
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getInterfacesEntities(): array;
-```
-
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
-```
-
-
Get the method entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
-```
-
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethods(): array;
-```
-
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getModifiersString(): string;
-```
-
-
Get entity modifiers as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getName(): string;
-```
-
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getNamespaceName(): string;
-```
-
-
Get the entity namespace name
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getObjectId(): string;
-```
-
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
-```
-
-
Get the entity of the parent class if it exists
-
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassEntities(): array;
-```
-
-
Get a list of parent class entities
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassName(): null|string;
-```
-
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getParentClassNames(): array;
-```
-
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPluginData(string $pluginKey): mixed;
-```
-
-
Get additional information added using the plugin
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperties(): array;
-```
-
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
-```
-
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
-```
-
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
-
-
Throws:
-
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L32)
+```php
+public function getInterfaceNames(): array;
+```
+Get a list of class interface names
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
+public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Get the compiled value of a property
+---
-
Parameters:
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
+public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
+```
+Get the method entity by its name
-
Return value: string |
array |
int |
bool |
null |
float
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
Throws:
-
--
- \PhpParser\ConstExprEvaluationException
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
--
- \DI\DependencyException
+---
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
--
- \DI\NotFoundException
+public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
+```
+Get a collection of method entities
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
+---
+
# `getMethods` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1162)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
+public function getMethods(): array;
```
+Get all methods that are available according to the configuration as an array
-
Get a collection of property entities
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+
+public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
+```
+Get a list of all methods and classes where they are implemented
-
Throws:
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L95)
+```php
+public function getModifiersString(): string;
+```
+Get entity modifiers as a string
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRelativeFileName(): null|string;
+public function getName(): string;
```
+Full name of the entity
-
File name relative to project_root configuration parameter
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: null |
string
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getNamespaceName(): string;
+```
+Get the entity namespace name
-
See:
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+public function getObjectId(): string;
```
+Get entity unique ID
-
Get the collection of root entities to which this entity belongs
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
+---
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+```
+Get the entity of the parent class if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getShortName(): string;
+public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Short name of the entity
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: string
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getParentClassName(): null|string;
+```
+Get the name of the parent class entity if it exists
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getStartLine(): int;
+public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get the line number of the start of a class code in a file
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: int
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPluginData(string $pluginKey): mixed;
+```
+Get additional information added using the plugin
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
+---
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getThrows(): array;
+public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Get parsed throws from `throws` doc block
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
+```
+Get a list of all properties and classes where they are implemented
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getThrowsDocBlockLinks(): array;
+public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
+
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
-
Parameters: not specified
+---
-
Return value: array
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
+```
+Get the compiled value of a property
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property for which you need to get the value |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraits(): array;
+public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a list of trait entities of the current class
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntitiesCollection.php)
-
Parameters: not specified
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
-
Return value: array
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
+---
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function getTraitsNames(): array;
+public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get a list of class traits names
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Throws:
-
+public function getShortName(): string;
+```
+Short name of the entity
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasConstant(string $constantName, bool $unsafe = false): bool;
+public function getStartLine(): int;
```
+Get the line number of the start of a class code in a file
-
Check if a constant exists in a class
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+public function getThrows(): array;
+```
+Get parsed throws from `throws` doc block
-
Throws:
-
+public function getTraits(): array;
+```
+Get a list of trait entities of the current class
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-public function hasDescriptionLinks(): bool;
+public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Checking if an entity has links in its description
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters: not specified
+---
-
Return value: bool
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+public function hasConstant(string $constantName, bool $unsafe = false): bool;
+```
+Check if a constant exists in a class
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function hasExamples(): bool;
+public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
+```php
+// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
Throws:
-
+public function hasExamples(): bool;
+```
+Checking if an entity has `example` docBlock
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasMethod(string $methodName, bool $unsafe = false): bool;
```
+Check if a method exists in a class
-
Check if a method exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
-
-
Return value: bool
-
-
-
Throws:
-
--
- \DI\DependencyException
+***Parameters:***
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
--
- \DI\NotFoundException
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
+---
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/EnumEntity.php#L24)
```php
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
-
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md
index 5961f0c9..74b5271d 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md
@@ -1,3438 +1,1349 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP interface reflection API](../phpInterfaceReflectionApi.md) **/**
+InterfaceEntity
+---
+# [InterfaceEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L12) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class InterfaceEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Object interface
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Object interface
+
+***Links:***
+- [https://www.php.net/manual/en/language.oop5.interfaces.php](https://www.php.net/manual/en/language.oop5.interfaces.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Return value: string |
array |
int |
bool |
null |
float
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getConstantEntitiesCollection()](ClassLikeEntity_5.md#mgetconstantentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
-
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
+***Parameters:***
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L530)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfaceNames(): array;
```
+Get a list of class interface names
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethods` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1162)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethods(): array;
```
+Get all methods that are available according to the configuration as an array
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L33)
```php
public function getModifiersString(): string;
```
+Get entity modifiers as a string
-
Get entity modifiers as a string
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getNamespaceName(): string;
```
+Get the entity namespace name
-
Get the entity namespace name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the entity of the parent class if it exists
-
Get the entity of the parent class if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Get a list of parent class entities
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassName(): null|string;
```
+Get the name of the parent class entity if it exists
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
-
-
-
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Get additional information added using the plugin
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: mixed
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
-
-
-
-
-
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
+***Parameters:***
-
Throws:
-
--
- \DI\DependencyException
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
--
- \DI\NotFoundException
-
-
-
-
-
-
-
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L386)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getStartLine(): int;
```
+Get the line number of the start of a class code in a file
-
Get the line number of the start of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getTraits(): array;
```
+Get a list of trait entities of the current class
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L41)
```php
public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Get a list of class traits names
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if a constant exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
--
- \Exception
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasMethod(string $methodName, bool $unsafe = false): bool;
```
+Check if a method exists in a class
-
Check if a method exists in a class
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L25)
```php
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/InterfaceEntity.php#L17)
```php
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1219)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L124)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: string
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/InvalidConfigurationParameterException.md b/docs/tech/02_parser/reflectionApi/php/classes/InvalidConfigurationParameterException.md
deleted file mode 100644
index ac1a4bc3..00000000
--- a/docs/tech/02_parser/reflectionApi/php/classes/InvalidConfigurationParameterException.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception
-```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md
index 62f9fec9..7fdb1ac4 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md
@@ -1,1777 +1,721 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP class method reflection API](../phpClassMethodReflectionApi.md) **/**
+MethodEntity
+---
+# [MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L31) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method;
class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Class method entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getBodyCode
- - Get the code for this method
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
-
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a method's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getFirstReturnValue
- - Get the compiled first return value of a method (if possible)
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
- - Get the name of the class in which this method is implemented
--
- getModifiersString
- - Get a text representation of method modifiers
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Namespace of the class that contains this method
--
- getObjectId
- - Get entity unique ID
--
- getParameters
- - Get a list of method parameters
--
- getParametersString
- - Get a list of method parameters as a string
--
- getParentMethod
- - Get the parent method for this method
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getReturnType
- - Get the return type of method
--
- getRootEntity
-
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getSignature
- - Get the method signature as a string
--
- getStartColumn
- - Get the column number of the beginning of the method code in a file
--
- getStartLine
- - Get the line number of the beginning of the entity code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isConstructor
- - Checking that a method is a constructor
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDynamic
- - Check if a method is a dynamic method, that is, implementable using __call or __callStatic
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isImplementedInParentClass
- - Check if this method is implemented in the parent class
--
- isInitialization
- - Check if a method is an initialization method
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a method is a private method
--
- isProtected
- - Check if a method is a protected method
--
- isPublic
- - Check if a method is a public method
--
- isStatic
- - Check if this method is static
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class method entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getBodyCode](#mgetbodycode) - Get the code for this method
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline)
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a method's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getFirstReturnValue](#mgetfirstreturnvalue) - Get the compiled first return value of a method (if possible)
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname) - Get the name of the class in which this method is implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of method modifiers
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Namespace of the class that contains this method
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParameters](#mgetparameters) - Get a list of method parameters
+1. [getParametersString](#mgetparametersstring) - Get a list of method parameters as a string
+1. [getParentMethod](#mgetparentmethod) - Get the parent method for this method
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getReturnType](#mgetreturntype) - Get the return type of method
+1. [getRootEntity](#mgetrootentity)
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getSignature](#mgetsignature) - Get the method signature as a string
+1. [getStartColumn](#mgetstartcolumn) - Get the column number of the beginning of the method code in a file
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the entity code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isConstructor](#misconstructor) - Checking that a method is a constructor
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDynamic](#misdynamic) - Check if a method is a dynamic method, that is, implementable using __call or __callStatic
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isImplementedInParentClass](#misimplementedinparentclass) - Check if this method is implemented in the parent class
+1. [isInitialization](#misinitialization) - Check if a method is an initialization method
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a method is a private method
+1. [isProtected](#misprotected) - Check if a method is a protected method
+1. [isPublic](#mispublic) - Check if a method is a public method
+1. [isStatic](#misstatic) - Check if this method is static
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L55)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \PhpParser\PrettyPrinter\Standard $astPrinter, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $methodName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$astPrinter | [\PhpParser\PrettyPrinter\Standard](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/PrettyPrinter/Standard.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L78)
```php
public function getAst(): \PhpParser\Node\Stmt\ClassMethod;
```
+Get AST for this entity
-
Get AST for this entity
+***Return value:*** [\PhpParser\Node\Stmt\ClassMethod](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/ClassMethod.php)
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\ClassMethod
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getBodyCode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L545)
```php
public function getBodyCode(): string;
```
+Get the code for this method
-
Get the code for this method
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L142)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
-
-
-
-
-
+---
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L200)
```php
public function getDocCommentLine(): null|int;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Parameters: not specified
-
-
Return value: null |
int
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L518)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a method's code in a file
-
Get the line number of the end of a method's code in a file
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstReturnValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L529)
```php
public function getFirstReturnValue(): mixed;
```
+Get the compiled first return value of a method (if possible)
-
Get the compiled first return value of a method (if possible)
-
-
Parameters: not specified
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
-
Return value: mixed
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L106)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L414)
```php
public function getImplementingClassName(): string;
```
+Get the name of the class in which this method is implemented
-
Get the name of the class in which this method is implemented
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L242)
```php
public function getModifiersString(): string;
```
+Get a text representation of method modifiers
-
Get a text representation of method modifiers
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L114)
```php
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L130)
```php
public function getNamespaceName(): string;
```
+Namespace of the class that contains this method
-
Namespace of the class that contains this method
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParameters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L300)
```php
public function getParameters(): array;
```
+Get a list of method parameters
-
Get a list of method parameters
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getParametersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L392)
```php
public function getParametersString(): string;
```
+Get a list of method parameters as a string
-
Get a list of method parameters as a string
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getParentMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L184)
```php
public function getParentMethod(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the parent method for this method
-
Get the parent method for this method
-
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L232)
```php
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
-
See:
-
-
-
-
-
-
+---
+
# `getReturnType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L269)
```php
public function getReturnType(): string;
```
+Get the return type of method
-
Get the return type of method
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L90)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L98)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L122)
```php
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getSignature` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L212)
```php
public function getSignature(): string;
```
+Get the method signature as a string
-
Get the method signature as a string
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getStartColumn` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L508)
```php
public function getStartColumn(): int;
```
+Get the column number of the beginning of the method code in a file
-
Get the column number of the beginning of the method code in a file
-
-
Parameters: not specified
-
-
Return value: int
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L498)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the entity code in a file
-
Get the line number of the beginning of the entity code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isConstructor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L222)
```php
public function isConstructor(): bool;
```
+Checking that a method is a constructor
-
Checking that a method is a constructor
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `isDynamic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L448)
```php
public function isDynamic(): bool;
```
+Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-
Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isImplementedInParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L406)
```php
public function isImplementedInParentClass(): bool;
```
+Check if this method is implemented in the parent class
-
Check if this method is implemented in the parent class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isInitialization` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L426)
```php
public function isInitialization(): bool;
```
+Check if a method is an initialization method
-
Check if a method is an initialization method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L488)
```php
public function isPrivate(): bool;
```
+Check if a method is a private method
-
Check if a method is a private method
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L478)
```php
public function isProtected(): bool;
```
+Check if a method is a protected method
-
Check if a method is a protected method
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L458)
```php
public function isPublic(): bool;
```
+Check if a method is a public method
-
Check if a method is a public method
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isStatic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php#L468)
```php
public function isStatic(): bool;
```
+Check if this method is static
-
Check if this method is static
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md b/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md
index b1cf22c2..acf43998 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md
@@ -1,883 +1,354 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP entities collection](../phpEntitiesCollection.md) **/**
+PhpEntitiesCollection
+---
+# [PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L43) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
final class PhpEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection implements \IteratorAggregate
```
-
-Collection of php root entities
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
- - Add an entity to the collection
--
- clearOperationsLogCollection
-
--
- filterByInterfaces
- - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
--
- filterByNameRegularExpression
- - Get a copy of the current collection with only entities whose names match the regular expression
--
- filterByParentClassNames
- - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
--
- filterByPaths
- - Get a copy of the current collection only with entities filtered by file paths (from project_root)
--
- findEntity
- - Find an entity in a collection
--
- get
- - Get an entity from a collection (only previously added)
--
- getEntityCollectionName
- - Get collection name
--
- getEntityLinkData
-
--
- getIterator
-
--
- getLoadedOrCreateNew
- - Get an entity from the collection or create a new one if it has not yet been added
--
- getOnlyAbstractClasses
- - Get a copy of the current collection with only abstract classes
--
- getOnlyInstantiable
- - Get a copy of the current collection with only instantiable entities
--
- getOnlyInterfaces
- - Get a copy of the current collection with only interfaces
--
- getOnlyTraits
- - Get a copy of the current collection with only traits
--
- getOperationsLogCollection
-
--
- has
- - Check if an entity has been added to the collection
--
- internalFindEntity
-
--
- internalGetLoadedOrCreateNew
-
--
- isEmpty
- - Check if the collection is empty or not
--
- loadEntities
- - Load entities into a collection
--
- loadEntitiesByConfiguration
- - Load entities into a collection by configuration
--
- remove
- - Remove an entity from a collection
--
- removeAllNotLoadedEntities
-
--
- toArray
- - Convert collection to array
--
- updateEntitiesCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Collection of php root entities
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [add](#madd) - Add an entity to the collection
+1. [clearOperationsLogCollection](#mclearoperationslogcollection)
+1. [filterByInterfaces](#mfilterbyinterfaces) - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
+1. [filterByNameRegularExpression](#mfilterbynameregularexpression) - Get a copy of the current collection with only entities whose names match the regular expression
+1. [filterByParentClassNames](#mfilterbyparentclassnames) - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
+1. [filterByPaths](#mfilterbypaths) - Get a copy of the current collection only with entities filtered by file paths (from project_root)
+1. [findEntity](#mfindentity) - Find an entity in a collection
+1. [get](#mget) - Get an entity from a collection (only previously added)
+1. [getEntityCollectionName](#mgetentitycollectionname) - Get collection name
+1. [getEntityLinkData](#mgetentitylinkdata)
+1. [getIterator](#mgetiterator)
+1. [getLoadedOrCreateNew](#mgetloadedorcreatenew) - Get an entity from the collection or create a new one if it has not yet been added
+1. [getOnlyAbstractClasses](#mgetonlyabstractclasses) - Get a copy of the current collection with only abstract classes
+1. [getOnlyInstantiable](#mgetonlyinstantiable) - Get a copy of the current collection with only instantiable entities
+1. [getOnlyInterfaces](#mgetonlyinterfaces) - Get a copy of the current collection with only interfaces
+1. [getOnlyTraits](#mgetonlytraits) - Get a copy of the current collection with only traits
+1. [getOperationsLogCollection](#mgetoperationslogcollection)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [internalFindEntity](#minternalfindentity)
+1. [internalGetLoadedOrCreateNew](#minternalgetloadedorcreatenew)
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadEntities](#mloadentities) - Load entities into a collection
+1. [loadEntitiesByConfiguration](#mloadentitiesbyconfiguration) - Load entities into a collection by configuration
+1. [remove](#mremove) - Remove an entity from a collection
+1. [removeAllNotLoadedEntities](#mremoveallnotloadedentities)
+1. [toArray](#mtoarray) - Convert collection to array
+1. [updateEntitiesCache](#mupdateentitiescache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L50)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
+$docRendererHelper | [\BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/EntityDocRenderer/EntityDocRendererHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L190)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Add an entity to the collection
-
Add an entity to the collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
Throws:
-
-
-
-
-
-
-
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+
+---
+
+
# `clearOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L28)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function clearOperationsLogCollection(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `filterByInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L244)
```php
public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaces |
- string[] |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByNameRegularExpression` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L321)
```php
public function filterByNameRegularExpression(string $regexPattern): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only entities whose names match the regular expression
-
Get a copy of the current collection with only entities whose names match the regular expression
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $regexPattern |
- string |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$regexPattern | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `filterByParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L270)
```php
public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassNames |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByPaths` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L298)
```php
public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $paths |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$paths | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `findEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L118)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function findEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Find an entity in a collection
+
+***Parameters:***
-
Find an entity in a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- - |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
+
+---
+
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L86)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from a collection (only previously added)
-
Get an entity from a collection (only previously added)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
-
-
-
-
+---
+
# `getEntityCollectionName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L66)
```php
public function getEntityCollectionName(): string;
```
+Get collection name
-
Get collection name
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- getEntityLinkData
- :warning: Is internal | source code
-
+---
+
# `getEntityLinkData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L508)
```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$rawLink | [string](https://www.php.net/manual/en/language.types.string.php) | Raw link to an entity or entity element |
+$defaultEntityName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Entity name to use if the link does not contain a valid or existing entity name,
+ but only a cursor on an entity element |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rawLink |
- string |
- Raw link to an entity or entity element |
-
-
- $defaultEntityName |
- string | null |
- Entity name to use if the link does not contain a valid or existing entity name,
- but only a cursor on an entity element |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `getLoadedOrCreateNew` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L102)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from the collection or create a new one if it has not yet been added
-
Get an entity from the collection or create a new one if it has not yet been added
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
See:
-
-
-
-
-
-
+***Parameters:***
-```php
-public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
-```
-
-
Get a copy of the current collection with only abstract classes
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Links:***
+- [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface::isEntityDataCanBeLoaded()](RootEntityInterface.md#misentitydatacanbeloaded)
+---
-
Throws:
-
+
# `getOnlyAbstractClasses` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L388)
+```php
+public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get a copy of the current collection with only abstract classes
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `getOnlyInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L338)
```php
public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only instantiable entities
-
Get a copy of the current collection with only instantiable entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getOnlyInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L354)
```php
public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only interfaces
-
Get a copy of the current collection with only interfaces
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOnlyTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L370)
```php
public function getOnlyTraits(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only traits
-
Get a copy of the current collection with only traits
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getOperationsLogCollection(): \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLogOperation/OperationsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- internalFindEntity
- :warning: Is internal | source code
-
+---
+
# `internalFindEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L421)
```php
public function internalFindEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
If the request refers to multiple existing entities and if unsafe keys are allowed,
- a warning will be shown and the first entity found will be used. |
-
-
- $useUnsafeKeys |
- bool |
- Whether to use search keys that can be used to find several entities |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+ a warning will be shown and the first entity found will be used. |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Whether to use search keys that can be used to find several entities |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
-
-
Examples of using:
-
+***Examples of using:***
```php
$entitiesCollection->findEntity('App'); // class name
$entitiesCollection->findEntity('BumbleDocGen\Console\App'); // class with namespace
@@ -889,318 +360,118 @@ $entitiesCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen
$entitiesCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/App.php'); // source link
```
-
-
-
-
-
-- #
- internalGetLoadedOrCreateNew
- :warning: Is internal | source code
-
+---
+
# `internalGetLoadedOrCreateNew` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L214)
```php
public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `loadEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L100)
```php
public function loadEntities(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection $sourceLocatorsCollection, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface|null $filters = null, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+Load entities into a collection
-
Load entities into a collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- loadEntitiesByConfiguration
- :warning: Is internal | source code
-
-
-```php
-public function loadEntitiesByConfiguration(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
-```
-
-
Load entities into a collection by configuration
-
-
Parameters:
-
-
+***Parameters:***
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
+| Name | Type | Description |
+|:-|:-|:-|
+$sourceLocatorsCollection | [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php) | - |
+$filters | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `removeAllNotLoadedEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L132)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function removeAllNotLoadedEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `toArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L127)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function toArray(): array;
```
+Convert collection to array
-
Convert collection to array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- updateEntitiesCache
- :warning: Is internal | source code
-
+---
+
# `updateEntitiesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L97)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function updateEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/PhpHandlerSettings.md b/docs/tech/02_parser/reflectionApi/php/classes/PhpHandlerSettings.md
index 0426fe22..913ab33d 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/PhpHandlerSettings.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/PhpHandlerSettings.md
@@ -1,12 +1,14 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+PhpHandlerSettings
+---
+# [PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L21) class:
```php
namespace BumbleDocGen\LanguageHandler\Php;
@@ -14,498 +16,171 @@ namespace BumbleDocGen\LanguageHandler\Php;
final class PhpHandlerSettings
```
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getClassConstantEntityFilter
-
--
- getClassEntityFilter
-
--
- getComposerConfigFile
-
--
- getComposerVendorDir
-
--
- getCustomTwigFilters
-
--
- getCustomTwigFunctions
-
--
- getEntityDocRenderersCollection
-
--
- getFileSourceBaseUrl
-
--
- getMethodEntityFilter
-
--
- getPropertyEntityFilter
-
--
- getPsr4Map
-
--
- getUseComposerAutoload
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [changePropRefsInternalLinksMode](#mchangeproprefsinternallinksmode)
+1. [getClassConstantEntityFilter](#mgetclassconstantentityfilter)
+1. [getClassEntityFilter](#mgetclassentityfilter)
+1. [getComposerConfigFile](#mgetcomposerconfigfile)
+1. [getComposerVendorDir](#mgetcomposervendordir)
+1. [getCustomTwigFilters](#mgetcustomtwigfilters)
+1. [getCustomTwigFunctions](#mgetcustomtwigfunctions)
+1. [getEntityDocRenderersCollection](#mgetentitydocrendererscollection)
+1. [getFileSourceBaseUrl](#mgetfilesourcebaseurl)
+1. [getMethodEntityFilter](#mgetmethodentityfilter)
+1. [getPropRefsInternalLinksMode](#mgetproprefsinternallinksmode) - If `true` - parameters and properties in class documents refer to generated documents and not to external sources
+1. [getPropertyEntityFilter](#mgetpropertyentityfilter)
+1. [getPsr4Map](#mgetpsr4map)
+1. [getUseComposerAutoload](#mgetusecomposerautoload)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L26)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
-
Parameters:
+---
-
+
# `changePropRefsInternalLinksMode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L175)
+```php
+public function changePropRefsInternalLinksMode(bool $propRefsInternalLinksMode): void;
+```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$propRefsInternalLinksMode | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `getClassConstantEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L63)
```php
public function getClassConstantEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getClassEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L43)
```php
public function getClassEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getComposerConfigFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L199)
```php
public function getComposerConfigFile(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getComposerVendorDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L216)
```php
public function getComposerVendorDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCustomTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L273)
```php
public function getCustomTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCustomTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L250)
```php
public function getCustomTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEntityDocRenderersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L123)
```php
public function getEntityDocRenderersCollection(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRenderersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getFileSourceBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L144)
```php
public function getFileSourceBaseUrl(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getMethodEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L83)
```php
public function getMethodEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
+
# `getPropRefsInternalLinksMode` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L162)
+```php
+public function getPropRefsInternalLinksMode(): bool;
+```
+If `true` - parameters and properties in class documents refer to generated documents and not to external sources
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `getPropertyEntityFilter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L103)
```php
public function getPropertyEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPsr4Map` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L232)
```php
public function getPsr4Map(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getUseComposerAutoload` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php#L183)
```php
public function getUseComposerAutoload(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md
index bb36e3bc..acf80258 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md
@@ -1,1585 +1,613 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP class property reflection API](../phpClassPropertyReflectionApi.md) **/**
+PropertyEntity
+---
+# [PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L28) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property;
class PropertyEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
-
-Class property entity
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getCurrentRootEntity
-
--
- getDefaultValue
- - Get the compiled default value of a property
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getEndLine
- - Get the line number of the end of a property's code in a file
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getImplementingClassName
- - Get the name of the class in which this property is implemented
--
- getModifiersString
- - Get a text representation of property modifiers
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Namespace of the class that contains this property
--
- getObjectId
- - Get entity unique ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntity
-
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the beginning of the entity code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getType
- - Get current property type
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isImplementedInParentClass
- - Check if this property is implemented in the parent class
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isPrivate
- - Check if a private is a public private
--
- isProtected
- - Check if a protected is a public protected
--
- isPublic
- - Check if a property is a public property
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Class property entity
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDefaultValue](#mgetdefaultvalue) - Get the compiled default value of a property
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getEndLine](#mgetendline) - Get the line number of the end of a property's code in a file
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getImplementingClassName](#mgetimplementingclassname) - Get the name of the class in which this property is implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get a text representation of property modifiers
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Namespace of the class that contains this property
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntity](#mgetrootentity)
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the beginning of the entity code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getType](#mgettype) - Get current property type
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isImplementedInParentClass](#misimplementedinparentclass) - Check if this property is implemented in the parent class
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isPrivate](#misprivate) - Check if a private is a public private
+1. [isProtected](#misprotected) - Check if a protected is a public protected
+1. [isPublic](#mispublic) - Check if a property is a public property
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L59)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $propertyName, string $implementingClassName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$implementingClassName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L86)
```php
public function getAst(): \PhpParser\Node\Stmt\Property;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Property
-
+***Return value:*** [\PhpParser\Node\Stmt\Property](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Property.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
-
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L370)
```php
public function getDefaultValue(): string|array|int|bool|null|float;
```
+Get the compiled default value of a property
-
Get the compiled default value of a property
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
-
Parameters: not specified
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
-
+---
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L135)
```php
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L352)
```php
public function getEndLine(): int;
```
+Get the line number of the end of a property's code in a file
-
Get the line number of the end of a property's code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
+---
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L207)
```php
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getImplementingClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L199)
```php
public function getImplementingClassName(): string;
```
+Get the name of the class in which this property is implemented
-
Get the name of the class in which this property is implemented
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L265)
```php
public function getModifiersString(): string;
```
+Get a text representation of property modifiers
-
Get a text representation of property modifiers
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L171)
```php
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L189)
```php
public function getNamespaceName(): string;
```
+Namespace of the class that contains this property
-
Namespace of the class that contains this property
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L187)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L217)
```php
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
See:
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L76)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L123)
```php
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L179)
```php
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L337)
```php
public function getStartLine(): int;
```
+Get the line number of the beginning of the entity code in a file
-
Get the line number of the beginning of the entity code in a file
-
-
Parameters: not specified
-
-
Return value: int
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
-
-
-
-
-
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L231)
```php
public function getType(): string;
```
+Get current property type
-
Get current property type
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
--
- \Exception
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isImplementedInParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L291)
```php
public function isImplementedInParentClass(): bool;
```
+Check if this property is implemented in the parent class
-
Check if this property is implemented in the parent class
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPrivate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L327)
```php
public function isPrivate(): bool;
```
+Check if a private is a public private
-
Check if a private is a public private
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isProtected` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L315)
```php
public function isProtected(): bool;
```
+Check if a protected is a public protected
-
Check if a protected is a public protected
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isPublic` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php#L303)
```php
public function isPublic(): bool;
```
+Check if a property is a public property
-
Check if a property is a public property
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
-
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
-
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/RootEntityInterface.md b/docs/tech/02_parser/reflectionApi/php/classes/RootEntityInterface.md
index 1b87c139..17dda1e1 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/RootEntityInterface.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/RootEntityInterface.md
@@ -1,469 +1,219 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+RootEntityInterface
+---
+# [RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L11) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
interface RootEntityInterface extends \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
+Since the documentation generator supports several programming languages,
+their entities need to correspond to the same interfaces
-Since the documentation generator supports several programming languages,
-their entities need to correspond to the same interfaces
-
-
-
-
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getEntityDependencies
-
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getName
- - Full name of the entity
--
- getObjectId
- - Entity object ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- isEntityCacheOutdated
-
--
- isEntityDataCanBeLoaded
- - Checking if it is possible to get the entity data
--
- isEntityNameValid
- - Check if entity name is valid
--
- isExternalLibraryEntity
- - The entity is loaded from a third party library and should not be treated the same as a standard one
--
- isInGit
- - The entity file is in the git repository
--
- normalizeClassName
-
-
+## Methods
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getName](#mgetname) - Full name of the entity
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded) - Checking if it is possible to get the entity data
+1. [isEntityNameValid](#misentitynamevalid) - Check if entity name is valid
+1. [isExternalLibraryEntity](#misexternallibraryentity) - The entity is loaded from a third party library and should not be treated the same as a standard one
+1. [isInGit](#misingit) - The entity file is in the git repository
+1. [normalizeClassName](#mnormalizeclassname)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L53)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L33)
```php
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L40)
```php
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileSourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L42)
```php
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L30)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L16)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L37)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L58)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L23)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+Checking if it is possible to get the entity data
-
Checking if it is possible to get the entity data
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L18)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if entity name is valid
-
Check if entity name is valid
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isExternalLibraryEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L28)
```php
public function isExternalLibraryEntity(): bool;
```
+The entity is loaded from a third party library and should not be treated the same as a standard one
-
The entity is loaded from a third party library and should not be treated the same as a standard one
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isInGit` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L38)
```php
public function isInGit(): bool;
```
+The entity file is in the git repository
-
The entity file is in the git repository
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L13)
```php
public static function normalizeClassName(string $name): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md b/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md
index 635487f6..1809b0f5 100644
--- a/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md
+++ b/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md
@@ -1,3438 +1,1349 @@
-
-
-
-
+[BumbleDocGen](../../../../../README.md) **/**
+[Technical description of the project](../../../../readme.md) **/**
+[Parser](../../../readme.md) **/**
+[Reflection API](../../readme.md) **/**
+[Reflection API for PHP](../readme.md) **/**
+[PHP trait reflection API](../phpTraitReflectionApi.md) **/**
+TraitEntity
+---
+# [TraitEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L12) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
class TraitEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity implements \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface, \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface
```
-
-Trait
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addPluginData
- - Add information to aт entity object
--
- cursorToDocAttributeLinkFragment
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getAst
- - Get AST for this entity
--
- getCacheKey
-
--
- getCachedEntityDependencies
-
--
- getConstant
- - Get the method entity by its name
--
- getConstantEntitiesCollection
- - Get a collection of constant entities
--
- getConstantValue
- - Get the compiled value of a constant
--
- getConstants
- - Get all constants that are available according to the configuration as an array
--
- getConstantsData
- - Get a list of all constants and classes where they are implemented
--
- getConstantsValues
- - Get class constant compiled values according to filters
--
- getCurrentRootEntity
-
--
- getDescription
- - Get entity description
--
- getDescriptionLinks
- - Get parsed links from description and doc blocks `see` and `link`
--
- getDocBlock
- - Get DocBlock for current entity
--
- getDocComment
- - Get the doc comment of an entity
--
- getDocCommentEntity
- - Link to an entity where docBlock is implemented for this entity
--
- getDocCommentLine
- - Get the code line number where the docBlock of the current entity begins
--
- getDocNote
- - Get the note annotation value
--
- getDocRender
-
--
- getEndLine
- - Get the line number of the end of a class code in a file
--
- getEntityDependencies
-
--
- getExamples
- - Get parsed examples from `examples` doc block
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getFirstExample
- - Get first example from `examples` doc block
--
- getImplementingClass
- - Get the class like entity in which the current entity was implemented
--
- getInterfaceNames
- - Get a list of class interface names
--
- getInterfacesEntities
- - Get a list of interface entities that the current class implements
--
- getMethod
- - Get the method entity by its name
--
- getMethodEntitiesCollection
- - Get a collection of method entities
--
- getMethods
- - Get all methods that are available according to the configuration as an array
--
- getMethodsData
- - Get a list of all methods and classes where they are implemented
--
- getModifiersString
- - Get entity modifiers as a string
--
- getName
- - Full name of the entity
--
- getNamespaceName
- - Get the entity namespace name
--
- getObjectId
- - Get entity unique ID
--
- getParentClass
- - Get the entity of the parent class if it exists
--
- getParentClassEntities
- - Get a list of parent class entities
--
- getParentClassName
- - Get the name of the parent class entity if it exists
--
- getParentClassNames
- - Get a list of entity names of parent classes
--
- getPluginData
- - Get additional information added using the plugin
--
- getProperties
- - Get all properties that are available according to the configuration as an array
--
- getPropertiesData
- - Get a list of all properties and classes where they are implemented
--
- getProperty
- - Get the property entity by its name
--
- getPropertyDefaultValue
- - Get the compiled value of a property
--
- getPropertyEntitiesCollection
- - Get a collection of property entities
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get the collection of root entities to which this entity belongs
--
- getShortName
- - Short name of the entity
--
- getStartLine
- - Get the line number of the start of a class code in a file
--
- getThrows
- - Get parsed throws from `throws` doc block
--
- getThrowsDocBlockLinks
-
--
- getTraits
- - Get a list of trait entities of the current class
--
- getTraitsNames
- - Get a list of class traits names
--
- hasConstant
- - Check if a constant exists in a class
--
- hasDescriptionLinks
- - Checking if an entity has links in its description
--
- hasExamples
- - Checking if an entity has `example` docBlock
--
- hasMethod
- - Check if a method exists in a class
--
- hasParentClass
- - Check if a certain parent class exists in a chain of parent classes
--
- hasProperty
- - Check if a property exists in a class
--
- hasThrows
- - Checking if an entity has `throws` docBlock
--
- hasTraits
- - Check if the class contains traits
--
- implementsInterface
- - Check if a class implements an interface
--
- isAbstract
- - Check that an entity is abstract
--
- isApi
- - Checking if an entity has `api` docBlock
--
- isClass
- - Check if an entity is a Class
--
- isClassLoad
-
--
- isDeprecated
- - Checking if an entity has `deprecated` docBlock
--
- isDocumentCreationAllowed
-
--
- isEntityCacheOutdated
- - Checking if the entity cache is out of date
--
- isEntityDataCacheOutdated
-
--
- isEntityDataCanBeLoaded
-
--
- isEntityFileCanBeLoad
- - Checking if entity data can be retrieved
--
- isEntityNameValid
- - Check if the name is a valid name for ClassLikeEntity
--
- isEnum
- - Check if an entity is an Enum
--
- isExternalLibraryEntity
- - Check if a given entity is an entity from a third party library (connected via composer)
--
- isInGit
- - Checking if class file is in git repository
--
- isInstantiable
- - Check that an entity is instantiable
--
- isInterface
- - Check if an entity is an Interface
--
- isInternal
- - Checking if an entity has `internal` docBlock
--
- isSubclassOf
- - Whether the given class is a subclass of the specified class
--
- isTrait
- - Check if an entity is a Trait
--
- normalizeClassName
- - Bring the class name to the standard format used in the system
--
- reloadEntityDependenciesCache
- - Update entity dependency cache
--
- removeEntityValueFromCache
-
--
- removeNotUsedEntityDataCache
-
--
- setCustomAst
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Trait
+
+***Links:***
+- [https://www.php.net/manual/en/language.oop5.traits.php](https://www.php.net/manual/en/language.oop5.traits.php)
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [addPluginData](#maddplugindata) - Add information to aт entity object
+1. [cursorToDocAttributeLinkFragment](#mcursortodocattributelinkfragment)
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getAst](#mgetast) - Get AST for this entity
+1. [getCacheKey](#mgetcachekey)
+1. [getCachedEntityDependencies](#mgetcachedentitydependencies)
+1. [getConstant](#mgetconstant) - Get the method entity by its name
+1. [getConstantEntitiesCollection](#mgetconstantentitiescollection) - Get a collection of constant entities
+1. [getConstantValue](#mgetconstantvalue) - Get the compiled value of a constant
+1. [getConstants](#mgetconstants) - Get all constants that are available according to the configuration as an array
+1. [getConstantsData](#mgetconstantsdata) - Get a list of all constants and classes where they are implemented
+1. [getConstantsValues](#mgetconstantsvalues) - Get class constant compiled values according to filters
+1. [getCurrentRootEntity](#mgetcurrentrootentity)
+1. [getDescription](#mgetdescription) - Get entity description
+1. [getDescriptionLinks](#mgetdescriptionlinks) - Get parsed links from description and doc blocks `see` and `link`
+1. [getDocBlock](#mgetdocblock) - Get DocBlock for current entity
+1. [getDocComment](#mgetdoccomment) - Get the doc comment of an entity
+1. [getDocCommentEntity](#mgetdoccommententity) - Link to an entity where docBlock is implemented for this entity
+1. [getDocCommentLine](#mgetdoccommentline) - Get the code line number where the docBlock of the current entity begins
+1. [getDocNote](#mgetdocnote) - Get the note annotation value
+1. [getDocRender](#mgetdocrender)
+1. [getEndLine](#mgetendline) - Get the line number of the end of a class code in a file
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getExamples](#mgetexamples) - Get parsed examples from `examples` doc block
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getFirstExample](#mgetfirstexample) - Get first example from `examples` doc block
+1. [getImplementingClass](#mgetimplementingclass) - Get the class like entity in which the current entity was implemented
+1. [getInterfaceNames](#mgetinterfacenames) - Get a list of class interface names
+1. [getInterfacesEntities](#mgetinterfacesentities) - Get a list of interface entities that the current class implements
+1. [getMethod](#mgetmethod) - Get the method entity by its name
+1. [getMethodEntitiesCollection](#mgetmethodentitiescollection) - Get a collection of method entities
+1. [getMethods](#mgetmethods) - Get all methods that are available according to the configuration as an array
+1. [getMethodsData](#mgetmethodsdata) - Get a list of all methods and classes where they are implemented
+1. [getModifiersString](#mgetmodifiersstring) - Get entity modifiers as a string
+1. [getName](#mgetname) - Full name of the entity
+1. [getNamespaceName](#mgetnamespacename) - Get the entity namespace name
+1. [getObjectId](#mgetobjectid) - Get entity unique ID
+1. [getParentClass](#mgetparentclass) - Get the entity of the parent class if it exists
+1. [getParentClassEntities](#mgetparentclassentities) - Get a list of parent class entities
+1. [getParentClassName](#mgetparentclassname) - Get the name of the parent class entity if it exists
+1. [getParentClassNames](#mgetparentclassnames) - Get a list of entity names of parent classes
+1. [getPluginData](#mgetplugindata) - Get additional information added using the plugin
+1. [getProperties](#mgetproperties) - Get all properties that are available according to the configuration as an array
+1. [getPropertiesData](#mgetpropertiesdata) - Get a list of all properties and classes where they are implemented
+1. [getProperty](#mgetproperty) - Get the property entity by its name
+1. [getPropertyDefaultValue](#mgetpropertydefaultvalue) - Get the compiled value of a property
+1. [getPropertyEntitiesCollection](#mgetpropertyentitiescollection) - Get a collection of property entities
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get the collection of root entities to which this entity belongs
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [getStartLine](#mgetstartline) - Get the line number of the start of a class code in a file
+1. [getThrows](#mgetthrows) - Get parsed throws from `throws` doc block
+1. [getTraits](#mgettraits) - Get a list of trait entities of the current class
+1. [getTraitsNames](#mgettraitsnames) - Get a list of class traits names
+1. [hasConstant](#mhasconstant) - Check if a constant exists in a class
+1. [hasDescriptionLinks](#mhasdescriptionlinks) - Checking if an entity has links in its description
+1. [hasExamples](#mhasexamples) - Checking if an entity has `example` docBlock
+1. [hasMethod](#mhasmethod) - Check if a method exists in a class
+1. [hasParentClass](#mhasparentclass) - Check if a certain parent class exists in a chain of parent classes
+1. [hasProperty](#mhasproperty) - Check if a property exists in a class
+1. [hasThrows](#mhasthrows) - Checking if an entity has `throws` docBlock
+1. [hasTraits](#mhastraits) - Check if the class contains traits
+1. [implementsInterface](#mimplementsinterface) - Check if a class implements an interface
+1. [isAbstract](#misabstract) - Check that an entity is abstract
+1. [isApi](#misapi) - Checking if an entity has `api` docBlock
+1. [isClass](#misclass) - Check if an entity is a Class
+1. [isClassLoad](#misclassload)
+1. [isDeprecated](#misdeprecated) - Checking if an entity has `deprecated` docBlock
+1. [isDocumentCreationAllowed](#misdocumentcreationallowed)
+1. [isEntityCacheOutdated](#misentitycacheoutdated) - Checking if the entity cache is out of date
+1. [isEntityDataCacheOutdated](#misentitydatacacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded)
+1. [isEntityFileCanBeLoad](#misentityfilecanbeload) - Checking if entity data can be retrieved
+1. [isEntityNameValid](#misentitynamevalid) - Check if the name is a valid name for ClassLikeEntity
+1. [isEnum](#misenum) - Check if an entity is an Enum
+1. [isExternalLibraryEntity](#misexternallibraryentity) - Check if a given entity is an entity from a third party library (connected via composer)
+1. [isInGit](#misingit) - Checking if class file is in git repository
+1. [isInstantiable](#misinstantiable) - Check that an entity is instantiable
+1. [isInterface](#misinterface) - Check if an entity is an Interface
+1. [isInternal](#misinternal) - Checking if an entity has `internal` docBlock
+1. [isSubclassOf](#missubclassof) - Whether the given class is a subclass of the specified class
+1. [isTrait](#mistrait) - Check if an entity is a Trait
+1. [normalizeClassName](#mnormalizeclassname) - Bring the class name to the standard format used in the system
+1. [reloadEntityDependenciesCache](#mreloadentitydependenciescache) - Update entity dependency cache
+1. [removeEntityValueFromCache](#mremoveentityvaluefromcache)
+1. [removeNotUsedEntityDataCache](#mremovenotusedentitydatacache)
+1. [setCustomAst](#msetcustomast)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L51)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $className, string|null $relativeFileName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$relativeFileName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L258)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function addPluginData(string $pluginKey, mixed $data): void;
```
+Add information to aт entity object
-
Add information to aт entity object
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$data | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
- $data |
- mixed |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
-- #
- cursorToDocAttributeLinkFragment
- :warning: Is internal | source code
-
+---
+
# `cursorToDocAttributeLinkFragment` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1286)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$isForDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $cursor |
- string |
- - |
-
-
- $isForDocument |
- bool |
- - |
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getAst` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L296)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getAst(): \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_;
```
+Get AST for this entity
-
Get AST for this entity
-
-
Parameters: not specified
-
-
Return value: \PhpParser\Node\Stmt\Class_ |
\PhpParser\Node\Stmt\Interface_ |
\PhpParser\Node\Stmt\Trait_ |
\PhpParser\Node\Stmt\Enum_
-
+***Return value:*** [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) | [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) | [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getCacheKey` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getCachedEntityDependencies
- :warning: Is internal | source code
-
-
+
# `getCachedEntityDependencies` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L573)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCachedEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L806)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstant(string $constantName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConstantEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L736)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection;
```
+Get a collection of constant entities
-
Get a collection of constant entities
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntitiesCollection
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-
+
# `getConstantValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L829)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantValue(string $constantName): string|array|int|bool|null|float;
```
+Get the compiled value of a constant
-
Get the compiled value of a constant
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the constant for which you need to get the value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the constant for which you need to get the value |
-
Return value: string |
array |
int |
bool |
null |
float
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php) | [array](https://www.php.net/manual/en/language.types.array.php) | [int](https://www.php.net/manual/en/language.types.integer.php) | [bool](https://www.php.net/manual/en/language.types.boolean.php) | [null](https://www.php.net/manual/en/language.types.null.php) | [float](https://www.php.net/manual/en/language.types.float.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstants` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L765)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstants(): array;
```
+Get all constants that are available according to the configuration as an array
-
Get all constants that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getConstantEntitiesCollection()](ClassLikeEntity_5.md#mgetconstantentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getClassConstantEntityFilter()](PhpHandlerSettings.md#mgetclassconstantentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getConstantsData
- :warning: Is internal | source code
-
-
+
# `getConstantsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L661)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all constants and classes where they are implemented
-
Get a list of all constants and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for constants from the current class |
-
-
- $flags |
- int |
- Get data only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for constants from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for constants corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConstantsValues` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L849)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getConstantsValues(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\ClassConstant\ClassConstantEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get class constant compiled values according to filters
-
Get class constant compiled values according to filters
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get values only for constants from the current class |
-
-
- $flags |
- int |
- Get values only for constants corresponding to the visibility modifiers passed in this value |
-
-
-
-
-
Return value: array
-
+***Parameters:***
-
Throws:
-
-
-
-
-
-
-
-- #
- getCurrentRootEntity
- :warning: Is internal | source code
-
+---
+
# `getCurrentRootEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L549)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getCurrentRootEntity(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getDescription` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L129)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescription(): string;
```
+Get entity description
-
Get entity description
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L289)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDescriptionLinks(): array;
```
+Get parsed links from description and doc blocks `see` and `link`
-
Get parsed links from description and doc blocks `see` and `link`
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocBlock` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L215)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```
+Get DocBlock for current entity
-
Get DocBlock for current entity
-
-
Parameters: not specified
-
-
Return value: \phpDocumentor\Reflection\DocBlock
+***Return value:*** [\phpDocumentor\Reflection\DocBlock](https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocComment` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L540)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocComment(): string;
```
+Get the doc comment of an entity
-
Get the doc comment of an entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getDocCommentEntity
- :warning: Is internal | source code
-
+---
+
# `getDocCommentEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L236)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Link to an entity where docBlock is implemented for this entity
-
Link to an entity where docBlock is implemented for this entity
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
-
-
-
-
-
+
# `getDocCommentLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L202)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocCommentLine(): null|int;
```
+Get the code line number where the docBlock of the current entity begins
-
Get the code line number where the docBlock of the current entity begins
-
-
Parameters: not specified
-
-
Return value: null |
int
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getDocNote` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L527)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getDocNote(): string;
```
+Get the note annotation value
-
Get the note annotation value
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getDocRender` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1262)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getEndLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L469)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEndLine(): int;
```
+Get the line number of the end of a class code in a file
-
Get the line number of the end of a class code in a file
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
Throws:
-
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L171)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getExamples(): array;
```
+Get parsed examples from `examples` doc block
-
Get parsed examples from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1035)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- getFileSourceLink
- :warning: Is internal | source code
-
-
+
# `getFileSourceLink` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L173)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getFirstExample` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L514)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getFirstExample(): string;
```
+Get first example from `examples` doc block
-
Get first example from `examples` doc block
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getImplementingClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L370)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the class like entity in which the current entity was implemented
-
Get the class like entity in which the current entity was implemented
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getInterfaceNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L25)
```php
public function getInterfaceNames(): array;
```
+Get a list of class interface names
-
Get a list of class interface names
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
+---
+
# `getInterfacesEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L587)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getInterfacesEntities(): array;
```
+Get a list of interface entities that the current class implements
-
Get a list of interface entities that the current class implements
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1203)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethod(string $methodName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity;
```
+Get the method entity by its name
-
Get the method entity by its name
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntity.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getMethodEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1133)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection;
```
+Get a collection of method entities
-
Get a collection of method entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Method/MethodEntitiesCollection.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethods` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1162)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethods(): array;
```
+Get all methods that are available according to the configuration as an array
-
Get all methods that are available according to the configuration as an array
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getMethodEntitiesCollection()](ClassLikeEntity_5.md#mgetmethodentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getMethodEntityFilter()](PhpHandlerSettings.md#mgetmethodentityfilter)
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getMethodsData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1059)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getMethodsData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Method\MethodEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all methods and classes where they are implemented
-
Get a list of all methods and classes where they are implemented
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for methods from the current class |
-
-
- $flags |
- int |
- Get data only for methods corresponding to the visibility modifiers passed in this value |
-
-
-
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for methods from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for methods corresponding to the visibility modifiers passed in this value |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getModifiersString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L33)
```php
public function getModifiersString(): string;
```
+Get entity modifiers as a string
-
Get entity modifiers as a string
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L378)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getNamespaceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L397)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getNamespaceName(): string;
```
+Get the entity namespace name
-
Get the entity namespace name
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L142)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getObjectId(): string;
```
+Get entity unique ID
-
Get entity unique ID
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L516)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClass(): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+Get the entity of the parent class if it exists
-
Get the entity of the parent class if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
+---
+
# `getParentClassEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L493)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassEntities(): array;
```
+Get a list of parent class entities
-
Get a list of parent class entities
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getParentClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L506)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassName(): null|string;
```
+Get the name of the parent class entity if it exists
-
Get the name of the parent class entity if it exists
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
-
-
-
-
+---
+
# `getParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L481)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getParentClassNames(): array;
```
+Get a list of entity names of parent classes
-
Get a list of entity names of parent classes
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getPluginData` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L270)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPluginData(string $pluginKey): mixed;
```
+Get additional information added using the plugin
-
Get additional information added using the plugin
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginKey |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginKey | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: mixed
+***Return value:*** [mixed](https://www.php.net/manual/en/language.types.mixed.php)
+---
-
-
-
-
-
-
+
# `getProperties` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L963)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperties(): array;
```
+Get all properties that are available according to the configuration as an array
-
Get all properties that are available according to the configuration as an array
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+***Links:***
+- [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity::getPropertyEntitiesCollection()](ClassLikeEntity_5.md#mgetpropertyentitiescollection)
+- [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings::getPropertyEntityFilter()](PhpHandlerSettings.md#mgetpropertyentityfilter)
+---
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getPropertiesData
- :warning: Is internal | source code
-
-
+
# `getPropertiesData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L872)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertiesData(bool $onlyFromCurrentClassAndTraits = false, int $flags = \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity::VISIBILITY_MODIFIERS_FLAG_ANY): array;
```
+Get a list of all properties and classes where they are implemented
-
Get a list of all properties and classes where they are implemented
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $onlyFromCurrentClassAndTraits |
- bool |
- Get data only for properties from the current class |
-
-
- $flags |
- int |
- Get data only for properties corresponding to the visibility modifiers passed in this value |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$onlyFromCurrentClassAndTraits | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Get data only for properties from the current class |
+$flags | [int](https://www.php.net/manual/en/language.types.integer.php) | Get data only for properties corresponding to the visibility modifiers passed in this value |
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1004)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getProperty(string $propertyName, bool $unsafe = false): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity;
```
+Get the property entity by its name
-
Get the property entity by its name
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to get |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity
-
+***Parameters:***
-
Throws:
-
--
- \DI\DependencyException
+| Name | Type | Description |
+|:-|:-|:-|
+$propertyName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the property whose entity you want to get |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
--
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/SubEntity/Property/PropertyEntity.php)
--
- \DI\NotFoundException
-
-
-
-
-
-
-
-
+---
+
# `getPropertyDefaultValue` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1027)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyDefaultValue(string $propertyName): string|array|int|bool|null|float;
```
+Get the compiled value of a property
-
Get the compiled value of a property
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property for which you need to get the value |
-
-
-
-
-
Return value: string |
array |
int |
bool |
null |
float
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getPropertyEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L934)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getPropertyEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection;
```
+Get a collection of property entities
-
Get a collection of property entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\SubEntity\Property\PropertyEntitiesCollection
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L412)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L160)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get the collection of root entities to which this entity belongs
-
Get the collection of root entities to which this entity belongs
-
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L386)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getStartLine` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L457)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getStartLine(): int;
```
+Get the line number of the start of a class code in a file
-
Get the line number of the start of a class code in a file
-
-
Parameters: not specified
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
-
Return value: int
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L438)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function getThrows(): array;
```
+Get parsed throws from `throws` doc block
-
Get parsed throws from `throws` doc block
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
-
-```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-
-public function getThrowsDocBlockLinks(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L629)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getTraits(): array;
```
+Get a list of trait entities of the current class
-
Get a list of trait entities of the current class
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTraitsNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L604)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function getTraitsNames(): array;
```
+Get a list of class traits names
-
Get a list of class traits names
-
-
Parameters: not specified
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasConstant` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L785)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasConstant(string $constantName, bool $unsafe = false): bool;
```
+Check if a constant exists in a class
-
Check if a constant exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $constantName |
- string |
- The name of the class whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$constantName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all constants, not just the constants allowed in the configuration (@see PhpHandlerSettings::getClassConstantEntityFilter()) |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasDescriptionLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L274)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasDescriptionLinks(): bool;
```
+Checking if an entity has links in its description
-
Checking if an entity has links in its description
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
--
- \Exception
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-
-
+---
+
# `hasExamples` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L478)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasExamples(): bool;
```
+Checking if an entity has `example` docBlock
-
Checking if an entity has `example` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasMethod` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1182)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasMethod(string $methodName, bool $unsafe = false): bool;
```
+Check if a method exists in a class
-
Check if a method exists in a class
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$methodName | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the method whose entity you want to check |
+$unsafe | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $methodName |
- string |
- The name of the method whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all methods, not just the methods allowed in the configuration (@see PhpHandlerSettings::getMethodEntityFilter()) |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `hasParentClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1250)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasParentClass(string $parentClassName): bool;
```
+Check if a certain parent class exists in a chain of parent classes
-
Check if a certain parent class exists in a chain of parent classes
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassName |
- string |
- Searched parent class |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$parentClassName | [string](https://www.php.net/manual/en/language.types.string.php) | Searched parent class |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `hasProperty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L983)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasProperty(string $propertyName, bool $unsafe = false): bool;
```
+Check if a property exists in a class
-
Check if a property exists in a class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $propertyName |
- string |
- The name of the property whose entity you want to check |
-
-
- $unsafe |
- bool |
- Check all properties, not just the properties allowed in the configuration (@see PhpHandlerSettings::getPropertyEntityFilter()) |
-
-
-
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `hasThrows` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L423)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function hasThrows(): bool;
```
+Checking if an entity has `throws` docBlock
-
Checking if an entity has `throws` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `hasTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L644)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function hasTraits(): bool;
```
+Check if the class contains traits
-
Check if the class contains traits
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `implementsInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L1237)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function implementsInterface(string $interfaceName): bool;
```
+Check if a class implements an interface
-
Check if a class implements an interface
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaceName |
- string |
- Name of the required interface in the interface chain |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$interfaceName | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the required interface in the interface chain |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isAbstract` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L445)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isAbstract(): bool;
```
+Check that an entity is abstract
-
Check that an entity is abstract
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isApi` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L246)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isApi(): bool;
```
+Checking if an entity has `api` docBlock
-
Checking if an entity has `api` docBlock
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isClass` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L104)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClass(): bool;
```
+Check if an entity is a Class
-
Check if an entity is a Class
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isClassLoad` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L343)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isClassLoad(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isDeprecated` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L260)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isDeprecated(): bool;
```
+Checking if an entity has `deprecated` docBlock
-
Checking if an entity has `deprecated` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-- #
- isDocumentCreationAllowed
- :warning: Is internal | source code
-
-
+
# `isDocumentCreationAllowed` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L224)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isDocumentCreationAllowed(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
-
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L676)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityCacheOutdated(): bool;
```
+Checking if the entity cache is out of date
-
Checking if the entity cache is out of date
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isEntityDataCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityDataCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L94)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function isEntityDataCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L358)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEntityDataCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityFileCanBeLoad` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L117)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isEntityFileCanBeLoad(): bool;
```
+Checking if entity data can be retrieved
-
Checking if entity data can be retrieved
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L84)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function isEntityNameValid(string $entityName): bool;
```
+Check if the name is a valid name for ClassLikeEntity
-
Check if the name is a valid name for ClassLikeEntity
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isEnum` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L134)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isEnum(): bool;
```
+Check if an entity is an Enum
-
Check if an entity is an Enum
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
-- #
- isExternalLibraryEntity
- :warning: Is internal | source code
-
+---
+
# `isExternalLibraryEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L152)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isExternalLibraryEntity(): bool;
```
+Check if a given entity is an entity from a third party library (connected via composer)
-
Check if a given entity is an entity from a third party library (connected via composer)
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInGit` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L205)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInGit(): bool;
```
+Checking if class file is in git repository
-
Checking if class file is in git repository
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L435)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInstantiable(): bool;
```
+Check that an entity is instantiable
-
Check that an entity is instantiable
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInterface` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L114)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function isInterface(): bool;
```
+Check if an entity is an Interface
-
Check if an entity is an Interface
-
-
Parameters: not specified
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isInternal` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L232)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function isInternal(): bool;
```
+Checking if an entity has `internal` docBlock
-
Checking if an entity has `internal` docBlock
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `isSubclassOf` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L41)
```php
public function isSubclassOf(string $className): bool;
```
+Whether the given class is a subclass of the specified class
-
Whether the given class is a subclass of the specified class
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- - |
-
-
-
-
-
Return value: bool
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isTrait` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/TraitEntity.php#L17)
```php
public function isTrait(): bool;
```
+Check if an entity is a Trait
-
Check if an entity is a Trait
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L94)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public static function normalizeClassName(string $name): string;
```
+Bring the class name to the standard format used in the system
-
Bring the class name to the standard format used in the system
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: string
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- reloadEntityDependenciesCache
- :warning: Is internal | source code
-
+---
+
# `reloadEntityDependenciesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php#L593)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
public function reloadEntityDependenciesCache(): array;
```
+Update entity dependency cache
-
Update entity dependency cache
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- removeEntityValueFromCache
- :warning: Is internal | source code
-
+---
+
# `removeEntityValueFromCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L80)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeEntityValueFromCache(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
-- #
- removeNotUsedEntityDataCache
- :warning: Is internal | source code
-
+---
+
# `removeNotUsedEntityDataCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/Cache/CacheableEntityTrait.php#L116)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function removeNotUsedEntityDataCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `setCustomAst` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php#L284)
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
public function setCustomAst(\PhpParser\Node\Stmt\Trait_|\PhpParser\Node\Stmt\Enum_|\PhpParser\Node\Stmt\Interface_|\PhpParser\Node\Stmt\Class_|null $customAst): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customAst | [\PhpParser\Node\Stmt\Trait_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Trait_.php) \| [\PhpParser\Node\Stmt\Enum_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Enum_.php) \| [\PhpParser\Node\Stmt\Interface_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Interface_.php) \| [\PhpParser\Node\Stmt\Class_](https://github.com/nikic/PHP-Parser/blob/master/lib/PhpParser/Node/Stmt/Class_.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md
index b90b25ed..ca1be811 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP class constant reflection API
-
+---
-Class constant reflection entity class: ClassConstantEntity.
+
+# PHP class constant reflection API
+
+Class constant reflection entity class: [ClassConstantEntity](classes/ClassConstantEntity.md).
**Example of creating class constant reflection:**
@@ -16,35 +24,37 @@ $constantReflection = $classReflection->getConstant('constantName');
**Class constant reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetast): Get AST for this entity
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocCommentLine()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetendline): Get the line number of the end of a constant's code in a file
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetnamespacename): Get the name of the namespace where the current class is implemented
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetobjectid): Get entity unique ID
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetstartline): Get the line number of the beginning of the constant code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [getValue()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mgetvalue): Get the compiled value of a constant
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isPrivate()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#misprivate): Check if a constant is a private constant
-- [isProtected()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#misprotected): Check if a constant is a protected constant
-- [isPublic()](/docs/tech/02_parser/reflectionApi/php/classes/ClassConstantEntity.md#mispublic): Check if a constant is a public constant
-
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+- [getAbsoluteFileName()](classes/ClassConstantEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/ClassConstantEntity.md#mgetast): Get AST for this entity
+- [getDescription()](classes/ClassConstantEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/ClassConstantEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/ClassConstantEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocCommentLine()](classes/ClassConstantEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
+- [getDocNote()](classes/ClassConstantEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/ClassConstantEntity.md#mgetendline): Get the line number of the end of a constant's code in a file
+- [getExamples()](classes/ClassConstantEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/ClassConstantEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getImplementingClass()](classes/ClassConstantEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getModifiersString()](classes/ClassConstantEntity.md#mgetmodifiersstring): Get a text representation of class constant modifiers
+- [getNamespaceName()](classes/ClassConstantEntity.md#mgetnamespacename): Get the name of the namespace where the current class is implemented
+- [getObjectId()](classes/ClassConstantEntity.md#mgetobjectid): Get entity unique ID
+- [getRelativeFileName()](classes/ClassConstantEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getRootEntityCollection()](classes/ClassConstantEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getStartLine()](classes/ClassConstantEntity.md#mgetstartline): Get the line number of the beginning of the constant code in a file
+- [getThrows()](classes/ClassConstantEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [getType()](classes/ClassConstantEntity.md#mgettype): Get current class constant type
+- [getValue()](classes/ClassConstantEntity.md#mgetvalue): Get the compiled value of a constant
+- [hasDescriptionLinks()](classes/ClassConstantEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/ClassConstantEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasThrows()](classes/ClassConstantEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [isApi()](classes/ClassConstantEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isDeprecated()](classes/ClassConstantEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isEntityFileCanBeLoad()](classes/ClassConstantEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isInternal()](classes/ClassConstantEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isPrivate()](classes/ClassConstantEntity.md#misprivate): Check if a constant is a private constant
+- [isProtected()](classes/ClassConstantEntity.md#misprotected): Check if a constant is a protected constant
+- [isPublic()](classes/ClassConstantEntity.md#mispublic): Check if a constant is a public constant
+
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md
index a972c962..4c88784f 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP class method reflection API
-
+---
-Method reflection entity class: MethodEntity.
+
+# PHP class method reflection API
+
+Method reflection entity class: [MethodEntity](classes/MethodEntity.md).
**Example of creating class method reflection:**
@@ -16,50 +24,50 @@ $methodReflection = $classReflection->getMethod('methodName');
**Class method reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetast): Get AST for this entity
-- [getBodyCode()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetbodycode): Get the code for this method
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetendline): Get the line number of the end of a method's code in a file
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getFirstReturnValue()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetfirstreturnvalue): Get the compiled first return value of a method (if possible)
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getImplementingClassName()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetimplementingclassname): Get the name of the class in which this method is implemented
-- [getModifiersString()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetmodifiersstring): Get a text representation of method modifiers
-- [getName()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetname): Full name of the entity
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetnamespacename): Namespace of the class that contains this method
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetobjectid): Get entity unique ID
-- [getParameters()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetparameters): Get a list of method parameters
-- [getParametersString()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetparametersstring): Get a list of method parameters as a string
-- [getParentMethod()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetparentmethod): Get the parent method for this method
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getReturnType()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetreturntype): Get the return type of method
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getShortName()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetshortname): Short name of the entity
-- [getSignature()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetsignature): Get the method signature as a string
-- [getStartColumn()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetstartcolumn): Get the column number of the beginning of the method code in a file
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetstartline): Get the line number of the beginning of the entity code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isConstructor()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misconstructor): Checking that a method is a constructor
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isDynamic()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misdynamic): Check if a method is a dynamic method, that is, implementable using __call or __callStatic
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isImplementedInParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misimplementedinparentclass): Check if this method is implemented in the parent class
-- [isInitialization()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misinitialization): Check if a method is an initialization method
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isPrivate()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misprivate): Check if a method is a private method
-- [isProtected()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misprotected): Check if a method is a protected method
-- [isPublic()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#mispublic): Check if a method is a public method
-- [isStatic()](/docs/tech/02_parser/reflectionApi/php/classes/MethodEntity.md#misstatic): Check if this method is static
+- [getAbsoluteFileName()](classes/MethodEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/MethodEntity.md#mgetast): Get AST for this entity
+- [getBodyCode()](classes/MethodEntity.md#mgetbodycode): Get the code for this method
+- [getDescription()](classes/MethodEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/MethodEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/MethodEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocNote()](classes/MethodEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/MethodEntity.md#mgetendline): Get the line number of the end of a method's code in a file
+- [getExamples()](classes/MethodEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/MethodEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getFirstReturnValue()](classes/MethodEntity.md#mgetfirstreturnvalue): Get the compiled first return value of a method (if possible)
+- [getImplementingClass()](classes/MethodEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getImplementingClassName()](classes/MethodEntity.md#mgetimplementingclassname): Get the name of the class in which this method is implemented
+- [getModifiersString()](classes/MethodEntity.md#mgetmodifiersstring): Get a text representation of method modifiers
+- [getName()](classes/MethodEntity.md#mgetname): Full name of the entity
+- [getNamespaceName()](classes/MethodEntity.md#mgetnamespacename): Namespace of the class that contains this method
+- [getObjectId()](classes/MethodEntity.md#mgetobjectid): Get entity unique ID
+- [getParameters()](classes/MethodEntity.md#mgetparameters): Get a list of method parameters
+- [getParametersString()](classes/MethodEntity.md#mgetparametersstring): Get a list of method parameters as a string
+- [getParentMethod()](classes/MethodEntity.md#mgetparentmethod): Get the parent method for this method
+- [getRelativeFileName()](classes/MethodEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getReturnType()](classes/MethodEntity.md#mgetreturntype): Get the return type of method
+- [getRootEntityCollection()](classes/MethodEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getShortName()](classes/MethodEntity.md#mgetshortname): Short name of the entity
+- [getSignature()](classes/MethodEntity.md#mgetsignature): Get the method signature as a string
+- [getStartColumn()](classes/MethodEntity.md#mgetstartcolumn): Get the column number of the beginning of the method code in a file
+- [getStartLine()](classes/MethodEntity.md#mgetstartline): Get the line number of the beginning of the entity code in a file
+- [getThrows()](classes/MethodEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [hasDescriptionLinks()](classes/MethodEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/MethodEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasThrows()](classes/MethodEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [isApi()](classes/MethodEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isConstructor()](classes/MethodEntity.md#misconstructor): Checking that a method is a constructor
+- [isDeprecated()](classes/MethodEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isDynamic()](classes/MethodEntity.md#misdynamic): Check if a method is a dynamic method, that is, implementable using __call or __callStatic
+- [isEntityFileCanBeLoad()](classes/MethodEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isImplementedInParentClass()](classes/MethodEntity.md#misimplementedinparentclass): Check if this method is implemented in the parent class
+- [isInitialization()](classes/MethodEntity.md#misinitialization): Check if a method is an initialization method
+- [isInternal()](classes/MethodEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isPrivate()](classes/MethodEntity.md#misprivate): Check if a method is a private method
+- [isProtected()](classes/MethodEntity.md#misprotected): Check if a method is a protected method
+- [isPublic()](classes/MethodEntity.md#mispublic): Check if a method is a public method
+- [isStatic()](classes/MethodEntity.md#misstatic): Check if this method is static
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md
index a0dba3d1..98044883 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP class property reflection API
-
+---
-Property reflection entity class: PropertyEntity.
+
+# PHP class property reflection API
+
+Property reflection entity class: [PropertyEntity](classes/PropertyEntity.md).
**Example of creating class property reflection:**
@@ -16,41 +24,41 @@ $propertyReflection = $classReflection->getProperty('propertyName');
**Class property reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetast): Get AST for this entity
-- [getDefaultValue()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetdefaultvalue): Get the compiled default value of a property
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocCommentLine()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetendline): Get the line number of the end of a property's code in a file
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getImplementingClassName()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetimplementingclassname): Get the name of the class in which this property is implemented
-- [getModifiersString()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetmodifiersstring): Get a text representation of property modifiers
-- [getName()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetname): Full name of the entity
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetnamespacename): Namespace of the class that contains this property
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetobjectid): Get entity unique ID
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getShortName()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetshortname): Short name of the entity
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetstartline): Get the line number of the beginning of the entity code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [getType()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mgettype): Get current property type
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isImplementedInParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misimplementedinparentclass): Check if this property is implemented in the parent class
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isPrivate()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misprivate): Check if a private is a public private
-- [isProtected()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#misprotected): Check if a protected is a public protected
-- [isPublic()](/docs/tech/02_parser/reflectionApi/php/classes/PropertyEntity.md#mispublic): Check if a property is a public property
-
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+- [getAbsoluteFileName()](classes/PropertyEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/PropertyEntity.md#mgetast): Get AST for this entity
+- [getDefaultValue()](classes/PropertyEntity.md#mgetdefaultvalue): Get the compiled default value of a property
+- [getDescription()](classes/PropertyEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/PropertyEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/PropertyEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocCommentLine()](classes/PropertyEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
+- [getDocNote()](classes/PropertyEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/PropertyEntity.md#mgetendline): Get the line number of the end of a property's code in a file
+- [getExamples()](classes/PropertyEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/PropertyEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getImplementingClass()](classes/PropertyEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getImplementingClassName()](classes/PropertyEntity.md#mgetimplementingclassname): Get the name of the class in which this property is implemented
+- [getModifiersString()](classes/PropertyEntity.md#mgetmodifiersstring): Get a text representation of property modifiers
+- [getName()](classes/PropertyEntity.md#mgetname): Full name of the entity
+- [getNamespaceName()](classes/PropertyEntity.md#mgetnamespacename): Namespace of the class that contains this property
+- [getObjectId()](classes/PropertyEntity.md#mgetobjectid): Get entity unique ID
+- [getRelativeFileName()](classes/PropertyEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getRootEntityCollection()](classes/PropertyEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getShortName()](classes/PropertyEntity.md#mgetshortname): Short name of the entity
+- [getStartLine()](classes/PropertyEntity.md#mgetstartline): Get the line number of the beginning of the entity code in a file
+- [getThrows()](classes/PropertyEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [getType()](classes/PropertyEntity.md#mgettype): Get current property type
+- [hasDescriptionLinks()](classes/PropertyEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/PropertyEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasThrows()](classes/PropertyEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [isApi()](classes/PropertyEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isDeprecated()](classes/PropertyEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isEntityFileCanBeLoad()](classes/PropertyEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isImplementedInParentClass()](classes/PropertyEntity.md#misimplementedinparentclass): Check if this property is implemented in the parent class
+- [isInternal()](classes/PropertyEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isPrivate()](classes/PropertyEntity.md#misprivate): Check if a private is a public private
+- [isProtected()](classes/PropertyEntity.md#misprotected): Check if a protected is a public protected
+- [isPublic()](classes/PropertyEntity.md#mispublic): Check if a property is a public property
+
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md
index 77561997..4f3465c7 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP class reflection API
-
+---
-PHP class reflection ClassEntity inherits from ClassLikeEntity.
+
+# PHP class reflection API
+
+PHP class reflection [ClassEntity](classes/ClassEntity.md) inherits from [ClassLikeEntity](classes/ClassLikeEntity_4.md).
**Source class formats:**
@@ -20,70 +28,70 @@ $classReflection = $entitiesCollection->getLoadedOrCreateNew('SomeClassName'); /
**Class reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetast): Get AST for this entity
-- [getConstant()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetconstant): Get the method entity by its name
-- [getConstantEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
-- [getConstantValue()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetconstantvalue): Get the compiled value of a constant
-- [getConstants()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
-- [getConstantsValues()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocCommentLine()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetendline): Get the line number of the end of a class code in a file
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getInterfaceNames()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetinterfacenames): Get a list of class interface names
-- [getInterfacesEntities()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
-- [getMethod()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetmethod): Get the method entity by its name
-- [getMethodEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetmethodentitiescollection): Get a collection of method entities
-- [getMethods()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
-- [getName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetname): Full name of the entity
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetnamespacename): Get the entity namespace name
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetobjectid): Get entity unique ID
-- [getParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetparentclass): Get the entity of the parent class if it exists
-- [getParentClassEntities()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetparentclassentities): Get a list of parent class entities
-- [getParentClassName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
-- [getParentClassNames()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
-- [getPluginData()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetplugindata): Get additional information added using the plugin
-- [getProperties()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
-- [getProperty()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetproperty): Get the property entity by its name
-- [getPropertyDefaultValue()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
-- [getPropertyEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getShortName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetshortname): Short name of the entity
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetstartline): Get the line number of the start of a class code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [getTraits()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgettraits): Get a list of trait entities of the current class
-- [getTraitsNames()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mgettraitsnames): Get a list of class traits names
-- [hasConstant()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasconstant): Check if a constant exists in a class
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasMethod()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasmethod): Check if a method exists in a class
-- [hasParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
-- [hasProperty()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasproperty): Check if a property exists in a class
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [hasTraits()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mhastraits): Check if the class contains traits
-- [implementsInterface()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mimplementsinterface): Check if a class implements an interface
-- [isAbstract()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misabstract): Check that an entity is abstract
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isAttribute()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misattribute): Check if a class is an attribute
-- [isClass()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misclass): Check if an entity is a Class
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isEnum()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misenum): Check if an entity is an Enum
-- [isInstantiable()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misinstantiable): Check that an entity is instantiable
-- [isInterface()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misinterface): Check if an entity is an Interface
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isSubclassOf()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#missubclassof): Whether the given class is a subclass of the specified class
-- [isTrait()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mistrait): Check if an entity is a Trait
-- [normalizeClassName()](/docs/tech/02_parser/reflectionApi/php/classes/ClassEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+- [getAbsoluteFileName()](classes/ClassEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/ClassEntity.md#mgetast): Get AST for this entity
+- [getConstant()](classes/ClassEntity.md#mgetconstant): Get the method entity by its name
+- [getConstantEntitiesCollection()](classes/ClassEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
+- [getConstantValue()](classes/ClassEntity.md#mgetconstantvalue): Get the compiled value of a constant
+- [getConstants()](classes/ClassEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
+- [getConstantsValues()](classes/ClassEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
+- [getDescription()](classes/ClassEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/ClassEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/ClassEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocCommentLine()](classes/ClassEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
+- [getDocNote()](classes/ClassEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/ClassEntity.md#mgetendline): Get the line number of the end of a class code in a file
+- [getExamples()](classes/ClassEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/ClassEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getImplementingClass()](classes/ClassEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getInterfaceNames()](classes/ClassEntity.md#mgetinterfacenames): Get a list of class interface names
+- [getInterfacesEntities()](classes/ClassEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
+- [getMethod()](classes/ClassEntity.md#mgetmethod): Get the method entity by its name
+- [getMethodEntitiesCollection()](classes/ClassEntity.md#mgetmethodentitiescollection): Get a collection of method entities
+- [getMethods()](classes/ClassEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
+- [getName()](classes/ClassEntity.md#mgetname): Full name of the entity
+- [getNamespaceName()](classes/ClassEntity.md#mgetnamespacename): Get the entity namespace name
+- [getObjectId()](classes/ClassEntity.md#mgetobjectid): Get entity unique ID
+- [getParentClass()](classes/ClassEntity.md#mgetparentclass): Get the entity of the parent class if it exists
+- [getParentClassEntities()](classes/ClassEntity.md#mgetparentclassentities): Get a list of parent class entities
+- [getParentClassName()](classes/ClassEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
+- [getParentClassNames()](classes/ClassEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
+- [getPluginData()](classes/ClassEntity.md#mgetplugindata): Get additional information added using the plugin
+- [getProperties()](classes/ClassEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
+- [getProperty()](classes/ClassEntity.md#mgetproperty): Get the property entity by its name
+- [getPropertyDefaultValue()](classes/ClassEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
+- [getPropertyEntitiesCollection()](classes/ClassEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
+- [getRelativeFileName()](classes/ClassEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getRootEntityCollection()](classes/ClassEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getShortName()](classes/ClassEntity.md#mgetshortname): Short name of the entity
+- [getStartLine()](classes/ClassEntity.md#mgetstartline): Get the line number of the start of a class code in a file
+- [getThrows()](classes/ClassEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [getTraits()](classes/ClassEntity.md#mgettraits): Get a list of trait entities of the current class
+- [getTraitsNames()](classes/ClassEntity.md#mgettraitsnames): Get a list of class traits names
+- [hasConstant()](classes/ClassEntity.md#mhasconstant): Check if a constant exists in a class
+- [hasDescriptionLinks()](classes/ClassEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/ClassEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasMethod()](classes/ClassEntity.md#mhasmethod): Check if a method exists in a class
+- [hasParentClass()](classes/ClassEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
+- [hasProperty()](classes/ClassEntity.md#mhasproperty): Check if a property exists in a class
+- [hasThrows()](classes/ClassEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [hasTraits()](classes/ClassEntity.md#mhastraits): Check if the class contains traits
+- [implementsInterface()](classes/ClassEntity.md#mimplementsinterface): Check if a class implements an interface
+- [isAbstract()](classes/ClassEntity.md#misabstract): Check that an entity is abstract
+- [isApi()](classes/ClassEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isAttribute()](classes/ClassEntity.md#misattribute): Check if a class is an attribute
+- [isClass()](classes/ClassEntity.md#misclass): Check if an entity is a Class
+- [isDeprecated()](classes/ClassEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isEntityFileCanBeLoad()](classes/ClassEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isEnum()](classes/ClassEntity.md#misenum): Check if an entity is an Enum
+- [isInstantiable()](classes/ClassEntity.md#misinstantiable): Check that an entity is instantiable
+- [isInterface()](classes/ClassEntity.md#misinterface): Check if an entity is an Interface
+- [isInternal()](classes/ClassEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isSubclassOf()](classes/ClassEntity.md#missubclassof): Whether the given class is a subclass of the specified class
+- [isTrait()](classes/ClassEntity.md#mistrait): Check if an entity is a Trait
+- [normalizeClassName()](classes/ClassEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md b/docs/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md
index 8d8df162..d4dbeeb7 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md
@@ -1,28 +1,36 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP entities collection
-
+---
+
+
+# PHP entities collection
**PHP entities collection API methods:**
-- [add()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#madd): Add an entity to the collection
-- [filterByInterfaces()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mfilterbyinterfaces): Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-- [filterByNameRegularExpression()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mfilterbynameregularexpression): Get a copy of the current collection with only entities whose names match the regular expression
-- [filterByParentClassNames()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mfilterbyparentclassnames): Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-- [filterByPaths()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mfilterbypaths): Get a copy of the current collection only with entities filtered by file paths (from project_root)
-- [findEntity()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mfindentity): Find an entity in a collection
-- [get()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mget): Get an entity from a collection (only previously added)
-- [getEntityCollectionName()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mgetentitycollectionname): Get collection name
-- [getLoadedOrCreateNew()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mgetloadedorcreatenew): Get an entity from the collection or create a new one if it has not yet been added
-- [getOnlyAbstractClasses()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mgetonlyabstractclasses): Get a copy of the current collection with only abstract classes
-- [getOnlyInstantiable()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mgetonlyinstantiable): Get a copy of the current collection with only instantiable entities
-- [getOnlyInterfaces()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mgetonlyinterfaces): Get a copy of the current collection with only interfaces
-- [getOnlyTraits()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mgetonlytraits): Get a copy of the current collection with only traits
-- [has()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mhas): Check if an entity has been added to the collection
-- [isEmpty()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#misempty): Check if the collection is empty or not
-- [loadEntities()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mloadentities): Load entities into a collection
-- [remove()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mremove): Remove an entity from a collection
-- [toArray()](/docs/tech/02_parser/reflectionApi/php/classes/PhpEntitiesCollection.md#mtoarray): Convert collection to array
+- [add()](classes/PhpEntitiesCollection.md#madd): Add an entity to the collection
+- [filterByInterfaces()](classes/PhpEntitiesCollection.md#mfilterbyinterfaces): Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
+- [filterByNameRegularExpression()](classes/PhpEntitiesCollection.md#mfilterbynameregularexpression): Get a copy of the current collection with only entities whose names match the regular expression
+- [filterByParentClassNames()](classes/PhpEntitiesCollection.md#mfilterbyparentclassnames): Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
+- [filterByPaths()](classes/PhpEntitiesCollection.md#mfilterbypaths): Get a copy of the current collection only with entities filtered by file paths (from project_root)
+- [findEntity()](classes/PhpEntitiesCollection.md#mfindentity): Find an entity in a collection
+- [get()](classes/PhpEntitiesCollection.md#mget): Get an entity from a collection (only previously added)
+- [getEntityCollectionName()](classes/PhpEntitiesCollection.md#mgetentitycollectionname): Get collection name
+- [getLoadedOrCreateNew()](classes/PhpEntitiesCollection.md#mgetloadedorcreatenew): Get an entity from the collection or create a new one if it has not yet been added
+- [getOnlyAbstractClasses()](classes/PhpEntitiesCollection.md#mgetonlyabstractclasses): Get a copy of the current collection with only abstract classes
+- [getOnlyInstantiable()](classes/PhpEntitiesCollection.md#mgetonlyinstantiable): Get a copy of the current collection with only instantiable entities
+- [getOnlyInterfaces()](classes/PhpEntitiesCollection.md#mgetonlyinterfaces): Get a copy of the current collection with only interfaces
+- [getOnlyTraits()](classes/PhpEntitiesCollection.md#mgetonlytraits): Get a copy of the current collection with only traits
+- [has()](classes/PhpEntitiesCollection.md#mhas): Check if an entity has been added to the collection
+- [isEmpty()](classes/PhpEntitiesCollection.md#misempty): Check if the collection is empty or not
+- [loadEntities()](classes/PhpEntitiesCollection.md#mloadentities): Load entities into a collection
+- [remove()](classes/PhpEntitiesCollection.md#mremove): Remove an entity from a collection
+- [toArray()](classes/PhpEntitiesCollection.md#mtoarray): Convert collection to array
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md
index 6084c478..8f455f7b 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP enum reflection API
-
+---
-PHP enum reflection EnumEntity inherits from ClassLikeEntity.
+
+# PHP enum reflection API
+
+PHP enum reflection [EnumEntity](classes/EnumEntity.md) inherits from [ClassLikeEntity](classes/ClassLikeEntity_3.md).
**Source enum formats:**
@@ -18,71 +26,71 @@ $enumReflection = $entitiesCollection->getLoadedOrCreateNew('SomeEnumName'); //
**Enum reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetast): Get AST for this entity
-- [getCasesNames()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetcasesnames): Get enum cases names
-- [getConstant()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetconstant): Get the method entity by its name
-- [getConstantEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
-- [getConstantValue()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetconstantvalue): Get the compiled value of a constant
-- [getConstants()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
-- [getConstantsValues()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocCommentLine()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetendline): Get the line number of the end of a class code in a file
-- [getEnumCaseValue()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetenumcasevalue): Get enum case value
-- [getEnumCases()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetenumcases): Get enum cases values
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getInterfaceNames()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetinterfacenames): Get a list of class interface names
-- [getInterfacesEntities()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
-- [getMethod()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetmethod): Get the method entity by its name
-- [getMethodEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetmethodentitiescollection): Get a collection of method entities
-- [getMethods()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
-- [getName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetname): Full name of the entity
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetnamespacename): Get the entity namespace name
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetobjectid): Get entity unique ID
-- [getParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetparentclass): Get the entity of the parent class if it exists
-- [getParentClassEntities()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetparentclassentities): Get a list of parent class entities
-- [getParentClassName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
-- [getParentClassNames()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
-- [getPluginData()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetplugindata): Get additional information added using the plugin
-- [getProperties()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
-- [getProperty()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetproperty): Get the property entity by its name
-- [getPropertyDefaultValue()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
-- [getPropertyEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getShortName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetshortname): Short name of the entity
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetstartline): Get the line number of the start of a class code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [getTraits()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgettraits): Get a list of trait entities of the current class
-- [getTraitsNames()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mgettraitsnames): Get a list of class traits names
-- [hasConstant()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasconstant): Check if a constant exists in a class
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasMethod()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasmethod): Check if a method exists in a class
-- [hasParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
-- [hasProperty()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasproperty): Check if a property exists in a class
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [hasTraits()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mhastraits): Check if the class contains traits
-- [implementsInterface()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mimplementsinterface): Check if a class implements an interface
-- [isAbstract()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misabstract): Check that an entity is abstract
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isClass()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misclass): Check if an entity is a Class
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isEnum()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misenum): Check if an entity is an Enum
-- [isInstantiable()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misinstantiable): Check that an entity is instantiable
-- [isInterface()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misinterface): Check if an entity is an Interface
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isSubclassOf()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#missubclassof): Whether the given class is a subclass of the specified class
-- [isTrait()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mistrait): Check if an entity is a Trait
-- [normalizeClassName()](/docs/tech/02_parser/reflectionApi/php/classes/EnumEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+- [getAbsoluteFileName()](classes/EnumEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/EnumEntity.md#mgetast): Get AST for this entity
+- [getCasesNames()](classes/EnumEntity.md#mgetcasesnames): Get enum cases names
+- [getConstant()](classes/EnumEntity.md#mgetconstant): Get the method entity by its name
+- [getConstantEntitiesCollection()](classes/EnumEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
+- [getConstantValue()](classes/EnumEntity.md#mgetconstantvalue): Get the compiled value of a constant
+- [getConstants()](classes/EnumEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
+- [getConstantsValues()](classes/EnumEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
+- [getDescription()](classes/EnumEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/EnumEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/EnumEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocCommentLine()](classes/EnumEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
+- [getDocNote()](classes/EnumEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/EnumEntity.md#mgetendline): Get the line number of the end of a class code in a file
+- [getEnumCaseValue()](classes/EnumEntity.md#mgetenumcasevalue): Get enum case value
+- [getEnumCases()](classes/EnumEntity.md#mgetenumcases): Get enum cases values
+- [getExamples()](classes/EnumEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/EnumEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getImplementingClass()](classes/EnumEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getInterfaceNames()](classes/EnumEntity.md#mgetinterfacenames): Get a list of class interface names
+- [getInterfacesEntities()](classes/EnumEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
+- [getMethod()](classes/EnumEntity.md#mgetmethod): Get the method entity by its name
+- [getMethodEntitiesCollection()](classes/EnumEntity.md#mgetmethodentitiescollection): Get a collection of method entities
+- [getMethods()](classes/EnumEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
+- [getName()](classes/EnumEntity.md#mgetname): Full name of the entity
+- [getNamespaceName()](classes/EnumEntity.md#mgetnamespacename): Get the entity namespace name
+- [getObjectId()](classes/EnumEntity.md#mgetobjectid): Get entity unique ID
+- [getParentClass()](classes/EnumEntity.md#mgetparentclass): Get the entity of the parent class if it exists
+- [getParentClassEntities()](classes/EnumEntity.md#mgetparentclassentities): Get a list of parent class entities
+- [getParentClassName()](classes/EnumEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
+- [getParentClassNames()](classes/EnumEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
+- [getPluginData()](classes/EnumEntity.md#mgetplugindata): Get additional information added using the plugin
+- [getProperties()](classes/EnumEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
+- [getProperty()](classes/EnumEntity.md#mgetproperty): Get the property entity by its name
+- [getPropertyDefaultValue()](classes/EnumEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
+- [getPropertyEntitiesCollection()](classes/EnumEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
+- [getRelativeFileName()](classes/EnumEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getRootEntityCollection()](classes/EnumEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getShortName()](classes/EnumEntity.md#mgetshortname): Short name of the entity
+- [getStartLine()](classes/EnumEntity.md#mgetstartline): Get the line number of the start of a class code in a file
+- [getThrows()](classes/EnumEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [getTraits()](classes/EnumEntity.md#mgettraits): Get a list of trait entities of the current class
+- [getTraitsNames()](classes/EnumEntity.md#mgettraitsnames): Get a list of class traits names
+- [hasConstant()](classes/EnumEntity.md#mhasconstant): Check if a constant exists in a class
+- [hasDescriptionLinks()](classes/EnumEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/EnumEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasMethod()](classes/EnumEntity.md#mhasmethod): Check if a method exists in a class
+- [hasParentClass()](classes/EnumEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
+- [hasProperty()](classes/EnumEntity.md#mhasproperty): Check if a property exists in a class
+- [hasThrows()](classes/EnumEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [hasTraits()](classes/EnumEntity.md#mhastraits): Check if the class contains traits
+- [implementsInterface()](classes/EnumEntity.md#mimplementsinterface): Check if a class implements an interface
+- [isAbstract()](classes/EnumEntity.md#misabstract): Check that an entity is abstract
+- [isApi()](classes/EnumEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isClass()](classes/EnumEntity.md#misclass): Check if an entity is a Class
+- [isDeprecated()](classes/EnumEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isEntityFileCanBeLoad()](classes/EnumEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isEnum()](classes/EnumEntity.md#misenum): Check if an entity is an Enum
+- [isInstantiable()](classes/EnumEntity.md#misinstantiable): Check that an entity is instantiable
+- [isInterface()](classes/EnumEntity.md#misinterface): Check if an entity is an Interface
+- [isInternal()](classes/EnumEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isSubclassOf()](classes/EnumEntity.md#missubclassof): Whether the given class is a subclass of the specified class
+- [isTrait()](classes/EnumEntity.md#mistrait): Check if an entity is a Trait
+- [normalizeClassName()](classes/EnumEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md
index 8f6cd7f7..533269a8 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP interface reflection API
-
+---
-PHP interface reflection InterfaceEntity inherits from ClassLikeEntity.
+
+# PHP interface reflection API
+
+PHP interface reflection [InterfaceEntity](classes/InterfaceEntity.md) inherits from [ClassLikeEntity](classes/ClassLikeEntity_2.md).
**Source interface formats:**
@@ -18,68 +26,68 @@ $interfaceReflection = $entitiesCollection->getLoadedOrCreateNew('SomeInterfaceN
**Interface reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetast): Get AST for this entity
-- [getConstant()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetconstant): Get the method entity by its name
-- [getConstantEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
-- [getConstantValue()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetconstantvalue): Get the compiled value of a constant
-- [getConstants()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
-- [getConstantsValues()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocCommentLine()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetendline): Get the line number of the end of a class code in a file
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getInterfaceNames()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetinterfacenames): Get a list of class interface names
-- [getInterfacesEntities()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
-- [getMethod()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetmethod): Get the method entity by its name
-- [getMethodEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetmethodentitiescollection): Get a collection of method entities
-- [getMethods()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
-- [getName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetname): Full name of the entity
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetnamespacename): Get the entity namespace name
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetobjectid): Get entity unique ID
-- [getParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetparentclass): Get the entity of the parent class if it exists
-- [getParentClassEntities()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetparentclassentities): Get a list of parent class entities
-- [getParentClassName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
-- [getParentClassNames()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
-- [getPluginData()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetplugindata): Get additional information added using the plugin
-- [getProperties()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
-- [getProperty()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetproperty): Get the property entity by its name
-- [getPropertyDefaultValue()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
-- [getPropertyEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getShortName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetshortname): Short name of the entity
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetstartline): Get the line number of the start of a class code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [getTraits()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgettraits): Get a list of trait entities of the current class
-- [getTraitsNames()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mgettraitsnames): Get a list of class traits names
-- [hasConstant()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasconstant): Check if a constant exists in a class
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasMethod()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasmethod): Check if a method exists in a class
-- [hasParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
-- [hasProperty()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasproperty): Check if a property exists in a class
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [hasTraits()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mhastraits): Check if the class contains traits
-- [implementsInterface()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mimplementsinterface): Check if a class implements an interface
-- [isAbstract()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misabstract): Check that an entity is abstract
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isClass()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misclass): Check if an entity is a Class
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isEnum()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misenum): Check if an entity is an Enum
-- [isInstantiable()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misinstantiable): Check that an entity is instantiable
-- [isInterface()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misinterface): Check if an entity is an Interface
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isSubclassOf()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#missubclassof): Whether the given class is a subclass of the specified class
-- [isTrait()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mistrait): Check if an entity is a Trait
-- [normalizeClassName()](/docs/tech/02_parser/reflectionApi/php/classes/InterfaceEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+- [getAbsoluteFileName()](classes/InterfaceEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/InterfaceEntity.md#mgetast): Get AST for this entity
+- [getConstant()](classes/InterfaceEntity.md#mgetconstant): Get the method entity by its name
+- [getConstantEntitiesCollection()](classes/InterfaceEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
+- [getConstantValue()](classes/InterfaceEntity.md#mgetconstantvalue): Get the compiled value of a constant
+- [getConstants()](classes/InterfaceEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
+- [getConstantsValues()](classes/InterfaceEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
+- [getDescription()](classes/InterfaceEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/InterfaceEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/InterfaceEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocCommentLine()](classes/InterfaceEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
+- [getDocNote()](classes/InterfaceEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/InterfaceEntity.md#mgetendline): Get the line number of the end of a class code in a file
+- [getExamples()](classes/InterfaceEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/InterfaceEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getImplementingClass()](classes/InterfaceEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getInterfaceNames()](classes/InterfaceEntity.md#mgetinterfacenames): Get a list of class interface names
+- [getInterfacesEntities()](classes/InterfaceEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
+- [getMethod()](classes/InterfaceEntity.md#mgetmethod): Get the method entity by its name
+- [getMethodEntitiesCollection()](classes/InterfaceEntity.md#mgetmethodentitiescollection): Get a collection of method entities
+- [getMethods()](classes/InterfaceEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
+- [getName()](classes/InterfaceEntity.md#mgetname): Full name of the entity
+- [getNamespaceName()](classes/InterfaceEntity.md#mgetnamespacename): Get the entity namespace name
+- [getObjectId()](classes/InterfaceEntity.md#mgetobjectid): Get entity unique ID
+- [getParentClass()](classes/InterfaceEntity.md#mgetparentclass): Get the entity of the parent class if it exists
+- [getParentClassEntities()](classes/InterfaceEntity.md#mgetparentclassentities): Get a list of parent class entities
+- [getParentClassName()](classes/InterfaceEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
+- [getParentClassNames()](classes/InterfaceEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
+- [getPluginData()](classes/InterfaceEntity.md#mgetplugindata): Get additional information added using the plugin
+- [getProperties()](classes/InterfaceEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
+- [getProperty()](classes/InterfaceEntity.md#mgetproperty): Get the property entity by its name
+- [getPropertyDefaultValue()](classes/InterfaceEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
+- [getPropertyEntitiesCollection()](classes/InterfaceEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
+- [getRelativeFileName()](classes/InterfaceEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getRootEntityCollection()](classes/InterfaceEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getShortName()](classes/InterfaceEntity.md#mgetshortname): Short name of the entity
+- [getStartLine()](classes/InterfaceEntity.md#mgetstartline): Get the line number of the start of a class code in a file
+- [getThrows()](classes/InterfaceEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [getTraits()](classes/InterfaceEntity.md#mgettraits): Get a list of trait entities of the current class
+- [getTraitsNames()](classes/InterfaceEntity.md#mgettraitsnames): Get a list of class traits names
+- [hasConstant()](classes/InterfaceEntity.md#mhasconstant): Check if a constant exists in a class
+- [hasDescriptionLinks()](classes/InterfaceEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/InterfaceEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasMethod()](classes/InterfaceEntity.md#mhasmethod): Check if a method exists in a class
+- [hasParentClass()](classes/InterfaceEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
+- [hasProperty()](classes/InterfaceEntity.md#mhasproperty): Check if a property exists in a class
+- [hasThrows()](classes/InterfaceEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [hasTraits()](classes/InterfaceEntity.md#mhastraits): Check if the class contains traits
+- [implementsInterface()](classes/InterfaceEntity.md#mimplementsinterface): Check if a class implements an interface
+- [isAbstract()](classes/InterfaceEntity.md#misabstract): Check that an entity is abstract
+- [isApi()](classes/InterfaceEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isClass()](classes/InterfaceEntity.md#misclass): Check if an entity is a Class
+- [isDeprecated()](classes/InterfaceEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isEntityFileCanBeLoad()](classes/InterfaceEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isEnum()](classes/InterfaceEntity.md#misenum): Check if an entity is an Enum
+- [isInstantiable()](classes/InterfaceEntity.md#misinstantiable): Check that an entity is instantiable
+- [isInterface()](classes/InterfaceEntity.md#misinterface): Check if an entity is an Interface
+- [isInternal()](classes/InterfaceEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isSubclassOf()](classes/InterfaceEntity.md#missubclassof): Whether the given class is a subclass of the specified class
+- [isTrait()](classes/InterfaceEntity.md#mistrait): Check if an entity is a Trait
+- [normalizeClassName()](classes/InterfaceEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md b/docs/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md
index 0d06f9b9..88175a3f 100644
--- a/docs/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md
+++ b/docs/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md
@@ -1,8 +1,16 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+[Reflection API for PHP](readme.md) **/**
+PHP trait reflection API
-
+---
-PHP trait reflection TraitEntity inherits from ClassLikeEntity.
+
+# PHP trait reflection API
+
+PHP trait reflection [TraitEntity](classes/TraitEntity.md) inherits from [ClassLikeEntity](classes/ClassLikeEntity.md).
**Source trait formats:**
@@ -18,68 +26,68 @@ $traitReflection = $entitiesCollection->getLoadedOrCreateNew('SomeTraitName'); /
**Trait reflection API methods:**
-- [getAbsoluteFileName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-- [getAst()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetast): Get AST for this entity
-- [getConstant()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetconstant): Get the method entity by its name
-- [getConstantEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
-- [getConstantValue()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetconstantvalue): Get the compiled value of a constant
-- [getConstants()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
-- [getConstantsValues()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
-- [getDescription()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetdescription): Get entity description
-- [getDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
-- [getDocComment()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetdoccomment): Get the doc comment of an entity
-- [getDocCommentLine()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
-- [getDocNote()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetdocnote): Get the note annotation value
-- [getEndLine()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetendline): Get the line number of the end of a class code in a file
-- [getExamples()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetexamples): Get parsed examples from `examples` doc block
-- [getFirstExample()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetfirstexample): Get first example from `examples` doc block
-- [getImplementingClass()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
-- [getInterfaceNames()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetinterfacenames): Get a list of class interface names
-- [getInterfacesEntities()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
-- [getMethod()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetmethod): Get the method entity by its name
-- [getMethodEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetmethodentitiescollection): Get a collection of method entities
-- [getMethods()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
-- [getName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetname): Full name of the entity
-- [getNamespaceName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetnamespacename): Get the entity namespace name
-- [getObjectId()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetobjectid): Get entity unique ID
-- [getParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetparentclass): Get the entity of the parent class if it exists
-- [getParentClassEntities()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetparentclassentities): Get a list of parent class entities
-- [getParentClassName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
-- [getParentClassNames()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
-- [getPluginData()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetplugindata): Get additional information added using the plugin
-- [getProperties()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
-- [getProperty()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetproperty): Get the property entity by its name
-- [getPropertyDefaultValue()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
-- [getPropertyEntitiesCollection()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
-- [getRelativeFileName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
-- [getRootEntityCollection()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
-- [getShortName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetshortname): Short name of the entity
-- [getStartLine()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetstartline): Get the line number of the start of a class code in a file
-- [getThrows()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgetthrows): Get parsed throws from `throws` doc block
-- [getTraits()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgettraits): Get a list of trait entities of the current class
-- [getTraitsNames()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mgettraitsnames): Get a list of class traits names
-- [hasConstant()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasconstant): Check if a constant exists in a class
-- [hasDescriptionLinks()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
-- [hasExamples()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasexamples): Checking if an entity has `example` docBlock
-- [hasMethod()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasmethod): Check if a method exists in a class
-- [hasParentClass()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
-- [hasProperty()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasproperty): Check if a property exists in a class
-- [hasThrows()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
-- [hasTraits()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mhastraits): Check if the class contains traits
-- [implementsInterface()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mimplementsinterface): Check if a class implements an interface
-- [isAbstract()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misabstract): Check that an entity is abstract
-- [isApi()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misapi): Checking if an entity has `api` docBlock
-- [isClass()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misclass): Check if an entity is a Class
-- [isDeprecated()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
-- [isEntityFileCanBeLoad()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
-- [isEnum()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misenum): Check if an entity is an Enum
-- [isInstantiable()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misinstantiable): Check that an entity is instantiable
-- [isInterface()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misinterface): Check if an entity is an Interface
-- [isInternal()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#misinternal): Checking if an entity has `internal` docBlock
-- [isSubclassOf()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#missubclassof): Whether the given class is a subclass of the specified class
-- [isTrait()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mistrait): Check if an entity is a Trait
-- [normalizeClassName()](/docs/tech/02_parser/reflectionApi/php/classes/TraitEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+- [getAbsoluteFileName()](classes/TraitEntity.md#mgetabsolutefilename): Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+- [getAst()](classes/TraitEntity.md#mgetast): Get AST for this entity
+- [getConstant()](classes/TraitEntity.md#mgetconstant): Get the method entity by its name
+- [getConstantEntitiesCollection()](classes/TraitEntity.md#mgetconstantentitiescollection): Get a collection of constant entities
+- [getConstantValue()](classes/TraitEntity.md#mgetconstantvalue): Get the compiled value of a constant
+- [getConstants()](classes/TraitEntity.md#mgetconstants): Get all constants that are available according to the configuration as an array
+- [getConstantsValues()](classes/TraitEntity.md#mgetconstantsvalues): Get class constant compiled values according to filters
+- [getDescription()](classes/TraitEntity.md#mgetdescription): Get entity description
+- [getDescriptionLinks()](classes/TraitEntity.md#mgetdescriptionlinks): Get parsed links from description and doc blocks `see` and `link`
+- [getDocComment()](classes/TraitEntity.md#mgetdoccomment): Get the doc comment of an entity
+- [getDocCommentLine()](classes/TraitEntity.md#mgetdoccommentline): Get the code line number where the docBlock of the current entity begins
+- [getDocNote()](classes/TraitEntity.md#mgetdocnote): Get the note annotation value
+- [getEndLine()](classes/TraitEntity.md#mgetendline): Get the line number of the end of a class code in a file
+- [getExamples()](classes/TraitEntity.md#mgetexamples): Get parsed examples from `examples` doc block
+- [getFirstExample()](classes/TraitEntity.md#mgetfirstexample): Get first example from `examples` doc block
+- [getImplementingClass()](classes/TraitEntity.md#mgetimplementingclass): Get the class like entity in which the current entity was implemented
+- [getInterfaceNames()](classes/TraitEntity.md#mgetinterfacenames): Get a list of class interface names
+- [getInterfacesEntities()](classes/TraitEntity.md#mgetinterfacesentities): Get a list of interface entities that the current class implements
+- [getMethod()](classes/TraitEntity.md#mgetmethod): Get the method entity by its name
+- [getMethodEntitiesCollection()](classes/TraitEntity.md#mgetmethodentitiescollection): Get a collection of method entities
+- [getMethods()](classes/TraitEntity.md#mgetmethods): Get all methods that are available according to the configuration as an array
+- [getName()](classes/TraitEntity.md#mgetname): Full name of the entity
+- [getNamespaceName()](classes/TraitEntity.md#mgetnamespacename): Get the entity namespace name
+- [getObjectId()](classes/TraitEntity.md#mgetobjectid): Get entity unique ID
+- [getParentClass()](classes/TraitEntity.md#mgetparentclass): Get the entity of the parent class if it exists
+- [getParentClassEntities()](classes/TraitEntity.md#mgetparentclassentities): Get a list of parent class entities
+- [getParentClassName()](classes/TraitEntity.md#mgetparentclassname): Get the name of the parent class entity if it exists
+- [getParentClassNames()](classes/TraitEntity.md#mgetparentclassnames): Get a list of entity names of parent classes
+- [getPluginData()](classes/TraitEntity.md#mgetplugindata): Get additional information added using the plugin
+- [getProperties()](classes/TraitEntity.md#mgetproperties): Get all properties that are available according to the configuration as an array
+- [getProperty()](classes/TraitEntity.md#mgetproperty): Get the property entity by its name
+- [getPropertyDefaultValue()](classes/TraitEntity.md#mgetpropertydefaultvalue): Get the compiled value of a property
+- [getPropertyEntitiesCollection()](classes/TraitEntity.md#mgetpropertyentitiescollection): Get a collection of property entities
+- [getRelativeFileName()](classes/TraitEntity.md#mgetrelativefilename): File name relative to project_root configuration parameter
+- [getRootEntityCollection()](classes/TraitEntity.md#mgetrootentitycollection): Get the collection of root entities to which this entity belongs
+- [getShortName()](classes/TraitEntity.md#mgetshortname): Short name of the entity
+- [getStartLine()](classes/TraitEntity.md#mgetstartline): Get the line number of the start of a class code in a file
+- [getThrows()](classes/TraitEntity.md#mgetthrows): Get parsed throws from `throws` doc block
+- [getTraits()](classes/TraitEntity.md#mgettraits): Get a list of trait entities of the current class
+- [getTraitsNames()](classes/TraitEntity.md#mgettraitsnames): Get a list of class traits names
+- [hasConstant()](classes/TraitEntity.md#mhasconstant): Check if a constant exists in a class
+- [hasDescriptionLinks()](classes/TraitEntity.md#mhasdescriptionlinks): Checking if an entity has links in its description
+- [hasExamples()](classes/TraitEntity.md#mhasexamples): Checking if an entity has `example` docBlock
+- [hasMethod()](classes/TraitEntity.md#mhasmethod): Check if a method exists in a class
+- [hasParentClass()](classes/TraitEntity.md#mhasparentclass): Check if a certain parent class exists in a chain of parent classes
+- [hasProperty()](classes/TraitEntity.md#mhasproperty): Check if a property exists in a class
+- [hasThrows()](classes/TraitEntity.md#mhasthrows): Checking if an entity has `throws` docBlock
+- [hasTraits()](classes/TraitEntity.md#mhastraits): Check if the class contains traits
+- [implementsInterface()](classes/TraitEntity.md#mimplementsinterface): Check if a class implements an interface
+- [isAbstract()](classes/TraitEntity.md#misabstract): Check that an entity is abstract
+- [isApi()](classes/TraitEntity.md#misapi): Checking if an entity has `api` docBlock
+- [isClass()](classes/TraitEntity.md#misclass): Check if an entity is a Class
+- [isDeprecated()](classes/TraitEntity.md#misdeprecated): Checking if an entity has `deprecated` docBlock
+- [isEntityFileCanBeLoad()](classes/TraitEntity.md#misentityfilecanbeload): Checking if entity data can be retrieved
+- [isEnum()](classes/TraitEntity.md#misenum): Check if an entity is an Enum
+- [isInstantiable()](classes/TraitEntity.md#misinstantiable): Check that an entity is instantiable
+- [isInterface()](classes/TraitEntity.md#misinterface): Check if an entity is an Interface
+- [isInternal()](classes/TraitEntity.md#misinternal): Checking if an entity has `internal` docBlock
+- [isSubclassOf()](classes/TraitEntity.md#missubclassof): Whether the given class is a subclass of the specified class
+- [isTrait()](classes/TraitEntity.md#mistrait): Check if an entity is a Trait
+- [normalizeClassName()](classes/TraitEntity.md#mnormalizeclassname): Bring the class name to the standard format used in the system
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/php/readme.md b/docs/tech/02_parser/reflectionApi/php/readme.md
index f489a1d3..5694ced1 100644
--- a/docs/tech/02_parser/reflectionApi/php/readme.md
+++ b/docs/tech/02_parser/reflectionApi/php/readme.md
@@ -1,19 +1,26 @@
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Parser](../../readme.md) **/**
+[Reflection API](../readme.md) **/**
+Reflection API for PHP
-
+---
+
+
+# Reflection API for PHP
The tool we implemented partially replicates the [standard PHP reflection API](https://www.php.net/manual/en/book.reflection.php), but it has some additional capabilities.
In addition, our Reflection API is available for use in every documentation template, plugin, twig function, etc. at `BumbleDocGen`.
-
+## Class like reflections
Using our PHP reflection API you can get information about project entities.
Below is information about the available methods for working with each entity type:
-1) Class reflection
-2) Trait reflection
-3) Interface reflection
-4) Enum reflection
+1) [Class reflection](/docs/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md)
+2) [Trait reflection](/docs/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md)
+3) [Interface reflection](/docs/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md)
+4) [Enum reflection](/docs/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md)
**Usage example:**
@@ -30,13 +37,13 @@ $entityClassCodeStartLine = $classReflection->getStartLine();
// ... etc.
```
-
+## Entities collection
Class reflections are stored in collections. The collection is filled either before documents are generated,
if the Reflection API is used to generate documentation, or when special methods are called that, under certain conditions, fill them with the required reflections.
You can perform a number of filtering and searching operations on a collection of entities.
-The collections API is presented on this page: PHP entities collection
+The collections API is presented on this page: [PHP entities collection](/docs/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md)
**Usage example:**
@@ -61,13 +68,13 @@ foreach($entitiesCollection as $classReflection) {
}
```
-
+## Class like sub entities reflections
PHP classes contain methods, properties and constants. Below is information about these child entities:
-1) Class method reflection
-2) Class property reflection
-3) Class constant reflection
+1) [Class method reflection](/docs/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md)
+2) [Class property reflection](/docs/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md)
+3) [Class constant reflection](/docs/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md)
**Usage example:**
@@ -86,6 +93,6 @@ $firstMethodReturnValue = $methodReflection->getFirstReturnValue();
// ... etc.
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/reflectionApi/readme.md b/docs/tech/02_parser/reflectionApi/readme.md
index f30625e1..643c51c7 100644
--- a/docs/tech/02_parser/reflectionApi/readme.md
+++ b/docs/tech/02_parser/reflectionApi/readme.md
@@ -1,67 +1,69 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Parser](../readme.md) **/**
+Reflection API
-
+---
+
+
+# Reflection API
The documentation generator has a convenient Reflection API for analyzing the source code of the project being documented.
You can use the Reflection API both in documentation templates and simply in your code where necessary.
**See:**
-1) **Reflection API for PHP**
+1) **[Reflection API for PHP](/docs/tech/02_parser/reflectionApi/php/readme.md)**
2) **[Demo](/demo/demo6-reflection-api/demoScript.php)**
-
+## Example
```php
- // Create a Reflection API config object. This example shows the config for parsing PHP code
- $reflectionApiConfig = PhpReflectionApiConfig::create();
-
- /** @var PhpEntitiesCollection $entitiesCollection*/
- $entitiesCollection = (new BumbleDocGenDocGeneratorFactory())->createRootEntitiesCollection($reflectionApiConfig);
-
- // Source locators are needed so that we can determine all the files that will be traversed to fill the collection with data
- $sourceLocators = SourceLocatorsCollection::create(new DirectoriesSourceLocator([__DIR__]));
-
- // We can define special filters according to which entities will be loaded
- $filter = new TrueCondition();
-
- // By default the collection is empty. You can populate the collection with data
- $entitiesCollection->loadEntities(
- $sourceLocators,
- $filter
- );
-
- // And now you can use Reflection API
- $filename = $entitiesCollection->get('SomeClassName')?->getAbsoluteFileName();
-
-```
+// Create a Reflection API config object. This example shows the config for parsing PHP code
+$reflectionApiConfig = PhpReflectionApiConfig::create();
+/** @var PhpEntitiesCollection $entitiesCollection*/
+$entitiesCollection = (new \BumbleDocGen\DocGeneratorFactory())->createRootEntitiesCollection($reflectionApiConfig);
-
+// Source locators are needed so that we can determine all the files that will be traversed to fill the collection with data
+$sourceLocators = SourceLocatorsCollection::create(new DirectoriesSourceLocator([__DIR__]));
-```php
- // Create a documentation generator object
- $docGen = (new BumbleDocGenDocGeneratorFactory())->create($configFile);
-
- // Next we get a group of entity collections (according to the configuration)
- $entityCollectionsGroup = $docGen->parseAndGetRootEntityCollectionsGroup();
-
- // Next, we can get a specific collection, for example for PHP entities
- $entitiesCollection = $entityCollectionsGroup->get(PhpEntitiesCollection::class);
-
- // And now you can use Reflection API
- $filename = $entitiesCollection->get('SomeClassName')?->getAbsoluteFileName();
-
+// We can define special filters according to which entities will be loaded
+$filter = new TrueCondition();
+
+// By default, the collection is empty. You can populate the collection with data
+$entitiesCollection->loadEntities(
+ $sourceLocators,
+ $filter
+);
+
+// And now you can use Reflection API
+$filename = $entitiesCollection->get('SomeClassName')?->getAbsoluteFileName();
```
+## Example 2 - Working with the Reflection API through a default parsing mechanism
+
+```php
+// Create a documentation generator object
+$docGen = (new \BumbleDocGen\DocGeneratorFactory())->create($configFile);
+
+// Next we get a group of entity collections (according to the configuration)
+$entityCollectionsGroup = $docGen->parseAndGetRootEntityCollectionsGroup();
+
+// Next, we can get a specific collection, for example for PHP entities
+$entitiesCollection = $entityCollectionsGroup->get(PhpEntitiesCollection::class);
+
+// And now you can use Reflection API
+$filename = $entitiesCollection->get('SomeClassName')?->getAbsoluteFileName();
+```
This method is used in the documentation generation process.
The only difference with the first example is that the first option is more convenient to use as a separate tool.
The settings for which entities will be available to the reflector in this case are taken from the configuration file or configuration array, depending on the method of creating the documentation generator instance.
-In addition, RootEntityCollectionsGroup is always available through DI, for example when you implement some twig function or plugin.
+In addition, [RootEntityCollectionsGroup](classes/RootEntityCollectionsGroup.md) is always available through DI, for example when you implement some twig function or plugin.
+
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/02_parser/sourceLocator.md b/docs/tech/02_parser/sourceLocator.md
index f677a293..62e0189e 100644
--- a/docs/tech/02_parser/sourceLocator.md
+++ b/docs/tech/02_parser/sourceLocator.md
@@ -1,28 +1,37 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Parser](readme.md) **/**
+Source locators
-
+---
+
+
+# Source locators
Source locators are needed so that the parser knows which files to parse, or to get data on a specific file after the primary parsing procedure
Source locators are set in the configuration:
```yaml
- source_locators:
- - class: \BumbleDocGen\Core\Parser\SourceLocator\RecursiveDirectoriesSourceLocator
- arguments:
- directories:
- - "%project_root%/src"
- - "%project_root%/selfdoc"
+source_locators:
+ - class: \\BumbleDocGen\\Core\\Parser\\SourceLocator\\RecursiveDirectoriesSourceLocator
+ arguments:
+ directories:
+ - "%project_root%/src"
+ - "%project_root%/selfdoc"
```
+You can create your own source locators or use any existing ones. All source locators must implement the [SourceLocatorInterface](classes/SourceLocatorInterface.md) interface.
+
+## Built-in source locators
-You can create your own source locators or use any existing ones. All source locators must implement the SourceLocatorInterface interface.
+- [DirectoriesSourceLocator](classes/DirectoriesSourceLocator.md) - Loads all files from the specified directory
+- [FileIteratorSourceLocator](classes/FileIteratorSourceLocator.md) - Loads all files using an iterator
+- [RecursiveDirectoriesSourceLocator](classes/RecursiveDirectoriesSourceLocator.md) - Loads all files from the specified directories, which are traversed recursively
+- [SingleFileSourceLocator](classes/SingleFileSourceLocator.md) - Loads one specific file by its path
-
-
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration.md
index 0d1a5a5f..28881e38 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration.md
@@ -1,763 +1,247 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Front Matter](../frontMatter.md) **/**
+Configuration
+---
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
```php
namespace BumbleDocGen\Core\Configuration;
final class Configuration
```
-
-Configuration project documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAdditionalConsoleCommands
-
--
- getCacheDir
-
--
- getConfigurationVersion
-
--
- getDocGenLibDir
-
--
- getGitClientPath
-
--
- getIfExists
-
--
- getLanguageHandlersCollection
-
--
- getOutputDir
-
--
- getOutputDirBaseUrl
-
--
- getPageLinkProcessor
-
--
- getPlugins
-
--
- getProjectRoot
-
--
- getSourceLocators
-
--
- getTemplatesDir
-
--
- getTwigFilters
-
--
- getTwigFunctions
-
--
- getWorkingDir
-
--
- isCheckFileInGitBeforeCreatingDocEnabled
-
--
- renderWithFrontMatter
-
--
- useSharedCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
```php
public function getCacheDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
```php
public function getConfigurationVersion(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
```php
public function getDocGenLibDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
```php
public function getGitClientPath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
```php
public function getIfExists(mixed $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- mixed |
- - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
```php
public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
```php
public function getOutputDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
```php
public function getOutputDirBaseUrl(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
```php
public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
```php
public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
```php
public function getProjectRoot(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
```php
public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
```php
public function getTemplatesDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
```php
public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
```php
public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
```php
public function getWorkingDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isCheckFileInGitBeforeCreatingDocEnabled
- | source code
-
-
+
# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
```php
public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
```php
public function renderWithFrontMatter(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
```php
public function useSharedCache(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration_2.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration_2.md
index b2770cc8..e7b4e4f0 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration_2.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/Configuration_2.md
@@ -1,763 +1,246 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+Configuration
+---
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
```php
namespace BumbleDocGen\Core\Configuration;
final class Configuration
```
-
-Configuration project documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAdditionalConsoleCommands
-
--
- getCacheDir
-
--
- getConfigurationVersion
-
--
- getDocGenLibDir
-
--
- getGitClientPath
-
--
- getIfExists
-
--
- getLanguageHandlersCollection
-
--
- getOutputDir
-
--
- getOutputDirBaseUrl
-
--
- getPageLinkProcessor
-
--
- getPlugins
-
--
- getProjectRoot
-
--
- getSourceLocators
-
--
- getTemplatesDir
-
--
- getTwigFilters
-
--
- getTwigFunctions
-
--
- getWorkingDir
-
--
- isCheckFileInGitBeforeCreatingDocEnabled
-
--
- renderWithFrontMatter
-
--
- useSharedCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
```php
public function getCacheDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
```php
public function getConfigurationVersion(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
```php
public function getDocGenLibDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
```php
public function getGitClientPath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
```php
public function getIfExists(mixed $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- mixed |
- - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
```php
public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
```php
public function getOutputDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
```php
public function getOutputDirBaseUrl(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
```php
public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
```php
public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
```php
public function getProjectRoot(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
```php
public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
```php
public function getTemplatesDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
```php
public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
```php
public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
```php
public function getWorkingDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isCheckFileInGitBeforeCreatingDocEnabled
- | source code
-
-
+
# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
```php
public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
```php
public function renderWithFrontMatter(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
```php
public function useSharedCache(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrapper.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrapper.md
index 8ba4fd69..83408b62 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrapper.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrapper.md
@@ -1,300 +1,130 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+DocumentedEntityWrapper
+---
+# [DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L14) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
final class DocumentedEntityWrapper
```
+Wrapper for the entity that was requested for documentation
-Wrapper for the entity that was requested for documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getDocRender
-
--
- getDocUrl
- - Get the relative path to the document to be generated
--
- getDocumentTransformableEntity
- - Get entity that is allowed to be documented
--
- getEntityName
-
--
- getFileName
- - The name of the file to be generated
--
- getKey
- - Get document key
--
- getParentDocFilePath
-
--
- setParentDocFilePath
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getDocRender](#mgetdocrender)
+1. [getDocUrl](#mgetdocurl) - Get the relative path to the document to be generated
+1. [getDocumentTransformableEntity](#mgetdocumenttransformableentity) - Get entity that is allowed to be documented
+1. [getEntityName](#mgetentityname)
+1. [getFileName](#mgetfilename) - The name of the file to be generated
+1. [getKey](#mgetkey) - Get document key
+1. [getParentDocFilePath](#mgetparentdocfilepath)
+1. [setParentDocFilePath](#msetparentdocfilepath)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface $documentTransformableEntity, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, string $parentDocFilePath);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$documentTransformableEntity | [\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentTransformableEntityInterface.php) | An entity that is allowed to be documented |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$parentDocFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | The file in which the documentation of the entity was requested |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getDocRender` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L27)
```php
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
-
-
-
-
-
+
# `getDocUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L88)
```php
public function getDocUrl(): string;
```
+Get the relative path to the document to be generated
-
Get the relative path to the document to be generated
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocumentTransformableEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L80)
```php
public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface;
```
+Get entity that is allowed to be documented
-
Get entity that is allowed to be documented
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentTransformableEntityInterface.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface
-
-
-
-
-
-
-
+---
+
# `getEntityName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L40)
```php
public function getEntityName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L72)
```php
public function getFileName(): string;
```
+The name of the file to be generated
-
The name of the file to be generated
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L35)
```php
public function getKey(): string;
```
+Get document key
-
Get document key
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentDocFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L96)
```php
public function getParentDocFilePath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `setParentDocFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L101)
```php
public function setParentDocFilePath(string $parentDocFilePath): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parentDocFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentDocFilePath |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrappersCollection.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrappersCollection.md
index 96e1dcaa..efd89bf6 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrappersCollection.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/DocumentedEntityWrappersCollection.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+DocumentedEntityWrappersCollection
+---
+# [DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L14) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
@@ -14,203 +15,72 @@ namespace BumbleDocGen\Core\Renderer\Context;
final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \Countable
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [count](#mcount)
+1. [createAndAddDocumentedEntityWrapper](#mcreateandadddocumentedentitywrapper)
+1. [getDocumentedEntitiesRelations](#mgetdocumentedentitiesrelations)
+1. [getIterator](#mgetiterator)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- count
-
--
- createAndAddDocumentedEntityWrapper
-
--
- getDocumentedEntitiesRelations
-
--
- getIterator
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L21)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `count` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L76)
```php
public function count(): int;
```
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
-
-
-
-
+
# `createAndAddDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L42)
```php
public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
-
+---
+
# `getDocumentedEntitiesRelations` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L71)
```php
public function getDocumentedEntitiesRelations(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L29)
```php
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
-
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/DrawDocumentationMenu.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/DrawDocumentationMenu.md
index 6da79a1e..750856a8 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/DrawDocumentationMenu.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/DrawDocumentationMenu.md
@@ -1,54 +1,41 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Front Matter](../frontMatter.md) **/**
+DrawDocumentationMenu
+---
+# [DrawDocumentationMenu](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L32) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class DrawDocumentationMenu implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Generate documentation menu in MD format. To generate the menu, the start page is taken,
+and all links with this page are recursively collected for it, after which the html menu is created.
-Generate documentation menu in HTML format. To generate the menu, the start page is taken,
-and all links with this page are recursively collected for it, after which the html menu is created.
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](GetDocumentedEntityUrl_2.md)
+***Examples of using:***
```php
{{ drawDocumentationMenu() }} - The menu contains links to all documents
-
```
-
```php
{{ drawDocumentationMenu('/render/index.md') }} - The menu contains links to all child documents from the /render/index.md file (for example /render/test/index.md)
-
```
-
```php
{{ drawDocumentationMenu(_self) }} - The menu contains links to all child documents from the file where this function was called
-
```
-
```php
{{ drawDocumentationMenu(_self, 2) }} - The menu contains links to all child documents from the file where this function was called, but no more than 2 in depth
-
```
-
-
Settings:
@@ -58,188 +45,66 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$dependencyFactory | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyFactory.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L69)
```php
-public function __invoke(string|null $startPageKey = null, int|null $maxDeep = null): string;
+public function __invoke(array $context, string|null $startPageKey = null, int|null $maxDeep = null): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$startPageKey | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Relative path to the page from which the menu will be generated (only child pages will be taken into account).
+ By default, the main documentation page (readme.md) is used. |
+$maxDeep | [int](https://www.php.net/manual/en/language.types.integer.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Maximum parsing depth of documented links starting from the current page.
+ By default, this restriction is disabled. |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $startPageKey |
- string | null |
- Relative path to the page from which the menu will be generated (only child pages will be taken into account).
- By default, the main documentation page (readme.md) is used. |
-
-
- $maxDeep |
- int | null |
- Maximum parsing depth of documented links starting from the current page.
- By default, this restriction is disabled. |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L42)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L47)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentationPageUrl.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentationPageUrl.md
index 18f448e9..8a92ee16 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentationPageUrl.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentationPageUrl.md
@@ -1,47 +1,37 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Linking templates](../templatesLinking.md) **/**
+GetDocumentationPageUrl
+---
+# [GetDocumentationPageUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L21) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentationPageUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Creates an entity link by object
-Creates an entity link by object
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ getDocumentationPageUrl('Page name') }}
-
```
-
```php
{{ getDocumentationPageUrl('/someDir/someTemplate.md.twig') }}
-
```
-
```php
{{ getDocumentationPageUrl('/docs/someDir/someDocFile.md') }}
-
```
-
```php
{{ getDocumentationPageUrl('readme.md') }}
-
```
-
-
Settings:
@@ -51,179 +41,61 @@ final class GetDocumentationPageUrl implements \BumbleDocGen\Core\Renderer\Twig\
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L25)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L53)
```php
public function __invoke(string $key): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | The key by which to look up the URL of the page.
+ Can be the title of a page, a path to a template, or a generated document |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- The key by which to look up the URL of the page.
- Can be the title of a page, a path to a template, or a generated document |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L31)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L36)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl.md
index 7f5fbfdb..474c6f03 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl.md
@@ -1,56 +1,43 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Linking templates](../templatesLinking.md) **/**
+GetDocumentedEntityUrl
+---
+# [GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L40) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentedEntityUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
+the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
-the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](DocumentedEntityWrapper.md)
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](DocumentedEntityWrappersCollection.md)
+- [\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection](RendererContext.md#pentitywrapperscollection)
+***Examples of using:***
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', 'getFunctions') }}
The function returns a reference to the documented entity, anchored to the getFunctions method
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension') }}
The function returns a reference to the documented entity MainExtension
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', '', false) }}
The function returns a link to the file MainExtension
-
```
-
-
Settings:
@@ -60,204 +47,87 @@ The function returns a link to the file MainExtension
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+1. [process](#mprocess)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L44)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$documentedEntityWrappersCollection | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L81)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | The full name of the entity for which the URL will be retrieved.
+ If the entity is not found, the DEFAULT_URL value will be returned. |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Cursor on the page of the documented entity (for example, the name of a method or property) |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $entityName |
- string |
- The full name of the entity for which the URL will be retrieved.
- If the entity is not found, the DEFAULT_URL value will be returned. |
-
-
- $cursor |
- string |
- Cursor on the page of the documented entity (for example, the name of a method or property) |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L52)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L57)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `process` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L102)
+```php
+public function process(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true, string|null $callingTemplate = null): string;
+```
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+$callingTemplate | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl_2.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl_2.md
index 3e39559c..3cdfcc43 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl_2.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/GetDocumentedEntityUrl_2.md
@@ -1,56 +1,42 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+GetDocumentedEntityUrl
+---
+# [GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L40) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentedEntityUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
+the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
-the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](DocumentedEntityWrapper.md)
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](DocumentedEntityWrappersCollection.md)
+- [\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection](RendererContext.md#pentitywrapperscollection)
+***Examples of using:***
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', 'getFunctions') }}
The function returns a reference to the documented entity, anchored to the getFunctions method
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension') }}
The function returns a reference to the documented entity MainExtension
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', '', false) }}
The function returns a link to the file MainExtension
-
```
-
-
Settings:
@@ -60,204 +46,87 @@ The function returns a link to the file MainExtension
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+1. [process](#mprocess)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L44)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$documentedEntityWrappersCollection | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L81)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | The full name of the entity for which the URL will be retrieved.
+ If the entity is not found, the DEFAULT_URL value will be returned. |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Cursor on the page of the documented entity (for example, the name of a method or property) |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $entityName |
- string |
- The full name of the entity for which the URL will be retrieved.
- If the entity is not found, the DEFAULT_URL value will be returned. |
-
-
- $cursor |
- string |
- Cursor on the page of the documented entity (for example, the name of a method or property) |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L52)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L57)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `process` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L102)
+```php
+public function process(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true, string|null $callingTemplate = null): string;
+```
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+$callingTemplate | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/InvalidConfigurationParameterException.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/InvalidConfigurationParameterException.md
deleted file mode 100644
index 7d350595..00000000
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/InvalidConfigurationParameterException.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception
-```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/LanguageHandlerInterface.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/LanguageHandlerInterface.md
index c0c9d8e4..6aa1704e 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/LanguageHandlerInterface.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/LanguageHandlerInterface.md
@@ -1,12 +1,14 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Templates variables](../templatesVariables.md) **/**
+LanguageHandlerInterface
+---
+# [LanguageHandlerInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlerInterface.php#L12) class:
```php
namespace BumbleDocGen\LanguageHandler;
@@ -14,154 +16,62 @@ namespace BumbleDocGen\LanguageHandler;
interface LanguageHandlerInterface
```
+## Methods
+1. [getCustomTwigFilters](#mgetcustomtwigfilters) - Additional twig filters that are added to the built-in ones when a language handler is included
+1. [getCustomTwigFunctions](#mgetcustomtwigfunctions) - Additional twig functions that are added to the built-in ones when a language handler is included
+1. [getEntityCollection](#mgetentitycollection)
+1. [getLanguageKey](#mgetlanguagekey) - Unique language handler key
+## Methods details:
-
-
-
-
-
-Methods:
-
-
--
- getCustomTwigFilters
- - Additional twig filters that are added to the built-in ones when a language handler is included
--
- getCustomTwigFunctions
- - Additional twig functions that are added to the built-in ones when a language handler is included
--
- getEntityCollection
-
--
- getLanguageKey
- - Unique language handler key
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getCustomTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlerInterface.php#L27)
```php
public function getCustomTwigFilters(\BumbleDocGen\Core\Renderer\Context\RendererContext $context): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+Additional twig filters that are added to the built-in ones when a language handler is included
-
Additional twig filters that are added to the built-in ones when a language handler is included
-
-
Parameters:
-
-
+***Parameters:***
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
-
-
-
-
-
+---
+
# `getCustomTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlerInterface.php#L22)
```php
public function getCustomTwigFunctions(\BumbleDocGen\Core\Renderer\Context\RendererContext $context): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+Additional twig functions that are added to the built-in ones when a language handler is included
-
Additional twig functions that are added to the built-in ones when a language handler is included
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
-
+---
+
# `getEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlerInterface.php#L29)
```php
public function getEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
-
-
-
-
-
-
-
-
+
# `getLanguageKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlerInterface.php#L17)
```php
public static function getLanguageKey(): string;
```
+Unique language handler key
-
Unique language handler key
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/PageHtmlLinkerPlugin.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/PageHtmlLinkerPlugin.md
index 514fbddc..73c526c9 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/PageHtmlLinkerPlugin.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/PageHtmlLinkerPlugin.md
@@ -1,210 +1,96 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Linking templates](../templatesLinking.md) **/**
+PageHtmlLinkerPlugin
+---
+# [PageHtmlLinkerPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageHtmlLinkerPlugin.php#L29) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
final class PageHtmlLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-Adds URLs to empty links in HTML format;
+Adds URLs to empty links in HTML format;
Links may contain:
1) Short entity name
2) Full entity name
3) Relative link to the entity file from the root directory of the project
4) Page title ( title )
5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation
-
-
-Examples of using:
+ 6) Relative reference to the entity document from the root directory of the documentation
+***Examples of using:***
```php
Existent page name => Existent page name
-
```
-
```php
\Namespace\ClassName => Custom title
-
```
-
```php
\Namespace\ClassName => \Namespace\ClassName
-
```
-
```php
Non-existent page name => Non-existent page name
-
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+## Methods details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/PhpEntitiesCollection.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/PhpEntitiesCollection.md
index febcb6b5..486ca19c 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/PhpEntitiesCollection.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/PhpEntitiesCollection.md
@@ -1,883 +1,353 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+[Templates variables](../templatesVariables.md) **/**
+PhpEntitiesCollection
+---
+# [PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L43) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
final class PhpEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection implements \IteratorAggregate
```
-
-Collection of php root entities
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
- - Add an entity to the collection
--
- clearOperationsLogCollection
-
--
- filterByInterfaces
- - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
--
- filterByNameRegularExpression
- - Get a copy of the current collection with only entities whose names match the regular expression
--
- filterByParentClassNames
- - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
--
- filterByPaths
- - Get a copy of the current collection only with entities filtered by file paths (from project_root)
--
- findEntity
- - Find an entity in a collection
--
- get
- - Get an entity from a collection (only previously added)
--
- getEntityCollectionName
- - Get collection name
--
- getEntityLinkData
-
--
- getIterator
-
--
- getLoadedOrCreateNew
- - Get an entity from the collection or create a new one if it has not yet been added
--
- getOnlyAbstractClasses
- - Get a copy of the current collection with only abstract classes
--
- getOnlyInstantiable
- - Get a copy of the current collection with only instantiable entities
--
- getOnlyInterfaces
- - Get a copy of the current collection with only interfaces
--
- getOnlyTraits
- - Get a copy of the current collection with only traits
--
- getOperationsLogCollection
-
--
- has
- - Check if an entity has been added to the collection
--
- internalFindEntity
-
--
- internalGetLoadedOrCreateNew
-
--
- isEmpty
- - Check if the collection is empty or not
--
- loadEntities
- - Load entities into a collection
--
- loadEntitiesByConfiguration
- - Load entities into a collection by configuration
--
- remove
- - Remove an entity from a collection
--
- removeAllNotLoadedEntities
-
--
- toArray
- - Convert collection to array
--
- updateEntitiesCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Collection of php root entities
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [add](#madd) - Add an entity to the collection
+1. [clearOperationsLogCollection](#mclearoperationslogcollection)
+1. [filterByInterfaces](#mfilterbyinterfaces) - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
+1. [filterByNameRegularExpression](#mfilterbynameregularexpression) - Get a copy of the current collection with only entities whose names match the regular expression
+1. [filterByParentClassNames](#mfilterbyparentclassnames) - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
+1. [filterByPaths](#mfilterbypaths) - Get a copy of the current collection only with entities filtered by file paths (from project_root)
+1. [findEntity](#mfindentity) - Find an entity in a collection
+1. [get](#mget) - Get an entity from a collection (only previously added)
+1. [getEntityCollectionName](#mgetentitycollectionname) - Get collection name
+1. [getEntityLinkData](#mgetentitylinkdata)
+1. [getIterator](#mgetiterator)
+1. [getLoadedOrCreateNew](#mgetloadedorcreatenew) - Get an entity from the collection or create a new one if it has not yet been added
+1. [getOnlyAbstractClasses](#mgetonlyabstractclasses) - Get a copy of the current collection with only abstract classes
+1. [getOnlyInstantiable](#mgetonlyinstantiable) - Get a copy of the current collection with only instantiable entities
+1. [getOnlyInterfaces](#mgetonlyinterfaces) - Get a copy of the current collection with only interfaces
+1. [getOnlyTraits](#mgetonlytraits) - Get a copy of the current collection with only traits
+1. [getOperationsLogCollection](#mgetoperationslogcollection)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [internalFindEntity](#minternalfindentity)
+1. [internalGetLoadedOrCreateNew](#minternalgetloadedorcreatenew)
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadEntities](#mloadentities) - Load entities into a collection
+1. [loadEntitiesByConfiguration](#mloadentitiesbyconfiguration) - Load entities into a collection by configuration
+1. [remove](#mremove) - Remove an entity from a collection
+1. [removeAllNotLoadedEntities](#mremoveallnotloadedentities)
+1. [toArray](#mtoarray) - Convert collection to array
+1. [updateEntitiesCache](#mupdateentitiescache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L50)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
+$docRendererHelper | [\BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/EntityDocRenderer/EntityDocRendererHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L190)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Add an entity to the collection
-
Add an entity to the collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
Throws:
-
-
-
-
-
-
-
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+
+---
+
+
# `clearOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L28)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function clearOperationsLogCollection(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `filterByInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L244)
```php
public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaces |
- string[] |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByNameRegularExpression` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L321)
```php
public function filterByNameRegularExpression(string $regexPattern): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only entities whose names match the regular expression
-
Get a copy of the current collection with only entities whose names match the regular expression
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $regexPattern |
- string |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$regexPattern | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `filterByParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L270)
```php
public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassNames |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByPaths` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L298)
```php
public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $paths |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$paths | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `findEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L118)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function findEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Find an entity in a collection
+
+***Parameters:***
-
Find an entity in a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- - |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
+
+---
+
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L86)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from a collection (only previously added)
-
Get an entity from a collection (only previously added)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
-
-
-
-
+---
+
# `getEntityCollectionName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L66)
```php
public function getEntityCollectionName(): string;
```
+Get collection name
-
Get collection name
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- getEntityLinkData
- :warning: Is internal | source code
-
+---
+
# `getEntityLinkData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L508)
```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$rawLink | [string](https://www.php.net/manual/en/language.types.string.php) | Raw link to an entity or entity element |
+$defaultEntityName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Entity name to use if the link does not contain a valid or existing entity name,
+ but only a cursor on an entity element |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rawLink |
- string |
- Raw link to an entity or entity element |
-
-
- $defaultEntityName |
- string | null |
- Entity name to use if the link does not contain a valid or existing entity name,
- but only a cursor on an entity element |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `getLoadedOrCreateNew` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L102)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from the collection or create a new one if it has not yet been added
-
Get an entity from the collection or create a new one if it has not yet been added
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
See:
-
-
-
-
-
-
+***Parameters:***
-```php
-public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
-```
-
-
Get a copy of the current collection with only abstract classes
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Links:***
+- [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface::isEntityDataCanBeLoaded()](RootEntityInterface.md#misentitydatacanbeloaded)
+---
-
Throws:
-
+
# `getOnlyAbstractClasses` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L388)
+```php
+public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get a copy of the current collection with only abstract classes
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `getOnlyInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L338)
```php
public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only instantiable entities
-
Get a copy of the current collection with only instantiable entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getOnlyInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L354)
```php
public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only interfaces
-
Get a copy of the current collection with only interfaces
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOnlyTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L370)
```php
public function getOnlyTraits(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only traits
-
Get a copy of the current collection with only traits
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getOperationsLogCollection(): \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLogOperation/OperationsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- internalFindEntity
- :warning: Is internal | source code
-
+---
+
# `internalFindEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L421)
```php
public function internalFindEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
If the request refers to multiple existing entities and if unsafe keys are allowed,
- a warning will be shown and the first entity found will be used. |
-
-
- $useUnsafeKeys |
- bool |
- Whether to use search keys that can be used to find several entities |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+ a warning will be shown and the first entity found will be used. |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Whether to use search keys that can be used to find several entities |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
-
-
Examples of using:
-
+***Examples of using:***
```php
$entitiesCollection->findEntity('App'); // class name
$entitiesCollection->findEntity('BumbleDocGen\Console\App'); // class with namespace
@@ -889,318 +359,118 @@ $entitiesCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen
$entitiesCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/App.php'); // source link
```
-
-
-
-
-
-- #
- internalGetLoadedOrCreateNew
- :warning: Is internal | source code
-
+---
+
# `internalGetLoadedOrCreateNew` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L214)
```php
public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `loadEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L100)
```php
public function loadEntities(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection $sourceLocatorsCollection, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface|null $filters = null, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+Load entities into a collection
-
Load entities into a collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- loadEntitiesByConfiguration
- :warning: Is internal | source code
-
-
-```php
-public function loadEntitiesByConfiguration(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
-```
-
-
Load entities into a collection by configuration
-
-
Parameters:
-
-
+***Parameters:***
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
+| Name | Type | Description |
+|:-|:-|:-|
+$sourceLocatorsCollection | [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php) | - |
+$filters | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `removeAllNotLoadedEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L132)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function removeAllNotLoadedEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `toArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L127)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function toArray(): array;
```
+Convert collection to array
-
Convert collection to array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- updateEntitiesCache
- :warning: Is internal | source code
-
+---
+
# `updateEntitiesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L97)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function updateEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/RendererContext.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/RendererContext.md
index c7b2bcdf..2de8bc62 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/RendererContext.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/RendererContext.md
@@ -1,256 +1,112 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+RendererContext
+---
+# [RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
final class RendererContext
```
+Document rendering context
-Document rendering context
-
-
-
-
-
-
-
-Methods:
-
-
--
- addDependency
-
--
- clearDependencies
-
--
- getCurrentDocumentedEntityWrapper
-
--
- getCurrentTemplateFilePatch
- - Getting the path to the template file that is currently being worked on
--
- getDependencies
-
--
- setCurrentDocumentedEntityWrapper
-
--
- setCurrentTemplateFilePatch
- - Saving the path to the template file that is currently being worked on in the context
-
-
-
+## Methods
+1. [addDependency](#madddependency)
+1. [clearDependencies](#mcleardependencies)
+1. [getCurrentDocumentedEntityWrapper](#mgetcurrentdocumentedentitywrapper)
+1. [getCurrentTemplateFilePatch](#mgetcurrenttemplatefilepatch) - Getting the path to the template file that is currently being worked on
+1. [getDependencies](#mgetdependencies)
+1. [setCurrentDocumentedEntityWrapper](#msetcurrentdocumentedentitywrapper)
+1. [setCurrentTemplateFilePatch](#msetcurrenttemplatefilepatch) - Saving the path to the template file that is currently being worked on in the context
+## Methods details:
-
-
-Method details:
-
-
-
-
-
+
# `addDependency` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L53)
```php
public function addDependency(\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface $dependency): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$dependency | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyInterface.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `clearDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L48)
```php
public function clearDependencies(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `getCurrentDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L43)
```php
public function getCurrentDocumentedEntityWrapper(): null|\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
-
-
-
-
-
+
# `getCurrentTemplateFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L32)
```php
public function getCurrentTemplateFilePatch(): string;
```
+Getting the path to the template file that is currently being worked on
-
Getting the path to the template file that is currently being worked on
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L58)
```php
public function getDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `setCurrentDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L37)
```php
public function setCurrentDocumentedEntityWrapper(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $currentDocumentedEntityWrapper): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$currentDocumentedEntityWrapper | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `setCurrentTemplateFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L24)
```php
public function setCurrentTemplateFilePatch(string $currentTemplateFilePath): void;
```
+Saving the path to the template file that is currently being worked on in the context
-
Saving the path to the template file that is currently being worked on in the context
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentTemplateFilePath |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$currentTemplateFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md
index 5a9d1055..c9e67d65 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md
@@ -1,469 +1,218 @@
-
-
-
-
+[BumbleDocGen](../../../../README.md) **/**
+[Technical description of the project](../../../readme.md) **/**
+[Renderer](../../readme.md) **/**
+[How to create documentation templates?](../readme.md) **/**
+RootEntityInterface
+---
+# [RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L11) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
interface RootEntityInterface extends \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
+Since the documentation generator supports several programming languages,
+their entities need to correspond to the same interfaces
-Since the documentation generator supports several programming languages,
-their entities need to correspond to the same interfaces
-
-
-
-
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getEntityDependencies
-
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getName
- - Full name of the entity
--
- getObjectId
- - Entity object ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- isEntityCacheOutdated
-
--
- isEntityDataCanBeLoaded
- - Checking if it is possible to get the entity data
--
- isEntityNameValid
- - Check if entity name is valid
--
- isExternalLibraryEntity
- - The entity is loaded from a third party library and should not be treated the same as a standard one
--
- isInGit
- - The entity file is in the git repository
--
- normalizeClassName
-
-
+## Methods
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getName](#mgetname) - Full name of the entity
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded) - Checking if it is possible to get the entity data
+1. [isEntityNameValid](#misentitynamevalid) - Check if entity name is valid
+1. [isExternalLibraryEntity](#misexternallibraryentity) - The entity is loaded from a third party library and should not be treated the same as a standard one
+1. [isInGit](#misingit) - The entity file is in the git repository
+1. [normalizeClassName](#mnormalizeclassname)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L53)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L33)
```php
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L40)
```php
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileSourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L42)
```php
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L30)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L16)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration_2.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L37)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L58)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L23)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+Checking if it is possible to get the entity data
-
Checking if it is possible to get the entity data
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L18)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if entity name is valid
-
Check if entity name is valid
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isExternalLibraryEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L28)
```php
public function isExternalLibraryEntity(): bool;
```
+The entity is loaded from a third party library and should not be treated the same as a standard one
-
The entity is loaded from a third party library and should not be treated the same as a standard one
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isInGit` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L38)
```php
public function isInGit(): bool;
```
+The entity file is in the git repository
-
The entity file is in the git repository
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L13)
```php
public static function normalizeClassName(string $name): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md b/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md
index 278c0591..775ee369 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md
@@ -1,6 +1,13 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[How to create documentation templates?](readme.md) **/**
+Front Matter
-
+---
+
+
+# Front Matter
Front Matter is a special block at the top of a document template or generated document that contains certain important meta information.
@@ -18,13 +25,13 @@ some template content ...
The content of this block must be in YAML format.
During the template generation process, this block is parsed, and all values become available in the form of twig variables.
-By default, this block is hidden from generated MD files, but it can be displayed by enabling the special option render_with_front_matter in the configuration
+By default, this block is hidden from generated MD files, but it can be displayed by enabling the special option [render_with_front_matter](classes/Configuration.md#mrenderwithfrontmatter) in the configuration
-Some Front Matter block variables are used internally in our system, for example `title` and `prevPage` are used to generate breadcrumbs and documentation menus.
+Some Front Matter block variables are used internally in our system, for example `title` and `prevPage` are used to generate [breadcrumbs](/docs/tech/03_renderer/02_breadcrumbs.md) and [documentation menus](classes/DrawDocumentationMenu.md).
This block is also used when generating HTML documentation. You can learn about the variables used in this block when generating HTML content [in the documentation of the library](https://daux.io/Features/Front_Matter.html) that we use to create HTML pages.
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/readme.md b/docs/tech/03_renderer/01_howToCreateTemplates/readme.md
index 95f8c7c0..1b5fe4dd 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/readme.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/readme.md
@@ -1,106 +1,105 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+How to create documentation templates?
-
+---
+
+
+# How to create documentation templates?
Templates are `twig` files in which you can write both static text and dynamic blocks that will change from code changes or other required parameters.
**You can read more about template parts here:**
-
-
+- [Front Matter](frontMatter.md)
+- [Templates dynamic blocks](templatesDynamicBlocks.md)
+- [Linking templates](templatesLinking.md)
+- [Templates variables](templatesVariables.md)
+
+## Examples
-
+### 1) An example of a template with fully static text:
```twig
- Some static text
- This text does not change when the code is changed
+Some static text
+This text does not change when the code is changed
```
-
After generating the documentation, this page will look exactly like a template.
-
+### 2) An example of a template with static text and dynamic blocks:
```twig
- ---
- title: Some page
- prevPage: Technical description of the project
- ---
- {{ generatePageBreadcrumbs(title, _self) }}
-
- Some static text...
-
- Dynamic block:
-
- {{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
-
- More static text...
-
-```
+---
+title: Some page
+prevPage: Technical description of the project
+---
+{{ drawPageBreadcrumbs() }}
+Some static text...
-Result after starting the documentation generation process:
+Dynamic block:
-```html
-
-
- Some static text...
-
- Dynamic block:
-
-
-
- More static text...
-
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Jul 29 17:43:49 2023 +0300
Page content update date: Sun Jul 30 2023
Made with
Bumble Documentation Generator
-
+{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
+
+More static text...
```
+Result after starting the documentation generation process:
+
+```md
+
+
+Some static text...
+
+Dynamic block:
+
+
+
+More static text...
+
+
+
+
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Jul 29 17:43:49 2023 +0300
Page content update date: Sun Jul 30 2023
Made with
Bumble Documentation Generator
+```
This is how it looks on the GitHub:
-
+
-
+### 3) Another example of a dynamic block:
Output method description as a dynamic block:
```twig
- Some static text...
-
- Dynamic block:
-
- {{ phpEntities
- .get('\\BumbleDocGen\\LanguageHandler\\LanguageHandlerInterface')
- .getMethod('getLanguageKey')
- .getDescription()
- }}
-
- More static text...
-
-```
+Some static text...
+Dynamic block:
-Result after starting the documentation generation process:
+{{ phpEntities
+ .get('\\BumbleDocGen\\LanguageHandler\\LanguageHandlerInterface')
+ .getMethod('getLanguageKey')
+ .getDescription()
+}}
+More static text...
+```
+Result after starting the documentation generation process:
```twig
- Some static text...
-
- Dynamic block:
-
- Unique language handler key
-
- More static text...
-
+Some static text...
+
+Dynamic block:
+
+Unique language handler key
+
+More static text...
```
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Jan 11 00:14:41 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md b/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md
index 2af0eedd..b32feb31 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md
@@ -1,6 +1,13 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[How to create documentation templates?](readme.md) **/**
+Templates dynamic blocks
-
+---
+
+
+# Templates dynamic blocks
There are several ways to create dynamic blocks in templates.
@@ -8,22 +15,19 @@ There are several ways to create dynamic blocks in templates.
You can use the built-in functions and filters or add your own, so you can implement any logic for generating dynamically changing content.
```twig
- {{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
+{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
```
-
* The second way is to output data from variables directly to the template. For example, you can display a list of classes or methods of documented code according to certain rules.
```twig
- {% for entity in phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable() %}
- * {{ entity.getName() }}
- {% endfor %}
-
+{% for entity in phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable() %}
+ * {{ entity.getName() }}
+{% endfor %}
```
+---
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Jan 11 00:14:41 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md b/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md
index 70c54f40..0f435d63 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md
@@ -1,13 +1,20 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[How to create documentation templates?](readme.md) **/**
+Linking templates
-
+---
+
+
+# Linking templates
One of the main requirements of the documentation is to be able to easily and quickly implement linking between pages.
We have several options for this, such as using special functions or using a special document linking mechanism (`completing blank links`)
-
+## Completing blank links
-Plugin PageHtmlLinkerPlugin have been added to the basic configuration,
+Plugin [PageHtmlLinkerPlugin](classes/PageHtmlLinkerPlugin.md) have been added to the basic configuration,
which process the text of the filled template before its result is written to a file, and fill in all empty links.
For example, an empty link:
@@ -29,13 +36,13 @@ Examples:
[a x-title="test"]Existent page name[/a] => <a href="/docs/some/page/targetPage.md">test</a>
-
+## Generating links through functions
The second way to relink templates is to generate links through functions.
-There are a number of functions that allow you to get a link to an entity, for example GetDocumentedEntityUrl, and there are also functions for getting a link to other documents, for example GetDocumentationPageUrl.
+There are a number of functions that allow you to get a link to an entity, for example [GetDocumentedEntityUrl](classes/GetDocumentedEntityUrl.md), and there are also functions for getting a link to other documents, for example [GetDocumentationPageUrl](classes/GetDocumentationPageUrl.md).
You can also implement your own functions for relinking if necessary.
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 01:40:01 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md b/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md
index b409bc19..d2f9eb6f 100644
--- a/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md
@@ -1,16 +1,23 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[How to create documentation templates?](readme.md) **/**
+Templates variables
-
+---
+
+
+# Templates variables
There are several variables available in each processed template.
1) Firstly, these are built-in twig variables, for example `_self`, which returns the path to the processed template.
-2) Secondly, variables with collections of processed programming languages are available in the template (see LanguageHandlerInterface). For example, when processing a PHP project collection, a collection PhpEntitiesCollection will be available in the template under the name phpEntities
+2) Secondly, variables with collections of processed programming languages are available in the template (see [LanguageHandlerInterface](classes/LanguageHandlerInterface.md)). For example, when processing a PHP project collection, a collection [PhpEntitiesCollection](classes/PhpEntitiesCollection.md) will be available in the template under the name phpEntities
3) Thirdly, all variables specified in **Front Matter** are automatically converted into template variables and are available in it
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/02_breadcrumbs.md b/docs/tech/03_renderer/02_breadcrumbs.md
index 4af6af8e..50816b8e 100644
--- a/docs/tech/03_renderer/02_breadcrumbs.md
+++ b/docs/tech/03_renderer/02_breadcrumbs.md
@@ -1,58 +1,61 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Renderer](readme.md) **/**
+Documentation structure and breadcrumbs
-
+---
-To work with breadcrumbs and get the structure of the documentation, we use the inner class BreadcrumbsHelper.
+
+# Documentation structure and breadcrumbs
+
+To work with breadcrumbs and get the structure of the documentation, we use the inner class [BreadcrumbsHelper](classes/BreadcrumbsHelper.md).
To build the documentation structure, twig templates from the `templates_dir` configuration are used.
-
+## Project structure definitions
To determine the structure of the project, the actual location of the files in the templates directory is used first of all.
For each directory there is an index file ( readme.md or index.md ), and they are used to determine the exact input of each level of nesting.
-
+
But in addition to building the documentation structure using the actual location of template files in directories,
you can explicitly specify the parent page in each template using the special front matter variable `prevPage`:
```markdown
- ---
- prevPage: Prev page name
- ---
+---
+prevPage: Prev page name
+---
```
-
In this way, complex documentation structures can be created with less file nesting:
-
+
-
+## Displaying breadcrumbs in documents
-There is a built-in function to generate breadcrumbs in templates GeneratePageBreadcrumbs.
+There is a built-in function to generate breadcrumbs in templates [DrawPageBreadcrumbs](classes/DrawPageBreadcrumbs_2.md).
Here is how it is used in twig templates:
```twig
- {{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
```
-
To build breadcrumbs, the previously compiled project structure and the names of each template are used.
The template name can be specified using the `title` front matter variable:
```markdown
- ---
- title: Some page title
- ---
+---
+title: Some page title
+---
```
-
-Here is an example of the result of the `generatePageBreadcrumbs` function:
+Here is an example of the result of the `drawPageBreadcrumbs` function:
```twig
-
+
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/03_documentStructure.md b/docs/tech/03_renderer/03_documentStructure.md
index b8d84d88..0bb672fb 100644
--- a/docs/tech/03_renderer/03_documentStructure.md
+++ b/docs/tech/03_renderer/03_documentStructure.md
@@ -1,6 +1,12 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Renderer](readme.md) **/**
+Document structure of generated entities
-
+---
+
+
+# Document structure of generated entities
*By default, the documentation generator offers two options for organizing the structure of generated entity documents:*
@@ -17,6 +23,6 @@ plugins:
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/04_twigCustomFilters.md b/docs/tech/03_renderer/04_twigCustomFilters.md
index 84d544ee..5bcbc532 100644
--- a/docs/tech/03_renderer/04_twigCustomFilters.md
+++ b/docs/tech/03_renderer/04_twigCustomFilters.md
@@ -1,6 +1,12 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Renderer](readme.md) **/**
+Template filters
-
+---
+
+
+# Template filters
When generating pages, you can use filters that allow you to modify the content.
Filters available during page generation are defined in the configuration ( `twig_filters` parameter )
@@ -8,7 +14,7 @@ Filters available during page generation are defined in int
+ [int](https://www.php.net/manual/en/language.types.integer.php)
Indent size |
@@ -78,7 +84,7 @@ Here is a list of filters available by default:
$skipFirstIdent
- bool
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
Skip indent for first line in text or not |
@@ -87,7 +93,7 @@ Here is a list of filters available by default:
- fixStrSize
+ fixStrSize
The filter pads the string with the specified characters on the right to the specified size |
@@ -98,7 +104,7 @@ Here is a list of filters available by default:
$size
- int
+ [int](https://www.php.net/manual/en/language.types.integer.php)
|
Required string size |
@@ -110,7 +116,7 @@ Here is a list of filters available by default:
$symbol
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
The character to be used to complete the string |
@@ -119,7 +125,7 @@ Here is a list of filters available by default:
- implode
+ implode
Join array elements with a string |
@@ -130,7 +136,7 @@ Here is a list of filters available by default:
$separator
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
Element separator in result string |
@@ -139,7 +145,7 @@ Here is a list of filters available by default:
- preg_match
+ preg_match
Perform a regular expression match |
@@ -150,7 +156,7 @@ Here is a list of filters available by default:
$pattern
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
The pattern to search for, as a string. |
@@ -159,7 +165,7 @@ Here is a list of filters available by default:
- prepareSourceLink
+ prepareSourceLink
The filter converts the string into an anchor that can be used in a GitHub document link |
The filter does not accept any additional parameters |
@@ -168,7 +174,7 @@ Here is a list of filters available by default:
- quotemeta
+ quotemeta
Quote meta characters |
The filter does not accept any additional parameters |
@@ -177,7 +183,7 @@ Here is a list of filters available by default:
- removeLineBrakes
+ removeLineBrakes
The filter replaces all line breaks with a space |
The filter does not accept any additional parameters |
@@ -185,8 +191,8 @@ Here is a list of filters available by default:
|
-
- strTypeToUrl
+ |
+ strTypeToUrl
The filter converts the string with the data type into a link to the documented entity, if possible. :warning: This filter initiates the creation of documents for the displayed entities |
@@ -194,76 +200,60 @@ Here is a list of filters available by default:
- $rootEntityCollection
+ $text
|
- RootEntityCollection
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
- |
+ Processed text |
|
- $useShortLinkVersion
+ $rootEntityCollection
|
- bool
+ [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
|
- Shorten or not the link name. When shortening, only the shortName of the entity will be shown |
+ |
|
- $createDocument
+ $useShortLinkVersion
|
- bool
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
+ Shorten or not the link name. When shortening, only the shortName of the entity will be shown |
-
- |
-
-
-
- textToCodeBlock
- Convert text to code block |
-
|
- $codeBlockType
+ $createDocument
|
- string
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
- Code block type (e.g. php or console ) |
+ If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
- |
-
-
-
- textToHeading
- Convert text to html header |
-
|
- $headingType
+ $separator
|
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
- Choose heading type: H1, H2, H3 |
+ Separator between types |
|
@@ -272,6 +262,6 @@ Here is a list of filters available by default:
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/05_twigCustomFunctions.md b/docs/tech/03_renderer/05_twigCustomFunctions.md
index b3449148..0c1982da 100644
--- a/docs/tech/03_renderer/05_twigCustomFunctions.md
+++ b/docs/tech/03_renderer/05_twigCustomFunctions.md
@@ -1,6 +1,12 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Renderer](readme.md) **/**
+Template functions
-
+---
+
+
+# Template functions
When generating pages, you can use functions that allow you to modify the content.
Functions available during page generation are defined in the configuration ( `twig_functions` parameter )
@@ -8,13 +14,13 @@ Functions available during page generation are defined in string | null
+ [string](https://www.php.net/manual/en/language.types.string.php) | [null](https://www.php.net/manual/en/language.types.null.php)
Relative path to the page from which the menu will be generated (only child pages will be taken into account). By default, the main documentation page (readme.md) is used. |
@@ -72,7 +90,7 @@ Here is a list of functions available by default:
$maxDeep
- int | null
+ [int](https://www.php.net/manual/en/language.types.integer.php) | [null](https://www.php.net/manual/en/language.types.null.php)
|
Maximum parsing depth of documented links starting from the current page. By default, this restriction is disabled. |
@@ -80,15 +98,27 @@ Here is a list of functions available by default:
|
-
- drawDocumentedEntityLink
+ |
+ drawDocumentedEntityLink
Creates an entity link by object
:warning: This function initiates the creation of documents for the displayed entities |
+ $context
+ |
+
+ [array](https://www.php.net/manual/en/language.types.array.php)
+ |
+ |
+
+
+ |
+
+
+
$entity
|
- RootEntityInterface
+ [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](classes/RootEntityInterface.md)
|
The entity for which we want to get the link |
@@ -100,7 +130,7 @@ Here is a list of functions available by default:
$cursor
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
Reference to an element inside an entity, for example, the name of a function/constant/property |
@@ -112,79 +142,67 @@ Here is a list of functions available by default:
$useShortName
- bool
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
Use the full or short entity name in the link |
|
-
-
- fileGetContents
- Displaying the content of a file or web resource
- |
-
- $resourceName
- |
-
- string
- |
- Resource name, url or path to the resource. The path can contain shortcodes with parameters from the configuration (%param_name%) |
-
-
- |
-
-
-
- generatePageBreadcrumbs
+ |
+
+ drawPageBreadcrumbs
Function to generate breadcrumbs on the page
|
- $currentPageTitle
+ $context
|
- string
+ [array](https://www.php.net/manual/en/language.types.array.php)
|
- Title of the current page |
+ |
|
- $templatePath
+ $customPageTitle
|
- string
+ [string](https://www.php.net/manual/en/language.types.string.php) | [null](https://www.php.net/manual/en/language.types.null.php)
|
- Path to the template from which the breadcrumbs will be generated |
-
-
- |
+ Custom title of the current page |
-
+
+ |
+
+
+
+ fileGetContents
+ Displaying the content of a file or web resource
+ |
- $skipFirstTemplatePage
+ $resourceName
|
- bool
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
- If set to true, the page from which parsing starts will not participate in the formation of breadcrumbs This option is useful when working with the _self value in a template, as it returns the full path to the current template, and the reference to it in breadcrumbs should not be clickable. |
+ Resource name, url or path to the resource. The path can contain shortcodes with parameters from the configuration (%param_name%) |
|
- getDocumentationPageUrl
+ getDocumentationPageUrl
Creates an entity link by object
|
$key
|
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
The key by which to look up the URL of the page. Can be the title of a page, a path to a template, or a generated document |
@@ -192,15 +210,27 @@ Here is a list of functions available by default:
|
-
- getDocumentedEntityUrl
+ |
+ getDocumentedEntityUrl
Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called, the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
:warning: This function initiates the creation of documents for the displayed entities |
+ $context
+ |
+
+ [array](https://www.php.net/manual/en/language.types.array.php)
+ |
+ |
+
+
+ |
+
+
+
$rootEntityCollection
|
- RootEntityCollection
+ [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](classes/RootEntityCollection.md)
|
Processed entity collection |
@@ -212,7 +242,7 @@ Here is a list of functions available by default:
$entityName
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
The full name of the entity for which the URL will be retrieved. If the entity is not found, the DEFAULT_URL value will be returned. |
@@ -224,7 +254,7 @@ Here is a list of functions available by default:
$cursor
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
Cursor on the page of the documented entity (for example, the name of a method or property) |
@@ -236,7 +266,7 @@ Here is a list of functions available by default:
$createDocument
- bool
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
If true, creates an entity document. Otherwise, just gives a reference to the entity code |
@@ -245,14 +275,14 @@ Here is a list of functions available by default:
- loadPluginsContent
+ loadPluginsContent
:warning: For internal use Process entity template blocks with plugins. The method returns the content processed by plugins.
|
$content
|
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
Content to be processed by plugins |
@@ -264,7 +294,7 @@ Here is a list of functions available by default:
$entity
- RootEntityInterface
+ [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](classes/RootEntityInterface.md)
|
The entity for which we process the content block |
@@ -276,7 +306,7 @@ Here is a list of functions available by default:
$blockType
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
Content block type. @see BaseTemplatePluginInterface::BLOCK_* |
@@ -284,15 +314,27 @@ Here is a list of functions available by default:
|
-
- printEntityCollectionAsList
- Outputting entity data as HTML list
+ |
+ printEntityCollectionAsList
+ Outputting entity data as MD list
:warning: This function initiates the creation of documents for the displayed entities |
+ $context
+ |
+
+ [array](https://www.php.net/manual/en/language.types.array.php)
+ |
+ |
+
+
+ |
+
+
+
$rootEntityCollection
|
- RootEntityCollection
+ [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](classes/RootEntityCollection.md)
|
Processed entity collection |
@@ -304,7 +346,7 @@ Here is a list of functions available by default:
$type
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
List tag type (<ul>/<ol>) |
@@ -316,7 +358,7 @@ Here is a list of functions available by default:
$skipDescription
- bool
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
Don't print description of this entities |
@@ -328,7 +370,7 @@ Here is a list of functions available by default:
$useFullName
- bool
+ [bool](https://www.php.net/manual/en/language.types.boolean.php)
|
Use the full name of the entity in the list |
@@ -336,15 +378,27 @@ Here is a list of functions available by default:
|
-
- displayClassApiMethods
+ |
+ displayClassApiMethods
Display all API methods of a class
|
+ $context
+ |
+
+ [array](https://www.php.net/manual/en/language.types.array.php)
+ |
+ |
+
+
+ |
+
+
+
$className
|
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
Name of the class for which API methods need to be displayed |
@@ -352,15 +406,27 @@ Here is a list of functions available by default:
|
-
- drawClassMap
+ |
+ drawClassMap
Generate class map in HTML format
:warning: This function initiates the creation of documents for the displayed entities |
+ $context
+ |
+
+ [array](https://www.php.net/manual/en/language.types.array.php)
+ |
+ |
+
+
+ |
+
+
+
$entitiesCollections
|
- PhpEntitiesCollection
+ [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](classes/PhpEntitiesCollection.md)
|
The collection of entities for which the class map will be generated |
@@ -369,14 +435,14 @@ Here is a list of functions available by default:
- getClassMethodsBodyCode
+ getClassMethodsBodyCode
Get the code of the specified class methods as a formatted string
|
$className
|
- string
+ [string](https://www.php.net/manual/en/language.types.string.php)
|
The name of the class whose methods are to be retrieved |
@@ -388,7 +454,7 @@ Here is a list of functions available by default:
$methodsNames
- array
+ [array](https://www.php.net/manual/en/language.types.array.php)
|
List of class methods whose code needs to be retrieved |
@@ -399,6 +465,6 @@ Here is a list of functions available by default:
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/03_renderer/classes/AddIndentFromLeft.md b/docs/tech/03_renderer/classes/AddIndentFromLeft.md
index 18504932..33caac8e 100644
--- a/docs/tech/03_renderer/classes/AddIndentFromLeft.md
+++ b/docs/tech/03_renderer/classes/AddIndentFromLeft.md
@@ -1,22 +1,20 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+AddIndentFromLeft
+---
+# [AddIndentFromLeft](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class AddIndentFromLeft implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-Filter adds indent from left
-
-
+Filter adds indent from left
Settings:
@@ -32,119 +30,45 @@ final class AddIndentFromLeft implements \BumbleDocGen\Core\Renderer\Twig\Filter
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L18)
```php
public function __invoke(string $text, int $identLength = 4, bool $skipFirstIdent = false): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$identLength | [int](https://www.php.net/manual/en/language.types.integer.php) | Indent size |
+$skipFirstIdent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Skip indent for first line in text or not |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $identLength |
- int |
- Indent size |
-
-
- $skipFirstIdent |
- bool |
- Skip indent for first line in text or not |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L24)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L29)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/BreadcrumbsHelper.md b/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
index 534edc34..fcddf871 100644
--- a/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
+++ b/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
@@ -1,625 +1,202 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Documentation structure and breadcrumbs](../02_breadcrumbs.md) **/**
+BreadcrumbsHelper
+---
+# [BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L23) class:
```php
namespace BumbleDocGen\Core\Renderer\Breadcrumbs;
final class BreadcrumbsHelper
```
+Helper entity for working with breadcrumbs
-Helper entity for working with breadcrumbs
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAllPageLinks
-
--
- getBreadcrumbs
- - Get breadcrumbs as an array
--
- getBreadcrumbsForTemplates
-
--
- getNearestIndexFile
-
--
- getPageDataByKey
-
--
- getPageDocFileByKey
-
--
- getPageLinkByKey
-
--
- getTemplateFrontMatter
-
--
- getTemplateLinkKey
-
--
- getTemplateTitle
- - Get the name of a template by its URL.
--
- renderBreadcrumbs
- - Returns an HTML string with rendered breadcrumbs
-
-
+## Initialization methods
-Constants:
-
+1. [__construct](#m-construct)
+## Methods
+1. [getAllPageLinks](#mgetallpagelinks)
+1. [getBreadcrumbs](#mgetbreadcrumbs) - Get breadcrumbs as an array
+1. [getBreadcrumbsForTemplates](#mgetbreadcrumbsfortemplates)
+1. [getNearestIndexFile](#mgetnearestindexfile)
+1. [getPageDataByKey](#mgetpagedatabykey)
+1. [getPageDocFileByKey](#mgetpagedocfilebykey)
+1. [getPageLinkByKey](#mgetpagelinkbykey)
+1. [getTemplateFrontMatter](#mgettemplatefrontmatter)
+1. [getTemplateLinkKey](#mgettemplatelinkkey)
+1. [getTemplateTitle](#mgettemplatetitle) - Get the name of a template by its URL.
+## Methods details:
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L35)
```php
-public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment $breadcrumbsTwig, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, string $prevPageNameTemplate = self::DEFAULT_PREV_PAGE_NAME_TEMPLATE);
+public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, string $prevPageNameTemplate = self::DEFAULT_PREV_PAGE_NAME_TEMPLATE);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$prevPageNameTemplate | [string](https://www.php.net/manual/en/language.types.string.php) | Index page for each child section |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAllPageLinks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L236)
```php
public function getAllPageLinks(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getBreadcrumbs` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L187)
```php
public function getBreadcrumbs(string $filePatch, bool $fromCurrent = true): array;
```
+Get breadcrumbs as an array
-
Get breadcrumbs as an array
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $filePatch |
- string |
- - |
-
-
- $fromCurrent |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public function getBreadcrumbsForTemplates(string $filePatch, bool $fromCurrent = true): array;
-```
-
-
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$filePatch | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$fromCurrent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $filePatch |
- string |
- - |
-
-
- $fromCurrent |
- bool |
- - |
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Return value: array
+---
+
# `getBreadcrumbsForTemplates` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L209)
+```php
+public function getBreadcrumbsForTemplates(string $filePatch, bool $fromCurrent = true): array;
+```
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$filePatch | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$fromCurrent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getNearestIndexFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L82)
```php
public function getNearestIndexFile(string $templateName): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$templateName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $templateName |
- string |
- - |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getPageDataByKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L303)
```php
public function getPageDataByKey(string $key): null|array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: null |
array
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [array](https://www.php.net/manual/en/language.types.array.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getPageDocFileByKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L329)
```php
public function getPageDocFileByKey(string $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getPageLinkByKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L318)
```php
public function getPageLinkByKey(string $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getTemplateFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L152)
```php
public function getTemplateFrontMatter(string $templateName): array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$templateName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $templateName |
- string |
- - |
-
-
-
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplateLinkKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L143)
```php
public function getTemplateLinkKey(string $templateName): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$templateName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $templateName |
- string |
- - |
-
-
-
-
-
Return value: null |
string
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplateTitle` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php#L134)
```php
public function getTemplateTitle(string $templateName): string;
```
+Get the name of a template by its URL.
-
Get the name of a template by its URL.
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $templateName |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$templateName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
Examples of using:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+***Examples of using:***
```php
# Front matter in template:
# ---
@@ -629,75 +206,4 @@ public function getTemplateTitle(string $templateName): string;
$breadcrumbsHelper->getTemplateTitle() == 'Some template title'; // is true
```
-
-
-
-
-
-
-```php
-public function renderBreadcrumbs(string $currentPageTitle, string $filePatch, bool $fromCurrent = true): string;
-```
-
-
Returns an HTML string with rendered breadcrumbs
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentPageTitle |
- string |
- - |
-
-
- $filePatch |
- string |
- - |
-
-
- $fromCurrent |
- bool |
- - |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/Configuration.md b/docs/tech/03_renderer/classes/Configuration.md
index 111dc8b0..157c9c92 100644
--- a/docs/tech/03_renderer/classes/Configuration.md
+++ b/docs/tech/03_renderer/classes/Configuration.md
@@ -1,763 +1,245 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+Configuration
+---
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
```php
namespace BumbleDocGen\Core\Configuration;
final class Configuration
```
-
-Configuration project documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAdditionalConsoleCommands
-
--
- getCacheDir
-
--
- getConfigurationVersion
-
--
- getDocGenLibDir
-
--
- getGitClientPath
-
--
- getIfExists
-
--
- getLanguageHandlersCollection
-
--
- getOutputDir
-
--
- getOutputDirBaseUrl
-
--
- getPageLinkProcessor
-
--
- getPlugins
-
--
- getProjectRoot
-
--
- getSourceLocators
-
--
- getTemplatesDir
-
--
- getTwigFilters
-
--
- getTwigFunctions
-
--
- getWorkingDir
-
--
- isCheckFileInGitBeforeCreatingDocEnabled
-
--
- renderWithFrontMatter
-
--
- useSharedCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
```php
public function getCacheDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
```php
public function getConfigurationVersion(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
```php
public function getDocGenLibDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
```php
public function getGitClientPath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
```php
public function getIfExists(mixed $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- mixed |
- - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
```php
public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
```php
public function getOutputDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
```php
public function getOutputDirBaseUrl(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
```php
public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
```php
public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
```php
public function getProjectRoot(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
```php
public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
```php
public function getTemplatesDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
```php
public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
```php
public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
```php
public function getWorkingDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isCheckFileInGitBeforeCreatingDocEnabled
- | source code
-
-
+
# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
```php
public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
```php
public function renderWithFrontMatter(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
```php
public function useSharedCache(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/CustomFunctionInterface.md b/docs/tech/03_renderer/classes/CustomFunctionInterface.md
index 105d7b9d..6dbe2833 100644
--- a/docs/tech/03_renderer/classes/CustomFunctionInterface.md
+++ b/docs/tech/03_renderer/classes/CustomFunctionInterface.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+CustomFunctionInterface
+---
+# [CustomFunctionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionInterface.php#L5) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
@@ -14,72 +15,27 @@ namespace BumbleDocGen\Core\Renderer\Twig\Function;
interface CustomFunctionInterface
```
+## Methods
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-
-
-
-
-Methods:
-
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionInterface.php#L7)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionInterface.php#L9)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DisplayClassApiMethods.md b/docs/tech/03_renderer/classes/DisplayClassApiMethods.md
index 8a7238d7..a7a86955 100644
--- a/docs/tech/03_renderer/classes/DisplayClassApiMethods.md
+++ b/docs/tech/03_renderer/classes/DisplayClassApiMethods.md
@@ -1,32 +1,27 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+DisplayClassApiMethods
+---
+# [DisplayClassApiMethods](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php#L20) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Renderer\Twig\Function;
final class DisplayClassApiMethods implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Display all API methods of a class
-Display all API methods of a class
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ displayClassApiMethods('\\BumbleDocGen\\LanguageHandler\\Php\\Parser\\Entity\\ClassEntity') }}
-
```
-
-
Settings:
@@ -36,171 +31,61 @@ final class DisplayClassApiMethods implements \BumbleDocGen\Core\Renderer\Twig\F
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php#L22)
```php
public function __construct(\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php#L47)
```php
-public function __invoke(string $className): null|string;
+public function __invoke(array $context, string $className): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | Name of the class for which API methods need to be displayed |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- Name of the class for which API methods need to be displayed |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php#L28)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php#L33)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DocumentedEntityWrapper.md b/docs/tech/03_renderer/classes/DocumentedEntityWrapper.md
index 4a94b8bd..d9c60bfd 100644
--- a/docs/tech/03_renderer/classes/DocumentedEntityWrapper.md
+++ b/docs/tech/03_renderer/classes/DocumentedEntityWrapper.md
@@ -1,300 +1,129 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+DocumentedEntityWrapper
+---
+# [DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L14) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
final class DocumentedEntityWrapper
```
+Wrapper for the entity that was requested for documentation
-Wrapper for the entity that was requested for documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getDocRender
-
--
- getDocUrl
- - Get the relative path to the document to be generated
--
- getDocumentTransformableEntity
- - Get entity that is allowed to be documented
--
- getEntityName
-
--
- getFileName
- - The name of the file to be generated
--
- getKey
- - Get document key
--
- getParentDocFilePath
-
--
- setParentDocFilePath
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getDocRender](#mgetdocrender)
+1. [getDocUrl](#mgetdocurl) - Get the relative path to the document to be generated
+1. [getDocumentTransformableEntity](#mgetdocumenttransformableentity) - Get entity that is allowed to be documented
+1. [getEntityName](#mgetentityname)
+1. [getFileName](#mgetfilename) - The name of the file to be generated
+1. [getKey](#mgetkey) - Get document key
+1. [getParentDocFilePath](#mgetparentdocfilepath)
+1. [setParentDocFilePath](#msetparentdocfilepath)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface $documentTransformableEntity, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, string $parentDocFilePath);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$documentTransformableEntity | [\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentTransformableEntityInterface.php) | An entity that is allowed to be documented |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$parentDocFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | The file in which the documentation of the entity was requested |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getDocRender` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L27)
```php
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
-
-
-
-
-
+
# `getDocUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L88)
```php
public function getDocUrl(): string;
```
+Get the relative path to the document to be generated
-
Get the relative path to the document to be generated
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocumentTransformableEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L80)
```php
public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface;
```
+Get entity that is allowed to be documented
-
Get entity that is allowed to be documented
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentTransformableEntityInterface.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface
-
-
-
-
-
-
-
+---
+
# `getEntityName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L40)
```php
public function getEntityName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L72)
```php
public function getFileName(): string;
```
+The name of the file to be generated
-
The name of the file to be generated
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L35)
```php
public function getKey(): string;
```
+Get document key
-
Get document key
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentDocFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L96)
```php
public function getParentDocFilePath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `setParentDocFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L101)
```php
public function setParentDocFilePath(string $parentDocFilePath): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parentDocFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentDocFilePath |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DocumentedEntityWrappersCollection.md b/docs/tech/03_renderer/classes/DocumentedEntityWrappersCollection.md
index 5fea8107..adc3bddd 100644
--- a/docs/tech/03_renderer/classes/DocumentedEntityWrappersCollection.md
+++ b/docs/tech/03_renderer/classes/DocumentedEntityWrappersCollection.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+DocumentedEntityWrappersCollection
+---
+# [DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L14) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
@@ -14,203 +14,72 @@ namespace BumbleDocGen\Core\Renderer\Context;
final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \Countable
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [count](#mcount)
+1. [createAndAddDocumentedEntityWrapper](#mcreateandadddocumentedentitywrapper)
+1. [getDocumentedEntitiesRelations](#mgetdocumentedentitiesrelations)
+1. [getIterator](#mgetiterator)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- count
-
--
- createAndAddDocumentedEntityWrapper
-
--
- getDocumentedEntitiesRelations
-
--
- getIterator
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L21)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `count` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L76)
```php
public function count(): int;
```
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
-
-
-
-
+
# `createAndAddDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L42)
```php
public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
-
+---
+
# `getDocumentedEntitiesRelations` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L71)
```php
public function getDocumentedEntitiesRelations(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L29)
```php
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
-
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DrawClassMap.md b/docs/tech/03_renderer/classes/DrawClassMap.md
index 52bd63fe..96a98d15 100644
--- a/docs/tech/03_renderer/classes/DrawClassMap.md
+++ b/docs/tech/03_renderer/classes/DrawClassMap.md
@@ -1,37 +1,30 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+DrawClassMap
+---
+# [DrawClassMap](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L24) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Renderer\Twig\Function;
final class DrawClassMap implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Generate class map in HTML format
-Generate class map in HTML format
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ drawClassMap(phpEntities.filterByPaths(['/src/Renderer'])) }}
-
```
-
```php
{{ drawClassMap(phpEntities) }}
-
```
-
-
Settings:
@@ -41,276 +34,96 @@ final class DrawClassMap implements \BumbleDocGen\Core\Renderer\Twig\Function\Cu
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [convertDirectoryStructureToFormattedString](#mconvertdirectorystructuretoformattedstring)
+1. [getDirectoryStructure](#mgetdirectorystructure)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- convertDirectoryStructureToFormattedString
-
--
- getDirectoryStructure
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L29)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L59)
```php
-public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection ...$entitiesCollections): string;
+public function __invoke(array $context, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection ...$entitiesCollections): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$entitiesCollections
(variadic) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | The collection of entities for which the class map will be generated |
-
Parameters:
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- convertDirectoryStructureToFormattedString
- | source code
-
+---
+
# `convertDirectoryStructureToFormattedString` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L136)
```php
public function convertDirectoryStructureToFormattedString(array $structure, string $prefix = '│', string $path = '/'): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$structure | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$prefix | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$path | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $structure |
- array |
- - |
-
-
- $prefix |
- string |
- - |
-
-
- $path |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getDirectoryStructure` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L101)
```php
-public function getDirectoryStructure(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection ...$entitiesCollections): array;
+public function getDirectoryStructure(array $context, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection ...$entitiesCollections): array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$entitiesCollections
(variadic) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
-
Parameters:
-
-
-
-
Return value: array
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L35)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php#L40)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DrawDocumentationMenu.md b/docs/tech/03_renderer/classes/DrawDocumentationMenu.md
index 48dd97cd..f7deea77 100644
--- a/docs/tech/03_renderer/classes/DrawDocumentationMenu.md
+++ b/docs/tech/03_renderer/classes/DrawDocumentationMenu.md
@@ -1,54 +1,40 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+DrawDocumentationMenu
+---
+# [DrawDocumentationMenu](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L32) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class DrawDocumentationMenu implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Generate documentation menu in MD format. To generate the menu, the start page is taken,
+and all links with this page are recursively collected for it, after which the html menu is created.
-Generate documentation menu in HTML format. To generate the menu, the start page is taken,
-and all links with this page are recursively collected for it, after which the html menu is created.
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](GetDocumentedEntityUrl_2.md)
+***Examples of using:***
```php
{{ drawDocumentationMenu() }} - The menu contains links to all documents
-
```
-
```php
{{ drawDocumentationMenu('/render/index.md') }} - The menu contains links to all child documents from the /render/index.md file (for example /render/test/index.md)
-
```
-
```php
{{ drawDocumentationMenu(_self) }} - The menu contains links to all child documents from the file where this function was called
-
```
-
```php
{{ drawDocumentationMenu(_self, 2) }} - The menu contains links to all child documents from the file where this function was called, but no more than 2 in depth
-
```
-
-
Settings:
@@ -58,188 +44,66 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$dependencyFactory | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyFactory.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L69)
```php
-public function __invoke(string|null $startPageKey = null, int|null $maxDeep = null): string;
+public function __invoke(array $context, string|null $startPageKey = null, int|null $maxDeep = null): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$startPageKey | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Relative path to the page from which the menu will be generated (only child pages will be taken into account).
+ By default, the main documentation page (readme.md) is used. |
+$maxDeep | [int](https://www.php.net/manual/en/language.types.integer.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Maximum parsing depth of documented links starting from the current page.
+ By default, this restriction is disabled. |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $startPageKey |
- string | null |
- Relative path to the page from which the menu will be generated (only child pages will be taken into account).
- By default, the main documentation page (readme.md) is used. |
-
-
- $maxDeep |
- int | null |
- Maximum parsing depth of documented links starting from the current page.
- By default, this restriction is disabled. |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L42)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L47)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DrawDocumentedEntityLink.md b/docs/tech/03_renderer/classes/DrawDocumentedEntityLink.md
index 2a73a6a7..fad16562 100644
--- a/docs/tech/03_renderer/classes/DrawDocumentedEntityLink.md
+++ b/docs/tech/03_renderer/classes/DrawDocumentedEntityLink.md
@@ -1,42 +1,33 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+DrawDocumentedEntityLink
+---
+# [DrawDocumentedEntityLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L21) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class DrawDocumentedEntityLink implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Creates an entity link by object
-Creates an entity link by object
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ drawDocumentedEntityLink($entity, 'getFunctions()') }}
-
```
-
```php
{{ drawDocumentedEntityLink($entity) }}
-
```
-
```php
{{ drawDocumentedEntityLink($entity, '', false) }}
-
```
-
-
Settings:
@@ -46,176 +37,62 @@ final class DrawDocumentedEntityLink implements \BumbleDocGen\Core\Renderer\Twig
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L23)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L51)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $cursor = '', bool $useShortName = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $cursor = '', bool $useShortName = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | The entity for which we want to get the link |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Reference to an element inside an entity, for example, the name of a function/constant/property |
+$useShortName | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Use the full or short entity name in the link |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entity |
- \BumbleDocGen\Core\Parser\Entity\RootEntityInterface |
- The entity for which we want to get the link |
-
-
- $cursor |
- string |
- Reference to an element inside an entity, for example, the name of a function/constant/property |
-
-
- $useShortName |
- bool |
- Use the full or short entity name in the link |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L27)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L32)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/DrawPageBreadcrumbs.md b/docs/tech/03_renderer/classes/DrawPageBreadcrumbs.md
new file mode 100644
index 00000000..560130af
--- /dev/null
+++ b/docs/tech/03_renderer/classes/DrawPageBreadcrumbs.md
@@ -0,0 +1,89 @@
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+DrawPageBreadcrumbs
+
+---
+
+
+# [DrawPageBreadcrumbs](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L25) class:
+
+```php
+namespace BumbleDocGen\Core\Renderer\Twig\Function;
+
+final class DrawPageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
+```
+Function to generate breadcrumbs on the page
+
+
+Settings:
+
+
+
+ Function name: |
+ drawPageBreadcrumbs |
+
+
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+
+## Methods details:
+
+# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L27)
+```php
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment $breadcrumbsTwig, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$breadcrumbsTwig | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsTwigEnvironment.php) | - |
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$dependencyFactory | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyFactory.php) | - |
+
+---
+
+# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L61)
+```php
+public function __invoke(array $context, string|null $customPageTitle = null): string;
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$customPageTitle | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Custom title of the current page |
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L36)
+```php
+public static function getName(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L41)
+```php
+public static function getOptions(): array;
+```
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+
+---
diff --git a/docs/tech/03_renderer/classes/DrawPageBreadcrumbs_2.md b/docs/tech/03_renderer/classes/DrawPageBreadcrumbs_2.md
new file mode 100644
index 00000000..7a09cdd1
--- /dev/null
+++ b/docs/tech/03_renderer/classes/DrawPageBreadcrumbs_2.md
@@ -0,0 +1,89 @@
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Documentation structure and breadcrumbs](../02_breadcrumbs.md) **/**
+DrawPageBreadcrumbs
+
+---
+
+
+# [DrawPageBreadcrumbs](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L25) class:
+
+```php
+namespace BumbleDocGen\Core\Renderer\Twig\Function;
+
+final class DrawPageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
+```
+Function to generate breadcrumbs on the page
+
+
+Settings:
+
+
+
+ Function name: |
+ drawPageBreadcrumbs |
+
+
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+
+## Methods details:
+
+# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L27)
+```php
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment $breadcrumbsTwig, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$breadcrumbsTwig | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsTwigEnvironment.php) | - |
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$dependencyFactory | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyFactory.php) | - |
+
+---
+
+# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L61)
+```php
+public function __invoke(array $context, string|null $customPageTitle = null): string;
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$customPageTitle | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Custom title of the current page |
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L36)
+```php
+public static function getName(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L41)
+```php
+public static function getOptions(): array;
+```
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+
+---
diff --git a/docs/tech/03_renderer/classes/FileGetContents.md b/docs/tech/03_renderer/classes/FileGetContents.md
index 1758b51e..e66b1957 100644
--- a/docs/tech/03_renderer/classes/FileGetContents.md
+++ b/docs/tech/03_renderer/classes/FileGetContents.md
@@ -1,43 +1,33 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+FileGetContents
+---
+# [FileGetContents](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L17) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class FileGetContents implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Displaying the content of a file or web resource
-Displaying the content of a file or web resource
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [https://www.php.net/manual/en/function.file-get-contents.php](https://www.php.net/manual/en/function.file-get-contents.php)
+***Examples of using:***
```php
{{ fileGetContents('https://www.php.net/manual/en/function.file-get-contents.php') }}
-
```
-
```php
{{ fileGetContents('%templates_dir%/../config.yaml') }}
-
```
-
-
Settings:
@@ -47,154 +37,60 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L19)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L41)
```php
public function __invoke(string $resourceName): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$resourceName | [string](https://www.php.net/manual/en/language.types.string.php) | Resource name, url or path to the resource.
+ The path can contain shortcodes with parameters from the configuration (%param_name%) |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $resourceName |
- string |
- Resource name, url or path to the resource.
- The path can contain shortcodes with parameters from the configuration (%param_name%) |
-
-
-
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L23)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L28)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/FixStrSize.md b/docs/tech/03_renderer/classes/FixStrSize.md
index 029a7bd7..a4eae2b2 100644
--- a/docs/tech/03_renderer/classes/FixStrSize.md
+++ b/docs/tech/03_renderer/classes/FixStrSize.md
@@ -1,22 +1,20 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+FixStrSize
+---
+# [FixStrSize](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class FixStrSize implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-The filter pads the string with the specified characters on the right to the specified size
-
-
+The filter pads the string with the specified characters on the right to the specified size
Settings:
@@ -32,119 +30,45 @@ final class FixStrSize implements \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L20)
```php
public function __invoke(string $text, int $size, string $symbol = ' '): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$size | [int](https://www.php.net/manual/en/language.types.integer.php) | Required string size |
+$symbol | [string](https://www.php.net/manual/en/language.types.string.php) | The character to be used to complete the string |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $size |
- int |
- Required string size |
-
-
- $symbol |
- string |
- The character to be used to complete the string |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L31)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L36)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/GeneratePageBreadcrumbs.md b/docs/tech/03_renderer/classes/GeneratePageBreadcrumbs.md
deleted file mode 100644
index 0109274b..00000000
--- a/docs/tech/03_renderer/classes/GeneratePageBreadcrumbs.md
+++ /dev/null
@@ -1,224 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Function;
-
-final class GeneratePageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
-```
-
-Function to generate breadcrumbs on the page
-
-
-
-
-Settings:
-
-
-
- Function name: |
- generatePageBreadcrumbs |
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
-```
-
-
-
-
Parameters:
-
-
-
-
-
-
-
-
-
-
-
-```php
-public function __invoke(string $currentPageTitle, string $templatePath, bool $skipFirstTemplatePage = true): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentPageTitle |
- string |
- Title of the current page |
-
-
- $templatePath |
- string |
- Path to the template from which the breadcrumbs will be generated |
-
-
- $skipFirstTemplatePage |
- bool |
- If set to true, the page from which parsing starts will not participate in the formation of breadcrumbs
- This option is useful when working with the _self value in a template, as it returns the full path to the
- current template, and the reference to it in breadcrumbs should not be clickable. |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/03_renderer/classes/GeneratePageBreadcrumbs_2.md b/docs/tech/03_renderer/classes/GeneratePageBreadcrumbs_2.md
deleted file mode 100644
index 39ccc052..00000000
--- a/docs/tech/03_renderer/classes/GeneratePageBreadcrumbs_2.md
+++ /dev/null
@@ -1,224 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Function;
-
-final class GeneratePageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
-```
-
-Function to generate breadcrumbs on the page
-
-
-
-
-Settings:
-
-
-
- Function name: |
- generatePageBreadcrumbs |
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
-```
-
-
-
-
Parameters:
-
-
-
-
-
-
-
-
-
-
-
-```php
-public function __invoke(string $currentPageTitle, string $templatePath, bool $skipFirstTemplatePage = true): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentPageTitle |
- string |
- Title of the current page |
-
-
- $templatePath |
- string |
- Path to the template from which the breadcrumbs will be generated |
-
-
- $skipFirstTemplatePage |
- bool |
- If set to true, the page from which parsing starts will not participate in the formation of breadcrumbs
- This option is useful when working with the _self value in a template, as it returns the full path to the
- current template, and the reference to it in breadcrumbs should not be clickable. |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/03_renderer/classes/GetClassMethodsBodyCode.md b/docs/tech/03_renderer/classes/GetClassMethodsBodyCode.md
index 0ae3a972..a46906a5 100644
--- a/docs/tech/03_renderer/classes/GetClassMethodsBodyCode.md
+++ b/docs/tech/03_renderer/classes/GetClassMethodsBodyCode.md
@@ -1,32 +1,27 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+GetClassMethodsBodyCode
+---
+# [GetClassMethodsBodyCode](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/GetClassMethodsBodyCode.php#L20) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Renderer\Twig\Function;
final class GetClassMethodsBodyCode implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the code of the specified class methods as a formatted string
-Get the code of the specified class methods as a formatted string
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ getClassMethodsBodyCode('\\BumbleDocGen\\Renderer\\Twig\\MainExtension', ['getFunctions']) }}
-
```
-
-
Settings:
@@ -36,171 +31,60 @@ final class GetClassMethodsBodyCode implements \BumbleDocGen\Core\Renderer\Twig\
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/GetClassMethodsBodyCode.php#L22)
```php
public function __construct(\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/GetClassMethodsBodyCode.php#L49)
```php
public function __invoke(string $className, array $methodsNames): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$className | [string](https://www.php.net/manual/en/language.types.string.php) | The name of the class whose methods are to be retrieved |
+$methodsNames | [array](https://www.php.net/manual/en/language.types.array.php) | List of class methods whose code needs to be retrieved |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $className |
- string |
- The name of the class whose methods are to be retrieved |
-
-
- $methodsNames |
- array |
- List of class methods whose code needs to be retrieved |
-
-
-
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/GetClassMethodsBodyCode.php#L26)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/Twig/Function/GetClassMethodsBodyCode.php#L31)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/GetDocumentationPageUrl.md b/docs/tech/03_renderer/classes/GetDocumentationPageUrl.md
index af605e97..e25e39b9 100644
--- a/docs/tech/03_renderer/classes/GetDocumentationPageUrl.md
+++ b/docs/tech/03_renderer/classes/GetDocumentationPageUrl.md
@@ -1,47 +1,36 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+GetDocumentationPageUrl
+---
+# [GetDocumentationPageUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L21) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentationPageUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Creates an entity link by object
-Creates an entity link by object
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ getDocumentationPageUrl('Page name') }}
-
```
-
```php
{{ getDocumentationPageUrl('/someDir/someTemplate.md.twig') }}
-
```
-
```php
{{ getDocumentationPageUrl('/docs/someDir/someDocFile.md') }}
-
```
-
```php
{{ getDocumentationPageUrl('readme.md') }}
-
```
-
-
Settings:
@@ -51,179 +40,61 @@ final class GetDocumentationPageUrl implements \BumbleDocGen\Core\Renderer\Twig\
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L25)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L53)
```php
public function __invoke(string $key): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | The key by which to look up the URL of the page.
+ Can be the title of a page, a path to a template, or a generated document |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- The key by which to look up the URL of the page.
- Can be the title of a page, a path to a template, or a generated document |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L31)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L36)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/GetDocumentedEntityUrl.md b/docs/tech/03_renderer/classes/GetDocumentedEntityUrl.md
index 5fd48c82..65b932e6 100644
--- a/docs/tech/03_renderer/classes/GetDocumentedEntityUrl.md
+++ b/docs/tech/03_renderer/classes/GetDocumentedEntityUrl.md
@@ -1,56 +1,42 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+GetDocumentedEntityUrl
+---
+# [GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L40) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentedEntityUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
+the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
-the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](DocumentedEntityWrapper.md)
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](DocumentedEntityWrappersCollection.md)
+- [\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection](RendererContext.md#pentitywrapperscollection)
+***Examples of using:***
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', 'getFunctions') }}
The function returns a reference to the documented entity, anchored to the getFunctions method
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension') }}
The function returns a reference to the documented entity MainExtension
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', '', false) }}
The function returns a link to the file MainExtension
-
```
-
-
Settings:
@@ -60,204 +46,87 @@ The function returns a link to the file MainExtension
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+1. [process](#mprocess)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L44)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$documentedEntityWrappersCollection | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L81)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | The full name of the entity for which the URL will be retrieved.
+ If the entity is not found, the DEFAULT_URL value will be returned. |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Cursor on the page of the documented entity (for example, the name of a method or property) |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $entityName |
- string |
- The full name of the entity for which the URL will be retrieved.
- If the entity is not found, the DEFAULT_URL value will be returned. |
-
-
- $cursor |
- string |
- Cursor on the page of the documented entity (for example, the name of a method or property) |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L52)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L57)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `process` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L102)
+```php
+public function process(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true, string|null $callingTemplate = null): string;
+```
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+$callingTemplate | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/classes/GetDocumentedEntityUrl_2.md b/docs/tech/03_renderer/classes/GetDocumentedEntityUrl_2.md
index 1030ccf4..9b2b0d2d 100644
--- a/docs/tech/03_renderer/classes/GetDocumentedEntityUrl_2.md
+++ b/docs/tech/03_renderer/classes/GetDocumentedEntityUrl_2.md
@@ -1,56 +1,41 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+GetDocumentedEntityUrl
+---
+# [GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L40) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentedEntityUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
+the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
-the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](DocumentedEntityWrapper.md)
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](DocumentedEntityWrappersCollection.md)
+- [\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection](RendererContext.md#pentitywrapperscollection)
+***Examples of using:***
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', 'getFunctions') }}
The function returns a reference to the documented entity, anchored to the getFunctions method
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension') }}
The function returns a reference to the documented entity MainExtension
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', '', false) }}
The function returns a link to the file MainExtension
-
```
-
-
Settings:
@@ -60,204 +45,87 @@ The function returns a link to the file MainExtension
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+1. [process](#mprocess)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L44)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$documentedEntityWrappersCollection | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L81)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | The full name of the entity for which the URL will be retrieved.
+ If the entity is not found, the DEFAULT_URL value will be returned. |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Cursor on the page of the documented entity (for example, the name of a method or property) |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $entityName |
- string |
- The full name of the entity for which the URL will be retrieved.
- If the entity is not found, the DEFAULT_URL value will be returned. |
-
-
- $cursor |
- string |
- Cursor on the page of the documented entity (for example, the name of a method or property) |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L52)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L57)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `process` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L102)
+```php
+public function process(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true, string|null $callingTemplate = null): string;
+```
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+$callingTemplate | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/classes/Implode.md b/docs/tech/03_renderer/classes/Implode.md
index 66445405..b31f329b 100644
--- a/docs/tech/03_renderer/classes/Implode.md
+++ b/docs/tech/03_renderer/classes/Implode.md
@@ -1,28 +1,23 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+Implode
+---
+# [Implode](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class Implode implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+Join array elements with a string
-Join array elements with a string
-
-See:
-
-
-
+***Links:***
+- [https://www.php.net/manual/en/function.implode.php](https://www.php.net/manual/en/function.implode.php)
Settings:
@@ -38,114 +33,44 @@ See:
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L17)
```php
public function __invoke(array $elements, string $separator = ', '): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$elements | [array](https://www.php.net/manual/en/language.types.array.php) | The array to implode |
+$separator | [string](https://www.php.net/manual/en/language.types.string.php) | Element separator in result string |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $elements |
- array |
- The array to implode |
-
-
- $separator |
- string |
- Element separator in result string |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L22)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L27)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/InvalidConfigurationParameterException.md b/docs/tech/03_renderer/classes/InvalidConfigurationParameterException.md
deleted file mode 100644
index 79d6a3b3..00000000
--- a/docs/tech/03_renderer/classes/InvalidConfigurationParameterException.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception
-```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/03_renderer/classes/LoadPluginsContent.md b/docs/tech/03_renderer/classes/LoadPluginsContent.md
index c2dff34a..040cc7c5 100644
--- a/docs/tech/03_renderer/classes/LoadPluginsContent.md
+++ b/docs/tech/03_renderer/classes/LoadPluginsContent.md
@@ -1,32 +1,27 @@
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+LoadPluginsContent
-
+---
-
-
-:warning: Is internal
+# [LoadPluginsContent](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L18) class:
+⚠️ Internal
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class LoadPluginsContent implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Process entity template blocks with plugins. The method returns the content processed by plugins.
-Process entity template blocks with plugins. The method returns the content processed by plugins.
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ loadPluginsContent('some text', entity, constant('BumbleDocGen\\Plugin\\BaseTemplatePluginInterface::BLOCK_AFTER_HEADER')) }}
-
```
-
-
Settings:
@@ -36,163 +31,61 @@ final class LoadPluginsContent implements \BumbleDocGen\Core\Renderer\Twig\Funct
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L42)
```php
public function __invoke(string $content, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $blockType): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | Content to be processed by plugins |
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | The entity for which we process the content block |
+$blockType | [string](https://www.php.net/manual/en/language.types.string.php) | Content block type. @see BaseTemplatePluginInterface::BLOCK_* |
-
Parameters:
-
-
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L24)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L29)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/PhpEntitiesCollection.md b/docs/tech/03_renderer/classes/PhpEntitiesCollection.md
index da8bcd02..af1c5e80 100644
--- a/docs/tech/03_renderer/classes/PhpEntitiesCollection.md
+++ b/docs/tech/03_renderer/classes/PhpEntitiesCollection.md
@@ -1,883 +1,352 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+PhpEntitiesCollection
+---
+# [PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L43) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
final class PhpEntitiesCollection extends \BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection implements \IteratorAggregate
```
-
-Collection of php root entities
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- add
- - Add an entity to the collection
--
- clearOperationsLogCollection
-
--
- filterByInterfaces
- - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
--
- filterByNameRegularExpression
- - Get a copy of the current collection with only entities whose names match the regular expression
--
- filterByParentClassNames
- - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
--
- filterByPaths
- - Get a copy of the current collection only with entities filtered by file paths (from project_root)
--
- findEntity
- - Find an entity in a collection
--
- get
- - Get an entity from a collection (only previously added)
--
- getEntityCollectionName
- - Get collection name
--
- getEntityLinkData
-
--
- getIterator
-
--
- getLoadedOrCreateNew
- - Get an entity from the collection or create a new one if it has not yet been added
--
- getOnlyAbstractClasses
- - Get a copy of the current collection with only abstract classes
--
- getOnlyInstantiable
- - Get a copy of the current collection with only instantiable entities
--
- getOnlyInterfaces
- - Get a copy of the current collection with only interfaces
--
- getOnlyTraits
- - Get a copy of the current collection with only traits
--
- getOperationsLogCollection
-
--
- has
- - Check if an entity has been added to the collection
--
- internalFindEntity
-
--
- internalGetLoadedOrCreateNew
-
--
- isEmpty
- - Check if the collection is empty or not
--
- loadEntities
- - Load entities into a collection
--
- loadEntitiesByConfiguration
- - Load entities into a collection by configuration
--
- remove
- - Remove an entity from a collection
--
- removeAllNotLoadedEntities
-
--
- toArray
- - Convert collection to array
--
- updateEntitiesCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Collection of php root entities
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [add](#madd) - Add an entity to the collection
+1. [clearOperationsLogCollection](#mclearoperationslogcollection)
+1. [filterByInterfaces](#mfilterbyinterfaces) - Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
+1. [filterByNameRegularExpression](#mfilterbynameregularexpression) - Get a copy of the current collection with only entities whose names match the regular expression
+1. [filterByParentClassNames](#mfilterbyparentclassnames) - Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
+1. [filterByPaths](#mfilterbypaths) - Get a copy of the current collection only with entities filtered by file paths (from project_root)
+1. [findEntity](#mfindentity) - Find an entity in a collection
+1. [get](#mget) - Get an entity from a collection (only previously added)
+1. [getEntityCollectionName](#mgetentitycollectionname) - Get collection name
+1. [getEntityLinkData](#mgetentitylinkdata)
+1. [getIterator](#mgetiterator)
+1. [getLoadedOrCreateNew](#mgetloadedorcreatenew) - Get an entity from the collection or create a new one if it has not yet been added
+1. [getOnlyAbstractClasses](#mgetonlyabstractclasses) - Get a copy of the current collection with only abstract classes
+1. [getOnlyInstantiable](#mgetonlyinstantiable) - Get a copy of the current collection with only instantiable entities
+1. [getOnlyInterfaces](#mgetonlyinterfaces) - Get a copy of the current collection with only interfaces
+1. [getOnlyTraits](#mgetonlytraits) - Get a copy of the current collection with only traits
+1. [getOperationsLogCollection](#mgetoperationslogcollection)
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [internalFindEntity](#minternalfindentity)
+1. [internalGetLoadedOrCreateNew](#minternalgetloadedorcreatenew)
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadEntities](#mloadentities) - Load entities into a collection
+1. [loadEntitiesByConfiguration](#mloadentitiesbyconfiguration) - Load entities into a collection by configuration
+1. [remove](#mremove) - Remove an entity from a collection
+1. [removeAllNotLoadedEntities](#mremoveallnotloadedentities)
+1. [toArray](#mtoarray) - Convert collection to array
+1. [updateEntitiesCache](#mupdateentitiescache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L50)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper $phpParserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$cacheablePhpEntityFactory | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/Cache/CacheablePhpEntityFactory.php) | - |
+$docRendererHelper | [\BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Renderer/EntityDocRenderer/EntityDocRendererHelper.php) | - |
+$phpParserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\PhpParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/PhpParser/PhpParserHelper.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `add` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L190)
```php
public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Add an entity to the collection
-
Add an entity to the collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
Throws:
-
-
-
-
-
-
-
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$reload | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+
+---
+
+
# `clearOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L28)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function clearOperationsLogCollection(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `filterByInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L244)
```php
public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by interfaces names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $interfaces |
- string[] |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByNameRegularExpression` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L321)
```php
public function filterByNameRegularExpression(string $regexPattern): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only entities whose names match the regular expression
-
Get a copy of the current collection with only entities whose names match the regular expression
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $regexPattern |
- string |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$regexPattern | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `filterByParentClassNames` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L270)
```php
public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
Get a copy of the current collection only with entities filtered by parent classes names (filtering is only available for ClassLikeEntity)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentClassNames |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Parameters:***
-
Throws:
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `filterByPaths` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L298)
```php
public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
Get a copy of the current collection only with entities filtered by file paths (from project_root)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $paths |
- array |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$paths | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Throws:
-
-
-
-
-
-
-
+---
+
# `findEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L118)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function findEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Find an entity in a collection
+
+***Parameters:***
-
Find an entity in a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- - |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
+
+---
+
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L86)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from a collection (only previously added)
-
Get an entity from a collection (only previously added)
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
-
-
-
-
+---
+
# `getEntityCollectionName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L66)
```php
public function getEntityCollectionName(): string;
```
+Get collection name
-
Get collection name
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- getEntityLinkData
- :warning: Is internal | source code
-
+---
+
# `getEntityLinkData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L508)
```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$rawLink | [string](https://www.php.net/manual/en/language.types.string.php) | Raw link to an entity or entity element |
+$defaultEntityName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Entity name to use if the link does not contain a valid or existing entity name,
+ but only a cursor on an entity element |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rawLink |
- string |
- Raw link to an entity or entity element |
-
-
- $defaultEntityName |
- string | null |
- Entity name to use if the link does not contain a valid or existing entity name,
- but only a cursor on an entity element |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
-
-
-
-
+
# `getLoadedOrCreateNew` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L102)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Get an entity from the collection or create a new one if it has not yet been added
-
Get an entity from the collection or create a new one if it has not yet been added
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
See:
-
-
-
-
-
-
+***Parameters:***
-```php
-public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
-```
-
-
Get a copy of the current collection with only abstract classes
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters: not specified
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
+***Links:***
+- [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface::isEntityDataCanBeLoaded()](RootEntityInterface_2.md#misentitydatacanbeloaded)
+---
-
Throws:
-
+
# `getOnlyAbstractClasses` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L388)
+```php
+public function getOnlyAbstractClasses(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
+```
+Get a copy of the current collection with only abstract classes
-
-
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
+---
+
# `getOnlyInstantiable` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L338)
```php
public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only instantiable entities
-
Get a copy of the current collection with only instantiable entities
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
+---
+
# `getOnlyInterfaces` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L354)
```php
public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only interfaces
-
Get a copy of the current collection with only interfaces
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOnlyTraits` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L370)
```php
public function getOnlyTraits(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+Get a copy of the current collection with only traits
-
Get a copy of the current collection with only traits
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
-
-
-
+---
+
# `getOperationsLogCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/LoggableRootEntityCollection.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection
public function getOperationsLogCollection(): \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLogOperation/OperationsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection
-
-
-
-
-
-
-
-
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: bool
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
-- #
- internalFindEntity
- :warning: Is internal | source code
-
+---
+
# `internalFindEntity` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L421)
```php
public function internalFindEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | Search query. For the search, only the main part is taken, up to the characters: `::`, `->`, `#`.
If the request refers to multiple existing entities and if unsafe keys are allowed,
- a warning will be shown and the first entity found will be used. |
-
-
- $useUnsafeKeys |
- bool |
- Whether to use search keys that can be used to find several entities |
-
-
-
-
-
Return value: null |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
+ a warning will be shown and the first entity found will be used. |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Whether to use search keys that can be used to find several entities |
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
-
-
-
Examples of using:
-
+***Examples of using:***
```php
$entitiesCollection->findEntity('App'); // class name
$entitiesCollection->findEntity('BumbleDocGen\Console\App'); // class with namespace
@@ -889,318 +358,118 @@ $entitiesCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen
$entitiesCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/App.php'); // source link
```
-
-
-
-
-
-- #
- internalGetLoadedOrCreateNew
- :warning: Is internal | source code
-
+---
+
# `internalGetLoadedOrCreateNew` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L214)
```php
public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `loadEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php#L100)
```php
public function loadEntities(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection $sourceLocatorsCollection, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface|null $filters = null, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+Load entities into a collection
-
Load entities into a collection
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- loadEntitiesByConfiguration
- :warning: Is internal | source code
-
-
-```php
-public function loadEntitiesByConfiguration(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
-```
-
-
Load entities into a collection by configuration
-
-
Parameters:
-
-
+***Parameters:***
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
+| Name | Type | Description |
+|:-|:-|:-|
+$sourceLocatorsCollection | [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php) | - |
+$filters | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
Throws:
-
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
-
-
Return value: void
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `removeAllNotLoadedEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L132)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function removeAllNotLoadedEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `toArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L127)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function toArray(): array;
```
+Convert collection to array
-
Convert collection to array
-
-
Parameters: not specified
-
-
Return value: array
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
-
-
-- #
- updateEntitiesCache
- :warning: Is internal | source code
-
+---
+
# `updateEntitiesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L97)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection
public function updateEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/PregMatch.md b/docs/tech/03_renderer/classes/PregMatch.md
index 0e2f971b..3ae03066 100644
--- a/docs/tech/03_renderer/classes/PregMatch.md
+++ b/docs/tech/03_renderer/classes/PregMatch.md
@@ -1,28 +1,23 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+PregMatch
+---
+# [PregMatch](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class PregMatch implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+Perform a regular expression match
-Perform a regular expression match
-
-See:
-
-
-
+***Links:***
+- [https://www.php.net/manual/en/function.preg-match.php](https://www.php.net/manual/en/function.preg-match.php)
Settings:
@@ -38,114 +33,44 @@ See:
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L20)
```php
public function __invoke(string $text, string $pattern): array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$pattern | [string](https://www.php.net/manual/en/language.types.string.php) | The pattern to search for, as a string. |
-
Parameters:
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $pattern |
- string |
- The pattern to search for, as a string. |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L26)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L31)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/PrepareSourceLink.md b/docs/tech/03_renderer/classes/PrepareSourceLink.md
index abb9f147..55cce779 100644
--- a/docs/tech/03_renderer/classes/PrepareSourceLink.md
+++ b/docs/tech/03_renderer/classes/PrepareSourceLink.md
@@ -1,22 +1,20 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+PrepareSourceLink
+---
+# [PrepareSourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class PrepareSourceLink implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-The filter converts the string into an anchor that can be used in a GitHub document link
-
-
+The filter converts the string into an anchor that can be used in a GitHub document link
Settings:
@@ -32,109 +30,43 @@ final class PrepareSourceLink implements \BumbleDocGen\Core\Renderer\Twig\Filter
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L17)
```php
public function __invoke(string $text): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L22)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L27)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/PrintEntityCollectionAsList.md b/docs/tech/03_renderer/classes/PrintEntityCollectionAsList.md
index d05b2538..d3f8581c 100644
--- a/docs/tech/03_renderer/classes/PrintEntityCollectionAsList.md
+++ b/docs/tech/03_renderer/classes/PrintEntityCollectionAsList.md
@@ -1,39 +1,32 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+PrintEntityCollectionAsList
+---
+# [PrintEntityCollectionAsList](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L22) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class PrintEntityCollectionAsList implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Outputting entity data as MD list
-Outputting entity data as HTML list
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['ScriptFramework\\ScriptInterface', 'ScriptFramework\\TestScriptInterface'])) }}
The function will output a list of PHP classes that match the ScriptFramework\ScriptInterface and ScriptFramework\TestScriptInterface interfaces
-
```
-
```php
{{ printEntityCollectionAsList(phpEntities) }}
The function will list all documented PHP classes
-
```
-
-
Settings:
@@ -43,175 +36,64 @@ The function will list all documented PHP classes
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L24)
```php
-public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction);
+public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Renderer\Twig\Filter\RemoveLineBrakes $removeLineBrakes);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$removeLineBrakes | [\BumbleDocGen\Core\Renderer\Twig\Filter\RemoveLineBrakes](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L51)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $type = 'ul', bool $skipDescription = false, bool $useFullName = false): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $type = 'ul', bool $skipDescription = false, bool $useFullName = false): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$type | [string](https://www.php.net/manual/en/language.types.string.php) | List tag type (
/) |
+$skipDescription | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Don't print description of this entities |
+$useFullName | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Use the full name of the entity in the list |
-Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $type |
- string |
- List tag type ( |
-
-
- $skipDescription |
- bool |
- Don't print description of this entities |
-
-
- $useFullName |
- bool |
- Use the full name of the entity in the list |
-
-
-
-
-Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L30)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L35)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/Quotemeta.md b/docs/tech/03_renderer/classes/Quotemeta.md
index 1f61c598..08b96be6 100644
--- a/docs/tech/03_renderer/classes/Quotemeta.md
+++ b/docs/tech/03_renderer/classes/Quotemeta.md
@@ -1,28 +1,23 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+Quotemeta
+---
+# [Quotemeta](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class Quotemeta implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+Quote meta characters
-Quote meta characters
-
-See:
-
-
-
+***Links:***
+- [https://www.php.net/manual/en/function.quotemeta.php](https://www.php.net/manual/en/function.quotemeta.php)
Settings:
@@ -38,109 +33,43 @@ See:
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L15)
```php
public function __invoke(string $text): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L20)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L25)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/RemoveLineBrakes.md b/docs/tech/03_renderer/classes/RemoveLineBrakes.md
index 6e98af5f..5586e65e 100644
--- a/docs/tech/03_renderer/classes/RemoveLineBrakes.md
+++ b/docs/tech/03_renderer/classes/RemoveLineBrakes.md
@@ -1,22 +1,20 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+RemoveLineBrakes
+---
+# [RemoveLineBrakes](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class RemoveLineBrakes implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-The filter replaces all line breaks with a space
-
-
+The filter replaces all line breaks with a space
Settings:
@@ -32,109 +30,43 @@ final class RemoveLineBrakes implements \BumbleDocGen\Core\Renderer\Twig\Filter\
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L15)
```php
public function __invoke(string $text): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L20)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L25)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/RendererContext.md b/docs/tech/03_renderer/classes/RendererContext.md
index 90e8f0a4..97c045d0 100644
--- a/docs/tech/03_renderer/classes/RendererContext.md
+++ b/docs/tech/03_renderer/classes/RendererContext.md
@@ -1,256 +1,111 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+RendererContext
+---
+# [RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
final class RendererContext
```
+Document rendering context
-Document rendering context
-
-
-
-
-
-
-
-Methods:
-
-
--
- addDependency
-
--
- clearDependencies
-
--
- getCurrentDocumentedEntityWrapper
-
--
- getCurrentTemplateFilePatch
- - Getting the path to the template file that is currently being worked on
--
- getDependencies
-
--
- setCurrentDocumentedEntityWrapper
-
--
- setCurrentTemplateFilePatch
- - Saving the path to the template file that is currently being worked on in the context
-
-
-
+## Methods
+1. [addDependency](#madddependency)
+1. [clearDependencies](#mcleardependencies)
+1. [getCurrentDocumentedEntityWrapper](#mgetcurrentdocumentedentitywrapper)
+1. [getCurrentTemplateFilePatch](#mgetcurrenttemplatefilepatch) - Getting the path to the template file that is currently being worked on
+1. [getDependencies](#mgetdependencies)
+1. [setCurrentDocumentedEntityWrapper](#msetcurrentdocumentedentitywrapper)
+1. [setCurrentTemplateFilePatch](#msetcurrenttemplatefilepatch) - Saving the path to the template file that is currently being worked on in the context
+## Methods details:
-
-
-Method details:
-
-
-
-
-
+
# `addDependency` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L53)
```php
public function addDependency(\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface $dependency): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$dependency | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyInterface.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `clearDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L48)
```php
public function clearDependencies(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `getCurrentDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L43)
```php
public function getCurrentDocumentedEntityWrapper(): null|\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
-
-
-
-
-
+
# `getCurrentTemplateFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L32)
```php
public function getCurrentTemplateFilePatch(): string;
```
+Getting the path to the template file that is currently being worked on
-
Getting the path to the template file that is currently being worked on
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L58)
```php
public function getDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `setCurrentDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L37)
```php
public function setCurrentDocumentedEntityWrapper(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $currentDocumentedEntityWrapper): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$currentDocumentedEntityWrapper | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `setCurrentTemplateFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L24)
```php
public function setCurrentTemplateFilePatch(string $currentTemplateFilePath): void;
```
+Saving the path to the template file that is currently being worked on in the context
-
Saving the path to the template file that is currently being worked on in the context
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentTemplateFilePath |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$currentTemplateFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/03_renderer/classes/RootEntityCollection.md b/docs/tech/03_renderer/classes/RootEntityCollection.md
index 2ba67046..c15ff710 100644
--- a/docs/tech/03_renderer/classes/RootEntityCollection.md
+++ b/docs/tech/03_renderer/classes/RootEntityCollection.md
@@ -1,12 +1,13 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+RootEntityCollection
+---
+# [RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L18) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
@@ -14,548 +15,221 @@ namespace BumbleDocGen\Core\Parser\Entity;
abstract class RootEntityCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate
```
-
-
-
-
-
-
-
-
-Methods:
-
-
--
- findEntity
- - Find an entity in a collection
--
- get
- - Get an entity from a collection (only previously added)
--
- getEntityCollectionName
- - Get collection name
--
- getEntityLinkData
-
--
- getIterator
-
--
- getLoadedOrCreateNew
- - Get an entity from the collection or create a new one if it has not yet been added
--
- has
- - Check if an entity has been added to the collection
--
- isEmpty
- - Check if the collection is empty or not
--
- loadEntities
-
--
- loadEntitiesByConfiguration
-
--
- remove
- - Remove an entity from a collection
--
- removeAllNotLoadedEntities
-
--
- toArray
- - Convert collection to array
--
- updateEntitiesCache
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+## Methods
+
+1. [findEntity](#mfindentity) - Find an entity in a collection
+1. [get](#mget) - Get an entity from a collection (only previously added)
+1. [getEntityCollectionName](#mgetentitycollectionname) - Get collection name
+1. [getEntityLinkData](#mgetentitylinkdata)
+1. [getIterator](#mgetiterator)
+1. [getLoadedOrCreateNew](#mgetloadedorcreatenew) - Get an entity from the collection or create a new one if it has not yet been added
+1. [has](#mhas) - Check if an entity has been added to the collection
+1. [isEmpty](#misempty) - Check if the collection is empty or not
+1. [loadEntities](#mloadentities)
+1. [loadEntitiesByConfiguration](#mloadentitiesbyconfiguration)
+1. [remove](#mremove) - Remove an entity from a collection
+1. [removeAllNotLoadedEntities](#mremoveallnotloadedentities)
+1. [toArray](#mtoarray) - Convert collection to array
+1. [updateEntitiesCache](#mupdateentitiescache)
+
+## Methods details:
+
+
# `findEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L76)
```php
public function findEntity(string $search, bool $useUnsafeKeys = true): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+Find an entity in a collection
-
Find an entity in a collection
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $search |
- string |
- - |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
+***Parameters:***
-```php
-public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
-```
+| Name | Type | Description |
+|:-|:-|:-|
+$search | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Get an entity from a collection (only previously added)
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
Parameters:
+---
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+
# `get` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L49)
+```php
+public function get(string $objectName): null|\BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
+```
+Get an entity from a collection (only previously added)
-
Return value: null |
\BumbleDocGen\Core\Parser\Entity\RootEntityInterface
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
+---
+
# `getEntityCollectionName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L39)
```php
public function getEntityCollectionName(): string;
```
+Get collection name
-
Get collection name
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-- #
- getEntityLinkData
- :warning: Is internal | source code
-
+---
+
# `getEntityLinkData` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L90)
```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rawLink | [string](https://www.php.net/manual/en/language.types.string.php) | Raw link to an entity or entity element |
+$defaultEntityName | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Entity name to use if the link does not contain a valid or existing entity name,
+ but only a cursor on an entity element |
+$useUnsafeKeys | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rawLink |
- string |
- Raw link to an entity or entity element |
-
-
- $defaultEntityName |
- string | null |
- Entity name to use if the link does not contain a valid or existing entity name,
- but only a cursor on an entity element |
-
-
- $useUnsafeKeys |
- bool |
- - |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L11)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
+---
-
Parameters: not specified
-
-
Return value: \Generator
+
# `getLoadedOrCreateNew` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L67)
+```php
+public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
+```
+Get an entity from the collection or create a new one if it has not yet been added
+***Parameters:***
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$withAddClassEntityToCollectionEvent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-```php
-public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
-```
+***Links:***
+- [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface::isEntityDataCanBeLoaded()](RootEntityInterface_2.md#misentitydatacanbeloaded)
-
Get an entity from the collection or create a new one if it has not yet been added
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
- $withAddClassEntityToCollectionEvent |
- bool |
- - |
-
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
See:
-
-
-
-
-
-
+---
+
# `has` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L42)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function has(string $objectName): bool;
```
+Check if an entity has been added to the collection
-
Check if an entity has been added to the collection
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isEmpty` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L52)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function isEmpty(): bool;
```
+Check if the collection is empty or not
-
Check if the collection is empty or not
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `loadEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L28)
```php
public function loadEntities(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection $sourceLocatorsCollection, \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface|null $filters = null, \BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$sourceLocatorsCollection | [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php) | - |
+$filters | [\BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/FilterCondition/ConditionInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
+---
+
+
# `loadEntitiesByConfiguration` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L26)
```php
public function loadEntitiesByConfiguration(\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface|null $progressBar = null): \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$progressBar | [\BumbleDocGen\Core\Parser\Entity\EntitiesLoaderProgressBarInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntitiesLoaderProgressBarInterface.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/CollectionLoadEntitiesResult.php)
-
Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLoadEntitiesResult
-
-
-
-
-
-
-
+---
+
# `remove` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/BaseEntityCollection.php#L32)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection
public function remove(string $objectName): void;
```
+Remove an entity from a collection
-
Remove an entity from a collection
-
-
Parameters:
+***Parameters:***
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $objectName |
- string |
- - |
-
-
-
+| Name | Type | Description |
+|:-|:-|:-|
+$objectName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-
+
# `removeAllNotLoadedEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L132)
```php
public function removeAllNotLoadedEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `toArray` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L127)
```php
public function toArray(): array;
```
+Convert collection to array
-
Convert collection to array
-
-
Parameters: not specified
-
-
Return value: array
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
-
-
-
-
-- #
- updateEntitiesCache
- :warning: Is internal | source code
-
-
+
# `updateEntitiesCache` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php#L97)
```php
public function updateEntitiesCache(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/RootEntityInterface.md b/docs/tech/03_renderer/classes/RootEntityInterface.md
index d1d84406..264e02b2 100644
--- a/docs/tech/03_renderer/classes/RootEntityInterface.md
+++ b/docs/tech/03_renderer/classes/RootEntityInterface.md
@@ -1,469 +1,218 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template functions](../05_twigCustomFunctions.md) **/**
+RootEntityInterface
+---
+# [RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L11) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
interface RootEntityInterface extends \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
+Since the documentation generator supports several programming languages,
+their entities need to correspond to the same interfaces
-Since the documentation generator supports several programming languages,
-their entities need to correspond to the same interfaces
-
-
-
-
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getEntityDependencies
-
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getName
- - Full name of the entity
--
- getObjectId
- - Entity object ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- isEntityCacheOutdated
-
--
- isEntityDataCanBeLoaded
- - Checking if it is possible to get the entity data
--
- isEntityNameValid
- - Check if entity name is valid
--
- isExternalLibraryEntity
- - The entity is loaded from a third party library and should not be treated the same as a standard one
--
- isInGit
- - The entity file is in the git repository
--
- normalizeClassName
-
-
+## Methods
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getName](#mgetname) - Full name of the entity
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded) - Checking if it is possible to get the entity data
+1. [isEntityNameValid](#misentitynamevalid) - Check if entity name is valid
+1. [isExternalLibraryEntity](#misexternallibraryentity) - The entity is loaded from a third party library and should not be treated the same as a standard one
+1. [isInGit](#misingit) - The entity file is in the git repository
+1. [normalizeClassName](#mnormalizeclassname)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L53)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L33)
```php
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L40)
```php
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileSourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L42)
```php
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L30)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L16)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L37)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L58)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L23)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+Checking if it is possible to get the entity data
-
Checking if it is possible to get the entity data
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L18)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if entity name is valid
-
Check if entity name is valid
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isExternalLibraryEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L28)
```php
public function isExternalLibraryEntity(): bool;
```
+The entity is loaded from a third party library and should not be treated the same as a standard one
-
The entity is loaded from a third party library and should not be treated the same as a standard one
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isInGit` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L38)
```php
public function isInGit(): bool;
```
+The entity file is in the git repository
-
The entity file is in the git repository
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L13)
```php
public static function normalizeClassName(string $name): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/classes/RootEntityInterface_2.md b/docs/tech/03_renderer/classes/RootEntityInterface_2.md
index 2e9bf66c..e309a3c6 100644
--- a/docs/tech/03_renderer/classes/RootEntityInterface_2.md
+++ b/docs/tech/03_renderer/classes/RootEntityInterface_2.md
@@ -1,469 +1,217 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+RootEntityInterface
+---
+# [RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L11) class:
```php
namespace BumbleDocGen\Core\Parser\Entity;
interface RootEntityInterface extends \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
+Since the documentation generator supports several programming languages,
+their entities need to correspond to the same interfaces
-Since the documentation generator supports several programming languages,
-their entities need to correspond to the same interfaces
-
-
-
-
-
-
-
-Methods:
-
-
--
- getAbsoluteFileName
- - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
--
- getEntityDependencies
-
--
- getFileContent
-
--
- getFileSourceLink
-
--
- getName
- - Full name of the entity
--
- getObjectId
- - Entity object ID
--
- getRelativeFileName
- - File name relative to project_root configuration parameter
--
- getRootEntityCollection
- - Get parent collection of entities
--
- getShortName
- - Short name of the entity
--
- isEntityCacheOutdated
-
--
- isEntityDataCanBeLoaded
- - Checking if it is possible to get the entity data
--
- isEntityNameValid
- - Check if entity name is valid
--
- isExternalLibraryEntity
- - The entity is loaded from a third party library and should not be treated the same as a standard one
--
- isInGit
- - The entity file is in the git repository
--
- normalizeClassName
-
-
+## Methods
+1. [getAbsoluteFileName](#mgetabsolutefilename) - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
+1. [getEntityDependencies](#mgetentitydependencies)
+1. [getFileContent](#mgetfilecontent)
+1. [getFileSourceLink](#mgetfilesourcelink)
+1. [getName](#mgetname) - Full name of the entity
+1. [getObjectId](#mgetobjectid) - Entity object ID
+1. [getRelativeFileName](#mgetrelativefilename) - File name relative to project_root configuration parameter
+1. [getRootEntityCollection](#mgetrootentitycollection) - Get parent collection of entities
+1. [getShortName](#mgetshortname) - Short name of the entity
+1. [isEntityCacheOutdated](#misentitycacheoutdated)
+1. [isEntityDataCanBeLoaded](#misentitydatacanbeloaded) - Checking if it is possible to get the entity data
+1. [isEntityNameValid](#misentitynamevalid) - Check if entity name is valid
+1. [isExternalLibraryEntity](#misexternallibraryentity) - The entity is loaded from a third party library and should not be treated the same as a standard one
+1. [isInGit](#misingit) - The entity file is in the git repository
+1. [normalizeClassName](#mnormalizeclassname)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `getAbsoluteFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L53)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getAbsoluteFileName(): null|string;
```
+Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
-
-
Parameters: not specified
-
-
Return value: null |
string
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getEntityDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L33)
```php
public function getEntityDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getFileContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L40)
```php
public function getFileContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileSourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L42)
```php
public function getFileSourceLink(bool $withLine = true): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$withLine | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $withLine |
- bool |
- - |
-
-
-
-
-
Return value: null |
string
-
-
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L30)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getName(): string;
```
+Full name of the entity
-
Full name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getObjectId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L16)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getObjectId(): string;
```
+Entity object ID
-
Entity object ID
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getRelativeFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L46)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRelativeFileName(): null|string;
```
+File name relative to project_root configuration parameter
-
File name relative to project_root configuration parameter
-
-
Parameters: not specified
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
+***Links:***
+- [\BumbleDocGen\Core\Configuration\Configuration::getProjectRoot()](Configuration.md#mgetprojectroot)
+---
-
-
See:
-
-
-
-
-
-
-
+
# `getRootEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L23)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
```
+Get parent collection of entities
-
Get parent collection of entities
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php)
+---
-
-
-
-
-
-
+
# `getShortName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L37)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getShortName(): string;
```
+Short name of the entity
-
Short name of the entity
-
-
Parameters: not specified
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
-- #
- isEntityCacheOutdated
- :warning: Is internal | source code
-
+---
+
# `isEntityCacheOutdated` ⚠️ Internal **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/EntityInterface.php#L58)
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function isEntityCacheOutdated(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
-
-
-
+
# `isEntityDataCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L23)
```php
public function isEntityDataCanBeLoaded(): bool;
```
+Checking if it is possible to get the entity data
-
Checking if it is possible to get the entity data
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
+---
+
# `isEntityNameValid` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L18)
```php
public static function isEntityNameValid(string $entityName): bool;
```
+Check if entity name is valid
-
Check if entity name is valid
+***Parameters:***
-
Parameters:
+| Name | Type | Description |
+|:-|:-|:-|
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entityName |
- string |
- - |
-
-
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
Return value: bool
-
-
-
-
-
-
-
+---
+
# `isExternalLibraryEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L28)
```php
public function isExternalLibraryEntity(): bool;
```
+The entity is loaded from a third party library and should not be treated the same as a standard one
-
The entity is loaded from a third party library and should not be treated the same as a standard one
-
-
Parameters: not specified
-
-
Return value: bool
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
-
-
-
-
-
+
# `isInGit` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L38)
```php
public function isInGit(): bool;
```
+The entity file is in the git repository
-
The entity file is in the git repository
-
-
Parameters: not specified
-
-
Return value: bool
-
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
-
-
-
+---
+
# `normalizeClassName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php#L13)
```php
public static function normalizeClassName(string $name): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/03_renderer/classes/StrTypeToUrl.md b/docs/tech/03_renderer/classes/StrTypeToUrl.md
index 19669341..2b47cb0f 100644
--- a/docs/tech/03_renderer/classes/StrTypeToUrl.md
+++ b/docs/tech/03_renderer/classes/StrTypeToUrl.md
@@ -1,28 +1,23 @@
-
-
-
-
+[BumbleDocGen](../../../README.md) **/**
+[Technical description of the project](../../readme.md) **/**
+[Renderer](../readme.md) **/**
+[Template filters](../04_twigCustomFilters.md) **/**
+StrTypeToUrl
+---
+# [StrTypeToUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L18) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class StrTypeToUrl implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+The filter converts the string with the data type into a link to the documented entity, if possible.
-The filter converts the string with the data type into a link to the documented entity, if possible.
-
-See:
-
-
-
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](GetDocumentedEntityUrl_2.md)
Settings:
@@ -38,178 +33,66 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L51)
```php
-public function __invoke(string $text, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, bool $useShortLinkVersion = false, bool $createDocument = false): string;
+public function __invoke(array $context, string $text, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, bool $useShortLinkVersion = false, bool $createDocument = false, string $separator = ' | '): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$useShortLinkVersion | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Shorten or not the link name. When shortening, only the shortName of the entity will be shown |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
+$separator | [string](https://www.php.net/manual/en/language.types.string.php) | Separator between types |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- - |
-
-
- $useShortLinkVersion |
- bool |
- Shorten or not the link name. When shortening, only the shortName of the entity will be shown |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L27)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L32)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/03_renderer/classes/TextToCodeBlock.md b/docs/tech/03_renderer/classes/TextToCodeBlock.md
deleted file mode 100644
index 60d661ef..00000000
--- a/docs/tech/03_renderer/classes/TextToCodeBlock.md
+++ /dev/null
@@ -1,145 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Filter;
-
-final class TextToCodeBlock implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
-```
-
-Convert text to code block
-
-
-
-
-Settings:
-
-
-
- name |
- value |
-
-
- Filter name: |
- textToCodeBlock |
-
-
-
-
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __invoke(string $text, string $codeBlockType): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $codeBlockType |
- string |
- Code block type (e.g. php or console ) |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/03_renderer/classes/TextToHeading.md b/docs/tech/03_renderer/classes/TextToHeading.md
deleted file mode 100644
index e0b5cf0a..00000000
--- a/docs/tech/03_renderer/classes/TextToHeading.md
+++ /dev/null
@@ -1,145 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Filter;
-
-final class TextToHeading implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
-```
-
-Convert text to html header
-
-
-
-
-Settings:
-
-
-
- name |
- value |
-
-
- Filter name: |
- textToHeading |
-
-
-
-
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __invoke(string $text, string $headingType): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- - |
-
-
- $headingType |
- string |
- Choose heading type: H1, H2, H3 |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/03_renderer/readme.md b/docs/tech/03_renderer/readme.md
index 63222f4f..b4aabe56 100644
--- a/docs/tech/03_renderer/readme.md
+++ b/docs/tech/03_renderer/readme.md
@@ -1,6 +1,11 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+Renderer
-
+---
+
+
+# Documentation renderer
Render passes through all files from the directory specified in configuration param `templates_dir`
@@ -8,21 +13,29 @@ If the file ends with **.twig** then the file is processed, otherwise it is simp
to the target directory obtained from configuration param `output_dir`.
We use twig to process templates.
-
+## More detailed description of renderer components
+
-
+- [How to create documentation templates?](01_howToCreateTemplates/readme.md)
+ - [Front Matter](01_howToCreateTemplates/frontMatter.md)
+ - [Templates dynamic blocks](01_howToCreateTemplates/templatesDynamicBlocks.md)
+ - [Linking templates](01_howToCreateTemplates/templatesLinking.md)
+ - [Templates variables](01_howToCreateTemplates/templatesVariables.md)
+- [Documentation structure and breadcrumbs](02_breadcrumbs.md)
+- [Document structure of generated entities](03_documentStructure.md)
+- [Template filters](04_twigCustomFilters.md)
+- [Template functions](05_twigCustomFunctions.md)
-
+## Starting the rendering process
```php
- $renderer = new Renderer(...);
-
- // Starting the process of filling templates with data and saving finished documents
- $renderer->run();
-```
+$renderer = new Renderer(...);
+// Starting the process of filling templates with data and saving finished documents
+$renderer->run();
+```
-
+## How it works
The process of rendering documents is divided into several stages. We separately generate documentation for templates that were pre-prepared by the user,
and then create documentation for classes that the user refers to from document templates.
@@ -58,6 +71,6 @@ This process is presented in the form of a diagram below.
style EntityProcessing stroke:#f66,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/04_pluginSystem.md b/docs/tech/04_pluginSystem.md
index d9276374..ea6d300c 100644
--- a/docs/tech/04_pluginSystem.md
+++ b/docs/tech/04_pluginSystem.md
@@ -1,12 +1,17 @@
-
+[BumbleDocGen](../README.md) **/**
+[Technical description of the project](readme.md) **/**
+Plugin system
-
+---
+
+
+# Plugin system
The documentation generator includes the ability to expand the functionality using plugins that allow you to add the necessary functionality to the system without changing its core.
-The system is built on the basis of an event model, each plugin class must implement PluginInterface.
+The system is built on the basis of an event model, each plugin class must implement [PluginInterface](classes/PluginInterface.md).
-
+## Configuration example
You can add your plugins to the configuration like this:
@@ -16,163 +21,47 @@ plugins:
- class: \SelfDocConfig\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin
```
-
+## Default plugins
Below are the plugins that are available by default when working with the library.
Plugins for any programming languages work regardless of which language handler is configured in the configuration.
-
-
- Plugin |
- PL |
- Handles events |
- Description |
-
-
- LastPageCommitter |
- any |
-
-
- |
- Plugin for adding a block with information about the last commit and date of page update to the generated document |
-
-
- PageHtmlLinkerPlugin |
- any |
-
-
- |
- Adds URLs to empty links in HTML format;
- Links may contain:
- 1) Short entity name
- 2) Full entity name
- 3) Relative link to the entity file from the root directory of the project
- 4) Page title ( title )
- 5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation |
-
-
- PageLinkerPlugin |
- any |
-
-
- |
- Adds URLs to empty links in HTML format;
- Links may contain:
- 1) Short entity name
- 2) Full entity name
- 3) Relative link to the entity file from the root directory of the project
- 4) Page title ( title )
- 5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation |
-
-
- PageRstLinkerPlugin |
- any |
-
-
- |
- Adds URLs to empty links in rst format;
- Links may contain:
- 1) Short entity name
- 2) Full entity name
- 3) Relative link to the entity file from the root directory of the project
- 4) Page title ( title )
- 5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation |
-
-
- BasePhpStubberPlugin |
- PHP |
-
-
- |
- Adding links to type documentation and documentation of built-in PHP classes |
-
-
- PhpDocumentorStubberPlugin |
- PHP |
-
-
- |
- Adding links to the documentation of PHP classes in the \phpDocumentor namespace |
-
-
- PhpUnitStubberPlugin |
- PHP |
-
-
- |
- Adding links to the documentation of PHP classes in the \PHPUnit namespace |
-
-
- StubberPlugin |
- PHP |
-
-
- |
- The plugin allows you to automatically provide links to github repositories for documented classes from libraries included in composer |
-
-
- Daux |
- PHP |
-
-
- |
- |
-
-
- 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. |
-
-
-
-
-
-
-
-
+| Plugin | PL | Handles events | Description |
+|-|-|-|-|
+| [LastPageCommitter](classes/LastPageCommitter.md) | any | - [BeforeCreatingDocFile](classes/BeforeCreatingDocFile.md)
| Plugin for adding a block with information about the last commit and date of page update to the generated document |
+| [PageHtmlLinkerPlugin](classes/PageHtmlLinkerPlugin.md) | any | - [BeforeCreatingDocFile](classes/BeforeCreatingDocFile.md)
| Adds URLs to empty links in HTML format; Links may contain: 1) Short entity name 2) Full entity name 3) Relative link to the entity file from the root directory of the project 4) Page title ( title ) 5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() ) 6) Relative reference to the entity document from the root directory of the documentation |
+| [PageLinkerPlugin](classes/PageLinkerPlugin.md) | any | - [BeforeCreatingDocFile](classes/BeforeCreatingDocFile.md)
| Adds URLs to empty links in MD format; Links may contain: 1) Short entity name 2) Full entity name 3) Relative link to the entity file from the root directory of the project 4) Page title ( title ) 5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() ) 6) Relative reference to the entity document from the root directory of the documentation |
+| [PageRstLinkerPlugin](classes/PageRstLinkerPlugin.md) | any | - [BeforeCreatingDocFile](classes/BeforeCreatingDocFile.md)
| Adds URLs to empty links in rst format; Links may contain: 1) Short entity name 2) Full entity name 3) Relative link to the entity file from the root directory of the project 4) Page title ( title ) 5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() ) 6) Relative reference to the entity document from the root directory of the documentation |
+| [BasePhpStubberPlugin](classes/BasePhpStubberPlugin.md) | PHP | - [OnGettingResourceLink](classes/OnGettingResourceLink.md)
- [OnCheckIsEntityCanBeLoaded](classes/OnCheckIsEntityCanBeLoaded.md)
| Adding links to type documentation and documentation of built-in PHP classes |
+| [PhpDocumentorStubberPlugin](classes/PhpDocumentorStubberPlugin.md) | PHP | - [OnGettingResourceLink](classes/OnGettingResourceLink.md)
- [OnCheckIsEntityCanBeLoaded](classes/OnCheckIsEntityCanBeLoaded.md)
| Adding links to the documentation of PHP classes in the \phpDocumentor namespace |
+| [PhpUnitStubberPlugin](classes/PhpUnitStubberPlugin.md) | PHP | - [OnGettingResourceLink](classes/OnGettingResourceLink.md)
- [OnCheckIsEntityCanBeLoaded](classes/OnCheckIsEntityCanBeLoaded.md)
| Adding links to the documentation of PHP classes in the \PHPUnit namespace |
+| [StubberPlugin](classes/StubberPlugin.md) | PHP | - [OnGettingResourceLink](classes/OnGettingResourceLink.md)
- [OnCheckIsEntityCanBeLoaded](classes/OnCheckIsEntityCanBeLoaded.md)
| The plugin allows you to automatically provide links to github repositories for documented classes from libraries included in composer |
+| [Daux](classes/Daux.md) | PHP | - [OnCreateDocumentedEntityWrapper](classes/OnCreateDocumentedEntityWrapper.md)
- [OnGetTemplatePathByRelativeDocPath](classes/OnGetTemplatePathByRelativeDocPath.md)
- [OnGetProjectTemplatesDirs](classes/OnGetProjectTemplatesDirs.md)
- [BeforeCreatingDocFile](classes/BeforeCreatingDocFile.md)
- [BeforeCreatingEntityDocFile](classes/BeforeCreatingEntityDocFile.md)
- [AfterRenderingEntities](classes/AfterRenderingEntities.md)
| |
+| [EntityDocUnifiedPlacePlugin](classes/EntityDocUnifiedPlacePlugin.md) | PHP | - [OnCreateDocumentedEntityWrapper](classes/OnCreateDocumentedEntityWrapper.md)
- [OnGetTemplatePathByRelativeDocPath](classes/OnGetTemplatePathByRelativeDocPath.md)
- [OnGetProjectTemplatesDirs](classes/OnGetProjectTemplatesDirs.md)
| 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. |
+
+## Default events
+
+- [BeforeParsingProcess](classes/BeforeParsingProcess.md)
+- [AfterRenderingEntities](classes/AfterRenderingEntities.md)
+- [BeforeCreatingDocFile](classes/BeforeCreatingDocFile.md) - Called before the content of the documentation document is saved to a file
+- [BeforeCreatingEntityDocFile](classes/BeforeCreatingEntityDocFile.md)
+- [BeforeRenderingDocFiles](classes/BeforeRenderingDocFiles.md) - The event occurs before the main documents begin rendering
+- [BeforeRenderingEntities](classes/BeforeRenderingEntities.md) - The event occurs before the rendering of entity documents begins, after the main documents have been created
+- [OnCreateDocumentedEntityWrapper](classes/OnCreateDocumentedEntityWrapper.md) - The event occurs when an entity is added to the list for documentation
+- [OnGetProjectTemplatesDirs](classes/OnGetProjectTemplatesDirs.md) - This event occurs when all directories containing document templates are retrieved
+- [OnGetTemplatePathByRelativeDocPath](classes/OnGetTemplatePathByRelativeDocPath.md) - The event occurs when the path to the template file is obtained relative to the path to the document
+- [OnGettingResourceLink](classes/OnGettingResourceLink.md) - Event occurs when a reference to an entity (resource) is received
+- [OnLoadEntityDocPluginContent](classes/OnLoadEntityDocPluginContent.md) - Called when entity documentation is generated (plugin content loading)
+- [OnCheckIsEntityCanBeLoaded](classes/OnCheckIsEntityCanBeLoaded.md)
+- [AfterLoadingPhpEntitiesCollection](classes/AfterLoadingPhpEntitiesCollection.md) - The event is called after the initial creation of a collection of PHP entities
+- [OnAddClassEntityToCollection](classes/OnAddClassEntityToCollection.md) - Called when each class entity is added to the entity collection
+
+
+## Adding a new plugin
If you decide to add a new plugin, there are a few things you need to do:
-
+### 1) Add plugin class and implement events handling
```php
namespace Demo\Plugin\DemoFakeResourceLinkPlugin;
@@ -195,7 +84,7 @@ final class DemoFakeResourceLinkPlugin implements \BumbleDocGen\Core\Plugin\Plug
}
```
-
+### 2) Add the new plugin to the configuration
```yaml
plugins:
@@ -203,6 +92,6 @@ plugins:
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/05_console.md b/docs/tech/05_console.md
index bcc4148b..2f695681 100644
--- a/docs/tech/05_console.md
+++ b/docs/tech/05_console.md
@@ -1,8 +1,13 @@
-
+[BumbleDocGen](../README.md) **/**
+[Technical description of the project](readme.md) **/**
+Console app
-
+---
-The documentation generator provides the ability to work through a built-in console application.
+
+# Console app
+
+The documentation generator provides the ability to work through a built-in [console application](classes/App.md).
It is available via composer:
```console
vendor/bin/bumbleDocGen list
@@ -10,58 +15,25 @@ vendor/bin/bumbleDocGen list
We use [Symfony Console](https://github.com/symfony/console) as the basis of the console application.
-
+## Built-in console commands
-
-
- Command |
- Parameters |
- Description |
-
-
- help |
- [--format FORMAT] [--raw] [<command_name>] |
- Display help for a command |
-
-
- list |
- [--raw] [--format FORMAT] [--short] [<namespace>] |
- List commands |
-
-
- generate |
- [--as-html] [--project_root [PROJECT_ROOT]] [--templates_dir [TEMPLATES_DIR]] [--output_dir [OUTPUT_DIR]] [--cache_dir [CACHE_DIR]] [--use_shared_cache [USE_SHARED_CACHE]] |
- Generate documentation |
-
-
- serve |
- [--as-html] [--dev-server-host [DEV-SERVER-HOST]] [--dev-server-port [DEV-SERVER-PORT]] [--project_root [PROJECT_ROOT]] [--templates_dir [TEMPLATES_DIR]] [--use_shared_cache [USE_SHARED_CACHE]] |
- Serve documentation |
-
-
- ai:generate-readme-template |
- [--project_root [PROJECT_ROOT]] [--templates_dir [TEMPLATES_DIR]] [--cache_dir [CACHE_DIR]] [--ai_provider [AI_PROVIDER]] [--ai_api_key [AI_API_KEY]] [--ai_model [AI_MODEL]] |
- Leverage AI to generate content for a project readme.md file. |
-
-
- ai:add-doc-blocks |
- [--project_root [PROJECT_ROOT]] [--templates_dir [TEMPLATES_DIR]] [--cache_dir [CACHE_DIR]] [--ai_provider [AI_PROVIDER]] [--ai_api_key [AI_API_KEY]] [--ai_model [AI_MODEL]] |
- Leverage AI to insert missing doc blocks in code. |
-
-
- configuration |
- [<key>] |
- Display list of configured plugins, programming language handlers, etc |
-
-
+| Command | Parameters | Description |
+|-|-|-|
+| [help](https://github.com/symfony/console/blob/master/Command/HelpCommand.php) | [--format FORMAT]
[--raw]
[<command_name>] | Display help for a command |
+| [list](https://github.com/symfony/console/blob/master/Command/ListCommand.php) | [--raw]
[--format FORMAT]
[--short]
[<namespace>] | List commands |
+| [generate](classes/GenerateCommand.md) | [--as-html]
[--project_root [PROJECT_ROOT]]
[--templates_dir [TEMPLATES_DIR]]
[--output_dir [OUTPUT_DIR]]
[--cache_dir [CACHE_DIR]]
[--use_shared_cache [USE_SHARED_CACHE]] | Generate documentation |
+| [serve](classes/ServeCommand.md) | [--as-html]
[--dev-server-host [DEV-SERVER-HOST]]
[--dev-server-port [DEV-SERVER-PORT]]
[--project_root [PROJECT_ROOT]]
[--templates_dir [TEMPLATES_DIR]]
[--use_shared_cache [USE_SHARED_CACHE]] | Serve documentation |
+| [ai:generate-readme-template](classes/GenerateReadMeTemplateCommand.md) | [--project_root [PROJECT_ROOT]]
[--templates_dir [TEMPLATES_DIR]]
[--cache_dir [CACHE_DIR]]
[--ai_provider [AI_PROVIDER]]
[--ai_api_key [AI_API_KEY]]
[--ai_model [AI_MODEL]] | Leverage AI to generate content for a project readme.md file. |
+| [ai:add-doc-blocks](classes/AddDocBlocksCommand.md) | [--project_root [PROJECT_ROOT]]
[--templates_dir [TEMPLATES_DIR]]
[--cache_dir [CACHE_DIR]]
[--ai_provider [AI_PROVIDER]]
[--ai_api_key [AI_API_KEY]]
[--ai_model [AI_MODEL]] | Leverage AI to insert missing doc blocks in code. |
+| [configuration](classes/ConfigurationCommand.md) | [<key>] | Display list of configured plugins, programming language handlers, etc |
-
+## Adding a custom command
The system allows you to add custom commands to a standard console application.
-This can be done using a special configuration option additional_console_commands (see Configuration page).
+This can be done using a special configuration option [additional_console_commands](classes/Configuration.md#mgetadditionalconsolecommands) (see [Configuration](/docs/tech/01_configuration.md) page).
After adding a new command to the configuration, it will be available in the application. Each added command must inherit the `\Symfony\Component\Console\Command\Command` class
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Jan 11 13:50:48 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/06_debugging.md b/docs/tech/06_debugging.md
index 7fa6640b..299542b9 100644
--- a/docs/tech/06_debugging.md
+++ b/docs/tech/06_debugging.md
@@ -1,6 +1,11 @@
-
+[BumbleDocGen](../README.md) **/**
+[Technical description of the project](readme.md) **/**
+Debug documents
-
+---
+
+
+# Debug documents
Our tool provides several options for debugging documentation.
@@ -8,7 +13,7 @@ Our tool provides several options for debugging documentation.
**Here is an example of error output:**
-
+
2) To track exactly how documentation is generated, you can use the interactive mode:
@@ -20,6 +25,6 @@ Our tool provides several options for debugging documentation.
3) Logs are saved to a special file `last_run.log` which is located in the working directory
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 01:11:04 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/07_outputFormat.md b/docs/tech/07_outputFormat.md
index c36f6c2b..78f88c1f 100644
--- a/docs/tech/07_outputFormat.md
+++ b/docs/tech/07_outputFormat.md
@@ -1,11 +1,16 @@
-
+[BumbleDocGen](../README.md) **/**
+[Technical description of the project](readme.md) **/**
+Output formats
-
+---
+
+
+# Output formats
At the moment, the documentation generator is focused on creating documentation in two formats: [GitHub Flavored Markdown](https://github.github.com/gfm/) and HTML.
However, it is possible to create other files with some restrictions.
-1) Creating **GFM** documentation is possible both using a console application and using the built-in commands of the documentation generator.
+1) Creating **GFM** documentation is possible both using a [console application](/docs/tech/05_console.md) and using the [built-in commands](classes/DocGenerator.md#mgenerate) of the documentation generator.
* Generate GFM doc by console command:
```bash
@@ -24,7 +29,7 @@ However, it is possible to create other files with some restrictions.
(new DocGeneratorFactory())->create($configFile)->serve();
```
-2) Creating **HTML** documentation is only possible through a console application. The [Daux.io](https://daux.io/) library is used to generate HTML pages.
+2) Creating **HTML** documentation is only possible through a [console application](/docs/tech/05_console.md). The [Daux.io](https://daux.io/) library is used to generate HTML pages.
* Generate HTML doc by console command:
```bash
# Generate static HTML files ( see {output_dir}/html)
@@ -35,6 +40,6 @@ However, it is possible to create other files with some restrictions.
```
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:54:20 2024 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/docs/tech/classes/AddDocBlocksCommand.md b/docs/tech/classes/AddDocBlocksCommand.md
index 63cd8403..1a7c0fd8 100644
--- a/docs/tech/classes/AddDocBlocksCommand.md
+++ b/docs/tech/classes/AddDocBlocksCommand.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+AddDocBlocksCommand
+---
+# [AddDocBlocksCommand](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/AI/Console/AddDocBlocksCommand.php#L17) class:
```php
namespace BumbleDocGen\AI\Console;
@@ -14,78 +14,27 @@ namespace BumbleDocGen\AI\Console;
final class AddDocBlocksCommand extends \BumbleDocGen\Console\Command\BaseCommand
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Traits:
+1. [BumbleDocGen\AI\Traits\SharedCommandLogicTrait](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/AI/Traits/SharedCommandLogicTrait.php)
+## Methods details:
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-Traits:
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/BaseCommand.php#L21)
```php
// Implemented in BumbleDocGen\Console\Command\BaseCommand
public function __construct(string $name = null);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
-
-
-
+---
diff --git a/docs/tech/classes/AddIndentFromLeft.md b/docs/tech/classes/AddIndentFromLeft.md
index 28632e5e..0646aab6 100644
--- a/docs/tech/classes/AddIndentFromLeft.md
+++ b/docs/tech/classes/AddIndentFromLeft.md
@@ -1,22 +1,19 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+AddIndentFromLeft
+---
+# [AddIndentFromLeft](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class AddIndentFromLeft implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-Filter adds indent from left
-
-
+Filter adds indent from left
Settings:
@@ -32,119 +29,45 @@ final class AddIndentFromLeft implements \BumbleDocGen\Core\Renderer\Twig\Filter
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L18)
```php
public function __invoke(string $text, int $identLength = 4, bool $skipFirstIdent = false): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$identLength | [int](https://www.php.net/manual/en/language.types.integer.php) | Indent size |
+$skipFirstIdent | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Skip indent for first line in text or not |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $identLength |
- int |
- Indent size |
-
-
- $skipFirstIdent |
- bool |
- Skip indent for first line in text or not |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L24)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/AddIndentFromLeft.php#L29)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/AfterLoadingPhpEntitiesCollection.md b/docs/tech/classes/AfterLoadingPhpEntitiesCollection.md
index 966601ce..a9517138 100644
--- a/docs/tech/classes/AfterLoadingPhpEntitiesCollection.md
+++ b/docs/tech/classes/AfterLoadingPhpEntitiesCollection.md
@@ -1,105 +1,47 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+AfterLoadingPhpEntitiesCollection
+---
+# [AfterLoadingPhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/AfterLoadingPhpEntitiesCollection.php#L13) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Parser;
final class AfterLoadingPhpEntitiesCollection extends \Symfony\Contracts\EventDispatcher\Event
```
+The event is called after the initial creation of a collection of PHP entities
-The event is called after the initial creation of a collection of PHP entities
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getPhpEntitiesCollection
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getPhpEntitiesCollection](#mgetphpentitiescollection)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/AfterLoadingPhpEntitiesCollection.php#L15)
```php
public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getPhpEntitiesCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/AfterLoadingPhpEntitiesCollection.php#L19)
```php
public function getPhpEntitiesCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
+---
diff --git a/docs/tech/classes/AfterRenderingEntities.md b/docs/tech/classes/AfterRenderingEntities.md
index 3c6ad6c5..cf7ef177 100644
--- a/docs/tech/classes/AfterRenderingEntities.md
+++ b/docs/tech/classes/AfterRenderingEntities.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+AfterRenderingEntities
+---
+# [AfterRenderingEntities](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/AfterRenderingEntities.php#L9) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
@@ -15,17 +15,3 @@ final class AfterRenderingEntities extends \Symfony\Contracts\EventDispatcher\Ev
```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/classes/App.md b/docs/tech/classes/App.md
index 9983c68f..b7480b79 100644
--- a/docs/tech/classes/App.md
+++ b/docs/tech/classes/App.md
@@ -1,12 +1,12 @@
-
-
-
- App class:
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+App
+---
+# [App](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/App.php#L20) class:
```php
namespace BumbleDocGen\Console;
@@ -14,47 +14,15 @@ namespace BumbleDocGen\Console;
class App extends \Symfony\Component\Console\Application
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods details:
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/App.php#L22)
```php
public function __construct();
```
-
-
-
Parameters: not specified
-
-
-
-
-
+---
diff --git a/docs/tech/classes/BasePageLinkProcessor.md b/docs/tech/classes/BasePageLinkProcessor.md
index 99837dc9..790a433f 100644
--- a/docs/tech/classes/BasePageLinkProcessor.md
+++ b/docs/tech/classes/BasePageLinkProcessor.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+BasePageLinkProcessor
+---
+# [BasePageLinkProcessor](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/BasePageLinkProcessor.php#L9) class:
```php
namespace BumbleDocGen\Core\Renderer\PageLinkProcessor;
@@ -14,109 +14,39 @@ namespace BumbleDocGen\Core\Renderer\PageLinkProcessor;
class BasePageLinkProcessor implements \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getAbsoluteUrl](#mgetabsoluteurl)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAbsoluteUrl
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/BasePageLinkProcessor.php#L11)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAbsoluteUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/BasePageLinkProcessor.php#L15)
```php
public function getAbsoluteUrl(string $relativeUrl): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$relativeUrl | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $relativeUrl |
- string |
- - |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/classes/BasePhpStubberPlugin.md b/docs/tech/classes/BasePhpStubberPlugin.md
index 73144fff..975aeeb5 100644
--- a/docs/tech/classes/BasePhpStubberPlugin.md
+++ b/docs/tech/classes/BasePhpStubberPlugin.md
@@ -1,143 +1,63 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+BasePhpStubberPlugin
+---
+# [BasePhpStubberPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/BasePhpStubberPlugin.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\BasePhpStubber;
final class BasePhpStubberPlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
+Adding links to type documentation and documentation of built-in PHP classes
-Adding links to type documentation and documentation of built-in PHP classes
-
-
-
-
-
-
-
-Methods:
-
-
--
- getSubscribedEvents
-
--
- onCheckIsEntityCanBeLoaded
-
--
- onGettingResourceLink
-
-
-
-
-
-
-
+## Methods
+1. [getSubscribedEvents](#mgetsubscribedevents)
+1. [onCheckIsEntityCanBeLoaded](#moncheckisentitycanbeloaded)
+1. [onGettingResourceLink](#mongettingresourcelink)
-Method details:
-
-
-
-
+## Methods details:
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/BasePhpStubberPlugin.php#L146)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `onCheckIsEntityCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/BasePhpStubberPlugin.php#L169)
```php
public function onCheckIsEntityCanBeLoaded(\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php) | - |
-
Parameters:
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `onGettingResourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/BasePhpStubberPlugin.php#L154)
```php
public function onGettingResourceLink(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/BeforeCreatingDocFile.md b/docs/tech/classes/BeforeCreatingDocFile.md
index 82c24d16..a6a89d37 100644
--- a/docs/tech/classes/BeforeCreatingDocFile.md
+++ b/docs/tech/classes/BeforeCreatingDocFile.md
@@ -1,216 +1,90 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+BeforeCreatingDocFile
+---
+# [BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php#L12) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class BeforeCreatingDocFile extends \Symfony\Contracts\EventDispatcher\Event
```
+Called before the content of the documentation document is saved to a file
-Called before the content of the documentation document is saved to a file
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
+## Initialization methods
-
--
- getContent
-
--
- getOutputFilePatch
-
--
- setContent
-
--
- setOutputFilePatch
-
-
+1. [__construct](#m-construct)
+## Methods
+1. [getContent](#mgetcontent)
+1. [getOutputFilePatch](#mgetoutputfilepatch)
+1. [setContent](#msetcontent)
+1. [setOutputFilePatch](#msetoutputfilepatch)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php#L14)
```php
public function __construct(string $content, string $outputFilePatch);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$outputFilePatch | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $content |
- string |
- - |
-
-
- $outputFilePatch |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php#L20)
```php
public function getContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOutputFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php#L30)
```php
public function getOutputFilePatch(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `setContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php#L25)
```php
public function setContent(string $content): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $content |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
+---
+
# `setOutputFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php#L35)
```php
public function setOutputFilePatch(string $outputFilePatch): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$outputFilePatch | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $outputFilePatch |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/BeforeCreatingEntityDocFile.md b/docs/tech/classes/BeforeCreatingEntityDocFile.md
index 7271253d..a72b05a5 100644
--- a/docs/tech/classes/BeforeCreatingEntityDocFile.md
+++ b/docs/tech/classes/BeforeCreatingEntityDocFile.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+BeforeCreatingEntityDocFile
+---
+# [BeforeCreatingEntityDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php#L9) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
@@ -14,203 +14,76 @@ namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class BeforeCreatingEntityDocFile extends \Symfony\Contracts\EventDispatcher\Event
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getContent](#mgetcontent)
+1. [getOutputFilePatch](#mgetoutputfilepatch)
+1. [setContent](#msetcontent)
+1. [setOutputFilePatch](#msetoutputfilepatch)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getContent
-
--
- getOutputFilePatch
-
--
- setContent
-
--
- setOutputFilePatch
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php#L11)
```php
public function __construct(string $content, string $outputFilePatch);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$outputFilePatch | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $content |
- string |
- - |
-
-
- $outputFilePatch |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php#L17)
```php
public function getContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOutputFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php#L27)
```php
public function getOutputFilePatch(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `setContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php#L22)
```php
public function setContent(string $content): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $content |
- string |
- - |
-
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-
+
# `setOutputFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php#L32)
```php
public function setOutputFilePatch(string $outputFilePatch): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$outputFilePatch | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $outputFilePatch |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/BeforeParsingProcess.md b/docs/tech/classes/BeforeParsingProcess.md
index 17b80f01..f4aa3ca6 100644
--- a/docs/tech/classes/BeforeParsingProcess.md
+++ b/docs/tech/classes/BeforeParsingProcess.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+BeforeParsingProcess
+---
+# [BeforeParsingProcess](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Parser/BeforeParsingProcess.php#L9) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Parser;
@@ -14,47 +14,15 @@ namespace BumbleDocGen\Core\Plugin\Event\Parser;
final class BeforeParsingProcess extends \Symfony\Contracts\EventDispatcher\Event
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods details:
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Parser/BeforeParsingProcess.php#L11)
```php
public function __construct();
```
-
-
-
Parameters: not specified
-
-
-
-
-
+---
diff --git a/docs/tech/classes/BeforeRenderingDocFiles.md b/docs/tech/classes/BeforeRenderingDocFiles.md
index 7a23f72c..01b4c3f6 100644
--- a/docs/tech/classes/BeforeRenderingDocFiles.md
+++ b/docs/tech/classes/BeforeRenderingDocFiles.md
@@ -1,31 +1,18 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+BeforeRenderingDocFiles
+---
+# [BeforeRenderingDocFiles](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeRenderingDocFiles.php#L12) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class BeforeRenderingDocFiles extends \Symfony\Contracts\EventDispatcher\Event
```
-
-The event occurs before the main documents begin rendering
-
-
-
-
-
-
-
-
-
-
-
-
+The event occurs before the main documents begin rendering
diff --git a/docs/tech/classes/BeforeRenderingEntities.md b/docs/tech/classes/BeforeRenderingEntities.md
index 1647e0f6..1e0fd9ba 100644
--- a/docs/tech/classes/BeforeRenderingEntities.md
+++ b/docs/tech/classes/BeforeRenderingEntities.md
@@ -1,31 +1,18 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+BeforeRenderingEntities
+---
+# [BeforeRenderingEntities](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeRenderingEntities.php#L12) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class BeforeRenderingEntities extends \Symfony\Contracts\EventDispatcher\Event
```
-
-The event occurs before the rendering of entity documents begins, after the main documents have been created
-
-
-
-
-
-
-
-
-
-
-
-
+The event occurs before the rendering of entity documents begins, after the main documents have been created
diff --git a/docs/tech/classes/Configuration.md b/docs/tech/classes/Configuration.md
index e8777dd1..6b105faa 100644
--- a/docs/tech/classes/Configuration.md
+++ b/docs/tech/classes/Configuration.md
@@ -1,763 +1,245 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+Configuration
+---
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
```php
namespace BumbleDocGen\Core\Configuration;
final class Configuration
```
-
-Configuration project documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getAdditionalConsoleCommands
-
--
- getCacheDir
-
--
- getConfigurationVersion
-
--
- getDocGenLibDir
-
--
- getGitClientPath
-
--
- getIfExists
-
--
- getLanguageHandlersCollection
-
--
- getOutputDir
-
--
- getOutputDirBaseUrl
-
--
- getPageLinkProcessor
-
--
- getPlugins
-
--
- getProjectRoot
-
--
- getSourceLocators
-
--
- getTemplatesDir
-
--
- getTwigFilters
-
--
- getTwigFunctions
-
--
- getWorkingDir
-
--
- isCheckFileInGitBeforeCreatingDocEnabled
-
--
- renderWithFrontMatter
-
--
- useSharedCache
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
```php
public function getCacheDir(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
```php
public function getConfigurationVersion(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
```php
public function getDocGenLibDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
```php
public function getGitClientPath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
```php
public function getIfExists(mixed $key): null|string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- mixed |
- - |
-
-
-
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
-
Return value: null |
string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
```php
public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
```php
public function getOutputDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
```php
public function getOutputDirBaseUrl(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
```php
public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
```php
public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
```php
public function getProjectRoot(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
```php
public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
```php
public function getTemplatesDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
```php
public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
```php
public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
```php
public function getWorkingDir(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- isCheckFileInGitBeforeCreatingDocEnabled
- | source code
-
-
+
# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
```php
public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
```php
public function renderWithFrontMatter(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+---
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
```php
public function useSharedCache(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/classes/ConfigurationCommand.md b/docs/tech/classes/ConfigurationCommand.md
index d398575c..4ae2d4cb 100644
--- a/docs/tech/classes/ConfigurationCommand.md
+++ b/docs/tech/classes/ConfigurationCommand.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+ConfigurationCommand
+---
+# [ConfigurationCommand](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/ConfigurationCommand.php#L14) class:
```php
namespace BumbleDocGen\Console\Command;
@@ -14,66 +14,23 @@ namespace BumbleDocGen\Console\Command;
final class ConfigurationCommand extends \BumbleDocGen\Console\Command\BaseCommand
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods details:
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/BaseCommand.php#L21)
```php
// Implemented in BumbleDocGen\Console\Command\BaseCommand
public function __construct(string $name = null);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
-
-
-
+---
diff --git a/docs/tech/classes/Configuration_2.md b/docs/tech/classes/Configuration_2.md
new file mode 100644
index 00000000..02c63760
--- /dev/null
+++ b/docs/tech/classes/Configuration_2.md
@@ -0,0 +1,245 @@
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+Configuration
+
+---
+
+
+# [Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30) class:
+
+```php
+namespace BumbleDocGen\Core\Configuration;
+
+final class Configuration
+```
+Configuration project documentation
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [getAdditionalConsoleCommands](#mgetadditionalconsolecommands)
+1. [getCacheDir](#mgetcachedir)
+1. [getConfigurationVersion](#mgetconfigurationversion)
+1. [getDocGenLibDir](#mgetdocgenlibdir)
+1. [getGitClientPath](#mgetgitclientpath)
+1. [getIfExists](#mgetifexists)
+1. [getLanguageHandlersCollection](#mgetlanguagehandlerscollection)
+1. [getOutputDir](#mgetoutputdir)
+1. [getOutputDirBaseUrl](#mgetoutputdirbaseurl)
+1. [getPageLinkProcessor](#mgetpagelinkprocessor)
+1. [getPlugins](#mgetplugins)
+1. [getProjectRoot](#mgetprojectroot)
+1. [getSourceLocators](#mgetsourcelocators)
+1. [getTemplatesDir](#mgettemplatesdir)
+1. [getTwigFilters](#mgettwigfilters)
+1. [getTwigFunctions](#mgettwigfunctions)
+1. [getWorkingDir](#mgetworkingdir)
+1. [isCheckFileInGitBeforeCreatingDocEnabled](#mischeckfileingitbeforecreatingdocenabled)
+1. [renderWithFrontMatter](#mrenderwithfrontmatter)
+1. [useSharedCache](#musesharedcache)
+
+## Methods details:
+
+# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34)
+```php
+public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
+
+---
+
+# `getAdditionalConsoleCommands` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L377)
+```php
+public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
+```
+
+***Return value:*** [\BumbleDocGen\Console\Command\AdditionalCommandCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php)
+
+---
+
+# `getCacheDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L205)
+```php
+public function getCacheDir(): null|string;
+```
+
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getConfigurationVersion` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L42)
+```php
+public function getConfigurationVersion(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getDocGenLibDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L367)
+```php
+public function getDocGenLibDir(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getGitClientPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L256)
+```php
+public function getGitClientPath(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getIfExists` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L395)
+```php
+public function getIfExists(mixed $key): null|string;
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [mixed](https://www.php.net/manual/en/language.types.mixed.php) | - |
+
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getLanguageHandlersCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L166)
+```php
+public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;
+```
+
+***Return value:*** [\BumbleDocGen\LanguageHandler\LanguageHandlersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/LanguageHandlersCollection.php)
+
+---
+
+# `getOutputDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L112)
+```php
+public function getOutputDir(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getOutputDirBaseUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150)
+```php
+public function getOutputDirBaseUrl(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getPageLinkProcessor` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L238)
+```php
+public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;
+```
+
+***Return value:*** [\BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/PageLinkProcessor/PageLinkProcessorInterface.php)
+
+---
+
+# `getPlugins` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L187)
+```php
+public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
+```
+
+***Return value:*** [\BumbleDocGen\Core\Plugin\PluginsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginsCollection.php)
+
+---
+
+# `getProjectRoot` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L50)
+```php
+public function getProjectRoot(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getSourceLocators` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L66)
+```php
+public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;
+```
+
+***Return value:*** [\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/SourceLocator/SourceLocatorsCollection.php)
+
+---
+
+# `getTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L84)
+```php
+public function getTemplatesDir(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getTwigFilters` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295)
+```php
+public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;
+```
+
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/CustomFiltersCollection.php)
+
+---
+
+# `getTwigFunctions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L272)
+```php
+public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;
+```
+
+***Return value:*** [\BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/CustomFunctionsCollection.php)
+
+---
+
+# `getWorkingDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L358)
+```php
+public function getWorkingDir(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `isCheckFileInGitBeforeCreatingDocEnabled` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344)
+```php
+public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
+```
+
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+
+---
+
+# `renderWithFrontMatter` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L330)
+```php
+public function renderWithFrontMatter(): bool;
+```
+
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+
+---
+
+# `useSharedCache` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L316)
+```php
+public function useSharedCache(): bool;
+```
+
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
+
+---
diff --git a/docs/tech/classes/Daux.md b/docs/tech/classes/Daux.md
index 9f6f0b59..d25c4aae 100644
--- a/docs/tech/classes/Daux.md
+++ b/docs/tech/classes/Daux.md
@@ -1,319 +1,122 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+Daux
-
- Daux class:
-
+---
-
-
-:warning: Is internal
+# [Daux](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L22) class:
+⚠️ Internal
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\Daux;
final class Daux implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [afterRenderingEntities](#mafterrenderingentities)
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+1. [onCreateDocumentedEntityWrapper](#moncreatedocumentedentitywrapper)
+1. [onGetProjectTemplatesDirs](#mongetprojecttemplatesdirs)
+1. [onGetTemplatePathByRelativeDocPath](#mongettemplatepathbyrelativedocpath)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- afterRenderingEntities
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
--
- onCreateDocumentedEntityWrapper
-
--
- onGetProjectTemplatesDirs
-
--
- onGetTemplatePathByRelativeDocPath
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L27)
```php
-public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper);
+public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `afterRenderingEntities` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L100)
```php
public function afterRenderingEntities(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L50)
```php
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile|\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingEntityDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) \| [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingEntityDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingEntityDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L35)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `onCreateDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L76)
```php
public function onCreateDocumentedEntityWrapper(\BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnCreateDocumentedEntityWrapper.php) | - |
-
Parameters:
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
-
-
-
-
-
+
# `onGetProjectTemplatesDirs` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L92)
```php
public function onGetProjectTemplatesDirs(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetProjectTemplatesDirs $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetProjectTemplatesDirs](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetProjectTemplatesDirs.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `onGetTemplatePathByRelativeDocPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php#L83)
```php
public function onGetTemplatePathByRelativeDocPath(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/DocGenerator.md b/docs/tech/classes/DocGenerator.md
index 9fb2b361..64ac0a7e 100644
--- a/docs/tech/classes/DocGenerator.md
+++ b/docs/tech/classes/DocGenerator.md
@@ -1,577 +1,175 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Output formats](../07_outputFormat.md) **/**
+DocGenerator
+---
+# [DocGenerator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L46) class:
```php
namespace BumbleDocGen;
final class DocGenerator
```
+Class for generating documentation.
-Class for generating documentation.
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addDocBlocks
- - Generate missing docBlocks with LLM for project class methods that are available for documentation
--
- addPlugin
-
--
- generate
- - Generates documentation using configuration
--
- generateReadmeTemplate
- - Creates a `README.md` template filled with basic information using LLM
--
- getConfiguration
-
--
- getConfigurationKey
-
--
- getConfigurationKeys
-
--
- parseAndGetRootEntityCollectionsGroup
-
--
- serve
- - Serve documentation
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
-Constants:
-
+1. [addDocBlocks](#madddocblocks) - Generate missing docBlocks with LLM for project class methods that are available for documentation
+1. [addPlugin](#maddplugin)
+1. [generate](#mgenerate) - Generates documentation using configuration
+1. [generateReadmeTemplate](#mgeneratereadmetemplate) - Creates a `README.md` template filled with basic information using LLM
+1. [getConfiguration](#mgetconfiguration)
+1. [getConfigurationKey](#mgetconfigurationkey)
+1. [getConfigurationKeys](#mgetconfigurationkeys)
+1. [parseAndGetRootEntityCollectionsGroup](#mparseandgetrootentitycollectionsgroup)
+1. [serve](#mserve) - Serve documentation
+## Methods details:
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L56)
```php
public function __construct(\Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler $generationErrorsHandler, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \DI\Container $diContainer, \BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache $sharedCompressedDocumentFileCache, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Monolog\Logger $logger);
```
-
-
-
Parameters:
-
-
-
-
-
-
Throws:
-
-
-
-
-
-
-
-
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$io | [\Symfony\Component\Console\Style\OutputStyle](https://github.com/symfony/console/blob/master/Style/OutputStyle.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
+$parser | [\BumbleDocGen\Core\Parser\ProjectParser](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/ProjectParser.php) | - |
+$parserHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ParserHelper.php) | - |
+$renderer | [\BumbleDocGen\Core\Renderer\Renderer](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Renderer.php) | - |
+$generationErrorsHandler | [\BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Logger/Handler/GenerationErrorsHandler.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$progressBarFactory | [\BumbleDocGen\Console\ProgressBar\ProgressBarFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/ProgressBar/ProgressBarFactory.php) | - |
+$diContainer | [\DI\Container](https://github.com/PHP-DI/PHP-DI/blob/master/src/Container.php) | - |
+$sharedCompressedDocumentFileCache | [\BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/SharedCompressedDocumentFileCache.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
+
+---
+
+
# `addDocBlocks` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L116)
```php
public function addDocBlocks(\BumbleDocGen\AI\ProviderInterface $aiProvider): void;
```
+Generate missing docBlocks with LLM for project class methods that are available for documentation
-
Generate missing docBlocks with LLM for project class methods that are available for documentation
-
-
Parameters:
+***Parameters:***
-
+| Name | Type | Description |
+|:-|:-|:-|
+$aiProvider | [\BumbleDocGen\AI\ProviderInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/AI/ProviderInterface.php) | - |
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `addPlugin` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L85)
```php
public function addPlugin(\BumbleDocGen\Core\Plugin\PluginInterface|string $plugin): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$plugin | [\BumbleDocGen\Core\Plugin\PluginInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginInterface.php) \| [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `generate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L287)
```php
public function generate(): void;
```
+Generates documentation using configuration
-
Generates documentation using configuration
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
+---
+
# `generateReadmeTemplate` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L200)
```php
public function generateReadmeTemplate(\BumbleDocGen\AI\ProviderInterface $aiProvider): void;
```
+Creates a `README.md` template filled with basic information using LLM
-
Creates a `README.md` template filled with basic information using LLM
-
-
Parameters:
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getConfiguration` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L534)
```php
public function getConfiguration(): \BumbleDocGen\Core\Configuration\Configuration;
```
+***Return value:*** [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Configuration\Configuration
-
-
-
-
-
-
-
-
+
# `getConfigurationKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L431)
```php
public function getConfigurationKey(string $key): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- - |
-
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `getConfigurationKeys` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L419)
```php
public function getConfigurationKeys(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
-- #
- parseAndGetRootEntityCollectionsGroup
- | source code
-
-
+
# `parseAndGetRootEntityCollectionsGroup` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L100)
```php
public function parseAndGetRootEntityCollectionsGroup(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup
-
-
-
Throws:
-
-
-
-
-
-
-
-
+
# `serve` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L340)
```php
public function serve(callable|null $afterPreparation = null, callable|null $afterDocChanged = null, int $timeout = 1000000): void;
```
+Serve documentation
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$afterPreparation | [callable](https://www.php.net/manual/en/language.types.callable.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$afterDocChanged | [callable](https://www.php.net/manual/en/language.types.callable.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+$timeout | [int](https://www.php.net/manual/en/language.types.integer.php) | - |
+
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Serve documentation
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $afterPreparation |
- callable | null |
- - |
-
-
- $afterDocChanged |
- callable | null |
- - |
-
-
- $timeout |
- int |
- - |
-
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
+---
diff --git a/docs/tech/classes/DocumentedEntityWrapper.md b/docs/tech/classes/DocumentedEntityWrapper.md
index fa9c1245..55647a15 100644
--- a/docs/tech/classes/DocumentedEntityWrapper.md
+++ b/docs/tech/classes/DocumentedEntityWrapper.md
@@ -1,300 +1,128 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+DocumentedEntityWrapper
+---
+# [DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L14) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
final class DocumentedEntityWrapper
```
+Wrapper for the entity that was requested for documentation
-Wrapper for the entity that was requested for documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getDocRender
-
--
- getDocUrl
- - Get the relative path to the document to be generated
--
- getDocumentTransformableEntity
- - Get entity that is allowed to be documented
--
- getEntityName
-
--
- getFileName
- - The name of the file to be generated
--
- getKey
- - Get document key
--
- getParentDocFilePath
-
--
- setParentDocFilePath
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getDocRender](#mgetdocrender)
+1. [getDocUrl](#mgetdocurl) - Get the relative path to the document to be generated
+1. [getDocumentTransformableEntity](#mgetdocumenttransformableentity) - Get entity that is allowed to be documented
+1. [getEntityName](#mgetentityname)
+1. [getFileName](#mgetfilename) - The name of the file to be generated
+1. [getKey](#mgetkey) - Get document key
+1. [getParentDocFilePath](#mgetparentdocfilepath)
+1. [setParentDocFilePath](#msetparentdocfilepath)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface $documentTransformableEntity, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, string $parentDocFilePath);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$documentTransformableEntity | [\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentTransformableEntityInterface.php) | An entity that is allowed to be documented |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$parentDocFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | The file in which the documentation of the entity was requested |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getDocRender` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L27)
```php
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/EntityDocRenderer/EntityDocRendererInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface
-
-
-
-
-
-
-
-
+
# `getDocUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L88)
```php
public function getDocUrl(): string;
```
+Get the relative path to the document to be generated
-
Get the relative path to the document to be generated
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDocumentTransformableEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L80)
```php
public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface;
```
+Get entity that is allowed to be documented
-
Get entity that is allowed to be documented
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentTransformableEntityInterface.php)
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface
-
-
-
-
-
-
-
+---
+
# `getEntityName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L40)
```php
public function getEntityName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getFileName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L72)
```php
public function getFileName(): string;
```
+The name of the file to be generated
-
The name of the file to be generated
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getKey` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L35)
```php
public function getKey(): string;
```
+Get document key
-
Get document key
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getParentDocFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L96)
```php
public function getParentDocFilePath(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `setParentDocFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php#L101)
```php
public function setParentDocFilePath(string $parentDocFilePath): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parentDocFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $parentDocFilePath |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/DocumentedEntityWrappersCollection.md b/docs/tech/classes/DocumentedEntityWrappersCollection.md
index e592e977..7740c323 100644
--- a/docs/tech/classes/DocumentedEntityWrappersCollection.md
+++ b/docs/tech/classes/DocumentedEntityWrappersCollection.md
@@ -1,12 +1,11 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+DocumentedEntityWrappersCollection
+---
+# [DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L14) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
@@ -14,203 +13,72 @@ namespace BumbleDocGen\Core\Renderer\Context;
final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \Countable
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [count](#mcount)
+1. [createAndAddDocumentedEntityWrapper](#mcreateandadddocumentedentitywrapper)
+1. [getDocumentedEntitiesRelations](#mgetdocumentedentitiesrelations)
+1. [getIterator](#mgetiterator)
+## Methods details:
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- count
-
--
- createAndAddDocumentedEntityWrapper
-
--
- getDocumentedEntitiesRelations
-
--
- getIterator
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L21)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$localObjectCache | [\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Cache/LocalCache/LocalObjectCache.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `count` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L76)
```php
public function count(): int;
```
+***Return value:*** [int](https://www.php.net/manual/en/language.types.integer.php)
+---
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
-
-
-
-
+
# `createAndAddDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L42)
```php
public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | - |
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
Throws:
-
-
-
-
-
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
-
+---
+
# `getDocumentedEntitiesRelations` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L71)
```php
public function getDocumentedEntitiesRelations(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getIterator` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php#L29)
```php
public function getIterator(): \Generator;
```
+***Return value:*** [\Generator](https://www.php.net/manual/en/language.generators.overview.php)
-
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
-
+---
diff --git a/docs/tech/classes/DrawDocumentationMenu.md b/docs/tech/classes/DrawDocumentationMenu.md
index fa98e83c..749a7e02 100644
--- a/docs/tech/classes/DrawDocumentationMenu.md
+++ b/docs/tech/classes/DrawDocumentationMenu.md
@@ -1,54 +1,39 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+DrawDocumentationMenu
+---
+# [DrawDocumentationMenu](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L32) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class DrawDocumentationMenu implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Generate documentation menu in MD format. To generate the menu, the start page is taken,
+and all links with this page are recursively collected for it, after which the html menu is created.
-Generate documentation menu in HTML format. To generate the menu, the start page is taken,
-and all links with this page are recursively collected for it, after which the html menu is created.
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](GetDocumentedEntityUrl_2.md)
+***Examples of using:***
```php
{{ drawDocumentationMenu() }} - The menu contains links to all documents
-
```
-
```php
{{ drawDocumentationMenu('/render/index.md') }} - The menu contains links to all child documents from the /render/index.md file (for example /render/test/index.md)
-
```
-
```php
{{ drawDocumentationMenu(_self) }} - The menu contains links to all child documents from the file where this function was called
-
```
-
```php
{{ drawDocumentationMenu(_self, 2) }} - The menu contains links to all child documents from the file where this function was called, but no more than 2 in depth
-
```
-
-
Settings:
@@ -58,188 +43,66 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L34)
```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$dependencyFactory | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyFactory.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L69)
```php
-public function __invoke(string|null $startPageKey = null, int|null $maxDeep = null): string;
+public function __invoke(array $context, string|null $startPageKey = null, int|null $maxDeep = null): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$startPageKey | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Relative path to the page from which the menu will be generated (only child pages will be taken into account).
+ By default, the main documentation page (readme.md) is used. |
+$maxDeep | [int](https://www.php.net/manual/en/language.types.integer.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Maximum parsing depth of documented links starting from the current page.
+ By default, this restriction is disabled. |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $startPageKey |
- string | null |
- Relative path to the page from which the menu will be generated (only child pages will be taken into account).
- By default, the main documentation page (readme.md) is used. |
-
-
- $maxDeep |
- int | null |
- Maximum parsing depth of documented links starting from the current page.
- By default, this restriction is disabled. |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L42)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php#L47)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/DrawDocumentedEntityLink.md b/docs/tech/classes/DrawDocumentedEntityLink.md
index ea1f469a..aee5bb41 100644
--- a/docs/tech/classes/DrawDocumentedEntityLink.md
+++ b/docs/tech/classes/DrawDocumentedEntityLink.md
@@ -1,42 +1,32 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+DrawDocumentedEntityLink
+---
+# [DrawDocumentedEntityLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L21) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class DrawDocumentedEntityLink implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Creates an entity link by object
-Creates an entity link by object
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ drawDocumentedEntityLink($entity, 'getFunctions()') }}
-
```
-
```php
{{ drawDocumentedEntityLink($entity) }}
-
```
-
```php
{{ drawDocumentedEntityLink($entity, '', false) }}
-
```
-
-
Settings:
@@ -46,176 +36,62 @@ final class DrawDocumentedEntityLink implements \BumbleDocGen\Core\Renderer\Twig
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L23)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L51)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $cursor = '', bool $useShortName = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $cursor = '', bool $useShortName = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | The entity for which we want to get the link |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Reference to an element inside an entity, for example, the name of a function/constant/property |
+$useShortName | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Use the full or short entity name in the link |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $entity |
- \BumbleDocGen\Core\Parser\Entity\RootEntityInterface |
- The entity for which we want to get the link |
-
-
- $cursor |
- string |
- Reference to an element inside an entity, for example, the name of a function/constant/property |
-
-
- $useShortName |
- bool |
- Use the full or short entity name in the link |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L27)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php#L32)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/DrawPageBreadcrumbs.md b/docs/tech/classes/DrawPageBreadcrumbs.md
new file mode 100644
index 00000000..c5d9929f
--- /dev/null
+++ b/docs/tech/classes/DrawPageBreadcrumbs.md
@@ -0,0 +1,88 @@
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+DrawPageBreadcrumbs
+
+---
+
+
+# [DrawPageBreadcrumbs](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L25) class:
+
+```php
+namespace BumbleDocGen\Core\Renderer\Twig\Function;
+
+final class DrawPageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
+```
+Function to generate breadcrumbs on the page
+
+
+Settings:
+
+
+
+ Function name: |
+ drawPageBreadcrumbs |
+
+
+
+## Initialization methods
+
+1. [__construct](#m-construct)
+## Methods
+
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+
+## Methods details:
+
+# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L27)
+```php
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment $breadcrumbsTwig, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$breadcrumbsTwig | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsTwigEnvironment.php) | - |
+$rendererContext | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$dependencyFactory | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyFactory.php) | - |
+
+---
+
+# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L61)
+```php
+public function __invoke(array $context, string|null $customPageTitle = null): string;
+```
+
+***Parameters:***
+
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$customPageTitle | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | Custom title of the current page |
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L36)
+```php
+public static function getName(): string;
+```
+
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+
+---
+
+# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php#L41)
+```php
+public static function getOptions(): array;
+```
+
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+
+---
diff --git a/docs/tech/classes/EntityDocUnifiedPlacePlugin.md b/docs/tech/classes/EntityDocUnifiedPlacePlugin.md
index f382d939..3828c709 100644
--- a/docs/tech/classes/EntityDocUnifiedPlacePlugin.md
+++ b/docs/tech/classes/EntityDocUnifiedPlacePlugin.md
@@ -1,193 +1,97 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+EntityDocUnifiedPlacePlugin
+---
+# [EntityDocUnifiedPlacePlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php#L18) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\EntityDocUnifiedPlace;
final class EntityDocUnifiedPlacePlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-This plugin changes the algorithm for saving entity documents. The standard system stores each file
+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.
-
-
-
-
-
+in a separate directory structure, so they are not duplicated.
+## Initialization methods
-Methods:
-
-
--
- getSubscribedEvents
-
--
- onCreateDocumentedEntityWrapper
-
--
- onGetProjectTemplatesDirs
-
--
- onGetTemplatePathByRelativeDocPath
-
-
-
-
-Constants:
-
-
+1. [__construct](#m-construct)
+## Methods
+1. [getSubscribedEvents](#mgetsubscribedevents)
+1. [onCreateDocumentedEntityWrapper](#moncreatedocumentedentitywrapper)
+1. [onGetProjectTemplatesDirs](#mongetprojecttemplatesdirs)
+1. [onGetTemplatePathByRelativeDocPath](#mongettemplatepathbyrelativedocpath)
+## Methods details:
+# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php#L23)
+```php
+public function __construct(\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings);
+```
-Method details:
+***Parameters:***
-
+| Name | Type | Description |
+|:-|:-|:-|
+$phpHandlerSettings | [\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/PhpHandlerSettings.php) | - |
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php#L29)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `onCreateDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php#L38)
```php
public function onCreateDocumentedEntityWrapper(\BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnCreateDocumentedEntityWrapper.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
-
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
+---
+
# `onGetProjectTemplatesDirs` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php#L54)
```php
public function onGetProjectTemplatesDirs(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetProjectTemplatesDirs $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetProjectTemplatesDirs](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetProjectTemplatesDirs.php) | - |
-
Parameters:
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `onGetTemplatePathByRelativeDocPath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php#L45)
```php
public function onGetTemplatePathByRelativeDocPath(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/FileGetContents.md b/docs/tech/classes/FileGetContents.md
index 2a0337f8..506deff5 100644
--- a/docs/tech/classes/FileGetContents.md
+++ b/docs/tech/classes/FileGetContents.md
@@ -1,43 +1,32 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+FileGetContents
+---
+# [FileGetContents](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L17) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class FileGetContents implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Displaying the content of a file or web resource
-Displaying the content of a file or web resource
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [https://www.php.net/manual/en/function.file-get-contents.php](https://www.php.net/manual/en/function.file-get-contents.php)
+***Examples of using:***
```php
{{ fileGetContents('https://www.php.net/manual/en/function.file-get-contents.php') }}
-
```
-
```php
{{ fileGetContents('%templates_dir%/../config.yaml') }}
-
```
-
-
Settings:
@@ -47,154 +36,60 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L19)
```php
public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$parameterBag | [\BumbleDocGen\Core\Configuration\ConfigurationParameterBag](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/ConfigurationParameterBag.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L41)
```php
public function __invoke(string $resourceName): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$resourceName | [string](https://www.php.net/manual/en/language.types.string.php) | Resource name, url or path to the resource.
+ The path can contain shortcodes with parameters from the configuration (%param_name%) |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $resourceName |
- string |
- Resource name, url or path to the resource.
- The path can contain shortcodes with parameters from the configuration (%param_name%) |
-
-
-
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L23)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/FileGetContents.php#L28)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/FixStrSize.md b/docs/tech/classes/FixStrSize.md
index 4592ad8c..94c955b2 100644
--- a/docs/tech/classes/FixStrSize.md
+++ b/docs/tech/classes/FixStrSize.md
@@ -1,22 +1,19 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+FixStrSize
+---
+# [FixStrSize](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class FixStrSize implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-The filter pads the string with the specified characters on the right to the specified size
-
-
+The filter pads the string with the specified characters on the right to the specified size
Settings:
@@ -32,119 +29,45 @@ final class FixStrSize implements \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L20)
```php
public function __invoke(string $text, int $size, string $symbol = ' '): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$size | [int](https://www.php.net/manual/en/language.types.integer.php) | Required string size |
+$symbol | [string](https://www.php.net/manual/en/language.types.string.php) | The character to be used to complete the string |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $size |
- int |
- Required string size |
-
-
- $symbol |
- string |
- The character to be used to complete the string |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L31)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/FixStrSize.php#L36)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/GenerateCommand.md b/docs/tech/classes/GenerateCommand.md
index a4a8406b..121dde01 100644
--- a/docs/tech/classes/GenerateCommand.md
+++ b/docs/tech/classes/GenerateCommand.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+GenerateCommand
+---
+# [GenerateCommand](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/GenerateCommand.php#L18) class:
```php
namespace BumbleDocGen\Console\Command;
@@ -14,66 +14,23 @@ namespace BumbleDocGen\Console\Command;
final class GenerateCommand extends \BumbleDocGen\Console\Command\BaseCommand
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods details:
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/BaseCommand.php#L21)
```php
// Implemented in BumbleDocGen\Console\Command\BaseCommand
public function __construct(string $name = null);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
-
-
-
+---
diff --git a/docs/tech/classes/GeneratePageBreadcrumbs.md b/docs/tech/classes/GeneratePageBreadcrumbs.md
deleted file mode 100644
index 9eab4df2..00000000
--- a/docs/tech/classes/GeneratePageBreadcrumbs.md
+++ /dev/null
@@ -1,224 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Function;
-
-final class GeneratePageBreadcrumbs implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
-```
-
-Function to generate breadcrumbs on the page
-
-
-
-
-Settings:
-
-
-
- Function name: |
- generatePageBreadcrumbs |
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory);
-```
-
-
-
-
Parameters:
-
-
-
-
-
-
-
-
-
-
-
-```php
-public function __invoke(string $currentPageTitle, string $templatePath, bool $skipFirstTemplatePage = true): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentPageTitle |
- string |
- Title of the current page |
-
-
- $templatePath |
- string |
- Path to the template from which the breadcrumbs will be generated |
-
-
- $skipFirstTemplatePage |
- bool |
- If set to true, the page from which parsing starts will not participate in the formation of breadcrumbs
- This option is useful when working with the _self value in a template, as it returns the full path to the
- current template, and the reference to it in breadcrumbs should not be clickable. |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/classes/GenerateReadMeTemplateCommand.md b/docs/tech/classes/GenerateReadMeTemplateCommand.md
index 590d8ba4..f59e25e8 100644
--- a/docs/tech/classes/GenerateReadMeTemplateCommand.md
+++ b/docs/tech/classes/GenerateReadMeTemplateCommand.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+GenerateReadMeTemplateCommand
+---
+# [GenerateReadMeTemplateCommand](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/AI/Console/GenerateReadMeTemplateCommand.php#L17) class:
```php
namespace BumbleDocGen\AI\Console;
@@ -14,78 +14,27 @@ namespace BumbleDocGen\AI\Console;
final class GenerateReadMeTemplateCommand extends \BumbleDocGen\Console\Command\BaseCommand
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Traits:
+1. [BumbleDocGen\AI\Traits\SharedCommandLogicTrait](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/AI/Traits/SharedCommandLogicTrait.php)
+## Methods details:
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-Traits:
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/BaseCommand.php#L21)
```php
// Implemented in BumbleDocGen\Console\Command\BaseCommand
public function __construct(string $name = null);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
-
-
-
+---
diff --git a/docs/tech/classes/GetDocumentationPageUrl.md b/docs/tech/classes/GetDocumentationPageUrl.md
index 54a9df97..df1596fb 100644
--- a/docs/tech/classes/GetDocumentationPageUrl.md
+++ b/docs/tech/classes/GetDocumentationPageUrl.md
@@ -1,47 +1,35 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+GetDocumentationPageUrl
+---
+# [GetDocumentationPageUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L21) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentationPageUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Creates an entity link by object
-Creates an entity link by object
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ getDocumentationPageUrl('Page name') }}
-
```
-
```php
{{ getDocumentationPageUrl('/someDir/someTemplate.md.twig') }}
-
```
-
```php
{{ getDocumentationPageUrl('/docs/someDir/someDocFile.md') }}
-
```
-
```php
{{ getDocumentationPageUrl('readme.md') }}
-
```
-
-
Settings:
@@ -51,179 +39,61 @@ final class GetDocumentationPageUrl implements \BumbleDocGen\Core\Renderer\Twig\
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L25)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L53)
```php
public function __invoke(string $key): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$key | [string](https://www.php.net/manual/en/language.types.string.php) | The key by which to look up the URL of the page.
+ Can be the title of a page, a path to a template, or a generated document |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $key |
- string |
- The key by which to look up the URL of the page.
- Can be the title of a page, a path to a template, or a generated document |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L31)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php#L36)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/GetDocumentedEntityUrl.md b/docs/tech/classes/GetDocumentedEntityUrl.md
index 7dffaff6..a3e009c7 100644
--- a/docs/tech/classes/GetDocumentedEntityUrl.md
+++ b/docs/tech/classes/GetDocumentedEntityUrl.md
@@ -1,56 +1,41 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+GetDocumentedEntityUrl
+---
+# [GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L40) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentedEntityUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
+the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
-the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](DocumentedEntityWrapper.md)
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](DocumentedEntityWrappersCollection.md)
+- [\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection](RendererContext.md#pentitywrapperscollection)
+***Examples of using:***
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', 'getFunctions') }}
The function returns a reference to the documented entity, anchored to the getFunctions method
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension') }}
The function returns a reference to the documented entity MainExtension
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', '', false) }}
The function returns a link to the file MainExtension
-
```
-
-
Settings:
@@ -60,204 +45,87 @@ The function returns a link to the file MainExtension
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+1. [process](#mprocess)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L44)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$documentedEntityWrappersCollection | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L81)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | The full name of the entity for which the URL will be retrieved.
+ If the entity is not found, the DEFAULT_URL value will be returned. |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Cursor on the page of the documented entity (for example, the name of a method or property) |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $entityName |
- string |
- The full name of the entity for which the URL will be retrieved.
- If the entity is not found, the DEFAULT_URL value will be returned. |
-
-
- $cursor |
- string |
- Cursor on the page of the documented entity (for example, the name of a method or property) |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L52)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L57)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `process` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L102)
+```php
+public function process(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true, string|null $callingTemplate = null): string;
+```
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+$callingTemplate | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/classes/GetDocumentedEntityUrl_2.md b/docs/tech/classes/GetDocumentedEntityUrl_2.md
index d7de8173..692dbc5a 100644
--- a/docs/tech/classes/GetDocumentedEntityUrl_2.md
+++ b/docs/tech/classes/GetDocumentedEntityUrl_2.md
@@ -1,56 +1,40 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+GetDocumentedEntityUrl
+---
+# [GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L40) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class GetDocumentedEntityUrl implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
+the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
-the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
-
-See:
-
-
-
-Examples of using:
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](DocumentedEntityWrapper.md)
+- [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](DocumentedEntityWrappersCollection.md)
+- [\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection](RendererContext.md#pentitywrapperscollection)
+***Examples of using:***
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', 'getFunctions') }}
The function returns a reference to the documented entity, anchored to the getFunctions method
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension') }}
The function returns a reference to the documented entity MainExtension
-
```
-
```php
{{ getDocumentedEntityUrl(phpEntities, '\\BumbleDocGen\\Renderer\\Twig\\MainExtension', '', false) }}
The function returns a link to the file MainExtension
-
```
-
-
Settings:
@@ -60,204 +44,87 @@ The function returns a link to the file MainExtension
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+1. [process](#mprocess)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-Constants:
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L44)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$documentedEntityWrappersCollection | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrappersCollection.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L81)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | The full name of the entity for which the URL will be retrieved.
+ If the entity is not found, the DEFAULT_URL value will be returned. |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | Cursor on the page of the documented entity (for example, the name of a method or property) |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $entityName |
- string |
- The full name of the entity for which the URL will be retrieved.
- If the entity is not found, the DEFAULT_URL value will be returned. |
-
-
- $cursor |
- string |
- Cursor on the page of the documented entity (for example, the name of a method or property) |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
-
-
Throws:
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L52)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L57)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
+
+
# `process` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php#L102)
+```php
+public function process(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true, string|null $callingTemplate = null): string;
+```
-
Parameters: not specified
+***Parameters:***
-
Return value: array
+| Name | Type | Description |
+|:-|:-|:-|
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$entityName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$cursor | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | - |
+$callingTemplate | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
+---
diff --git a/docs/tech/classes/Implode.md b/docs/tech/classes/Implode.md
index 5e6494a8..ca7058ea 100644
--- a/docs/tech/classes/Implode.md
+++ b/docs/tech/classes/Implode.md
@@ -1,28 +1,22 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+Implode
+---
+# [Implode](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class Implode implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+Join array elements with a string
-Join array elements with a string
-
-See:
-
-
-
+***Links:***
+- [https://www.php.net/manual/en/function.implode.php](https://www.php.net/manual/en/function.implode.php)
Settings:
@@ -38,114 +32,44 @@ See:
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L17)
```php
public function __invoke(array $elements, string $separator = ', '): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$elements | [array](https://www.php.net/manual/en/language.types.array.php) | The array to implode |
+$separator | [string](https://www.php.net/manual/en/language.types.string.php) | Element separator in result string |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $elements |
- array |
- The array to implode |
-
-
- $separator |
- string |
- Element separator in result string |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L22)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Implode.php#L27)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/InvalidConfigurationParameterException.md b/docs/tech/classes/InvalidConfigurationParameterException.md
deleted file mode 100644
index cc00b206..00000000
--- a/docs/tech/classes/InvalidConfigurationParameterException.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception
-```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/classes/LastPageCommitter.md b/docs/tech/classes/LastPageCommitter.md
index 94264247..97c2d9ff 100644
--- a/docs/tech/classes/LastPageCommitter.md
+++ b/docs/tech/classes/LastPageCommitter.md
@@ -1,151 +1,64 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+LastPageCommitter
+---
+# [LastPageCommitter](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L15) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\LastPageCommitter;
final class LastPageCommitter implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
+Plugin for adding a block with information about the last commit and date of page update to the generated document
-Plugin for adding a block with information about the last commit and date of page update to the generated document
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L17)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $context, \BumbleDocGen\Core\Configuration\Configuration $configuration);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [\BumbleDocGen\Core\Renderer\Context\RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L30)
```php
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php#L23)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/LoadPluginsContent.md b/docs/tech/classes/LoadPluginsContent.md
index a40c7e0d..0214f70e 100644
--- a/docs/tech/classes/LoadPluginsContent.md
+++ b/docs/tech/classes/LoadPluginsContent.md
@@ -1,32 +1,26 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+LoadPluginsContent
-
+---
-
-
-:warning: Is internal
+# [LoadPluginsContent](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L18) class:
+⚠️ Internal
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class LoadPluginsContent implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Process entity template blocks with plugins. The method returns the content processed by plugins.
-Process entity template blocks with plugins. The method returns the content processed by plugins.
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ loadPluginsContent('some text', entity, constant('BumbleDocGen\\Plugin\\BaseTemplatePluginInterface::BLOCK_AFTER_HEADER')) }}
-
```
-
-
Settings:
@@ -36,163 +30,61 @@ final class LoadPluginsContent implements \BumbleDocGen\Core\Renderer\Twig\Funct
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L42)
```php
public function __invoke(string $content, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $blockType): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | Content to be processed by plugins |
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | The entity for which we process the content block |
+$blockType | [string](https://www.php.net/manual/en/language.types.string.php) | Content block type. @see BaseTemplatePluginInterface::BLOCK_* |
-
Parameters:
-
-
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L24)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L29)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/LoadPluginsContent_2.md b/docs/tech/classes/LoadPluginsContent_2.md
index 8ac665ef..8f652906 100644
--- a/docs/tech/classes/LoadPluginsContent_2.md
+++ b/docs/tech/classes/LoadPluginsContent_2.md
@@ -1,32 +1,25 @@
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+LoadPluginsContent
-
+---
-
-
-:warning: Is internal
+# [LoadPluginsContent](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L18) class:
+⚠️ Internal
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class LoadPluginsContent implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Process entity template blocks with plugins. The method returns the content processed by plugins.
-Process entity template blocks with plugins. The method returns the content processed by plugins.
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ loadPluginsContent('some text', entity, constant('BumbleDocGen\\Plugin\\BaseTemplatePluginInterface::BLOCK_AFTER_HEADER')) }}
-
```
-
-
Settings:
@@ -36,163 +29,61 @@ final class LoadPluginsContent implements \BumbleDocGen\Core\Renderer\Twig\Funct
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginEventDispatcher | [\BumbleDocGen\Core\Plugin\PluginEventDispatcher](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginEventDispatcher.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L42)
```php
public function __invoke(string $content, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $blockType): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$content | [string](https://www.php.net/manual/en/language.types.string.php) | Content to be processed by plugins |
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | The entity for which we process the content block |
+$blockType | [string](https://www.php.net/manual/en/language.types.string.php) | Content block type. @see BaseTemplatePluginInterface::BLOCK_* |
-
Parameters:
-
-
-
-
Return value: string
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
-
-
-
-
-
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L24)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/LoadPluginsContent.php#L29)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/OnAddClassEntityToCollection.md b/docs/tech/classes/OnAddClassEntityToCollection.md
index 9af8d0dd..eb156778 100644
--- a/docs/tech/classes/OnAddClassEntityToCollection.md
+++ b/docs/tech/classes/OnAddClassEntityToCollection.md
@@ -1,158 +1,68 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnAddClassEntityToCollection
+---
+# [OnAddClassEntityToCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/OnAddClassEntityToCollection.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Parser;
final class OnAddClassEntityToCollection extends \Symfony\Contracts\EventDispatcher\Event implements \BumbleDocGen\Core\Plugin\OnlySingleExecutionEvent
```
+Called when each class entity is added to the entity collection
-Called when each class entity is added to the entity collection
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
+## Initialization methods
-Methods:
+1. [__construct](#m-construct)
+## Methods
-
--
- getClassEntityCollection
-
--
- getRootEntity
-
--
- getUniqueExecutionId
-
-
+1. [getClassEntityCollection](#mgetclassentitycollection)
+1. [getRootEntity](#mgetrootentity)
+1. [getUniqueExecutionId](#mgetuniqueexecutionid)
+## Methods details:
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/OnAddClassEntityToCollection.php#L17)
```php
public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection $entitiesCollection);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$classEntity | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php) | - |
+$entitiesCollection | [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getClassEntityCollection` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/OnAddClassEntityToCollection.php#L28)
```php
public function getClassEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/PhpEntitiesCollection.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PhpEntitiesCollection
-
-
-
-
-
-
-
-
+
# `getRootEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/OnAddClassEntityToCollection.php#L33)
```php
public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
```
+***Return value:*** [\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/Entity/ClassLikeEntity.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity
-
-
-
-
-
-
-
-
+
# `getUniqueExecutionId` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Parser/OnAddClassEntityToCollection.php#L23)
```php
public function getUniqueExecutionId(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
+---
diff --git a/docs/tech/classes/OnCheckIsEntityCanBeLoaded.md b/docs/tech/classes/OnCheckIsEntityCanBeLoaded.md
index a4728fee..1182a5eb 100644
--- a/docs/tech/classes/OnCheckIsEntityCanBeLoaded.md
+++ b/docs/tech/classes/OnCheckIsEntityCanBeLoaded.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnCheckIsEntityCanBeLoaded
+---
+# [OnCheckIsEntityCanBeLoaded](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php#L10) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity;
@@ -14,159 +14,67 @@ namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity;
final class OnCheckIsEntityCanBeLoaded extends \Symfony\Contracts\EventDispatcher\Event
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [disableEntityLoading](#mdisableentityloading)
+1. [getEntity](#mgetentity)
+1. [isEntityCanBeLoaded](#misentitycanbeloaded)
+## Properties:
+1. [isEntityCanBeLoaded](#pisentitycanbeloaded)
+## Constants:
+## Properties details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- disableEntityLoading
-
--
- getEntity
-
--
- isEntityCanBeLoaded
-
-
-
-
-
-Properties:
-
-
- -
- isEntityCanBeLoaded
-
-
-
-
-Property details:
-
-
-* #
- $isEntityCanBeLoaded
- **|** source code
+# `isEntityCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php#L12)
```php
public bool $isEntityCanBeLoaded;
```
+---
+## Methods details:
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php#L14)
```php
public function __construct(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `disableEntityLoading` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php#L23)
```php
public function disableEntityLoading(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `getEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php#L18)
```php
public function getEntity(): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
+---
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
-
-
-
-
+
# `isEntityCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php#L28)
```php
public function isEntityCanBeLoaded(): bool;
```
+***Return value:*** [bool](https://www.php.net/manual/en/language.types.boolean.php)
-
-
Parameters: not specified
-
-
Return value: bool
-
-
-
-
+---
diff --git a/docs/tech/classes/OnCreateDocumentedEntityWrapper.md b/docs/tech/classes/OnCreateDocumentedEntityWrapper.md
index 7e9dea4d..01d0c71e 100644
--- a/docs/tech/classes/OnCreateDocumentedEntityWrapper.md
+++ b/docs/tech/classes/OnCreateDocumentedEntityWrapper.md
@@ -1,105 +1,47 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnCreateDocumentedEntityWrapper
+---
+# [OnCreateDocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnCreateDocumentedEntityWrapper.php#L13) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnCreateDocumentedEntityWrapper extends \Symfony\Contracts\EventDispatcher\Event
```
+The event occurs when an entity is added to the list for documentation
-The event occurs when an entity is added to the list for documentation
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- getDocumentedEntityWrapper
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [getDocumentedEntityWrapper](#mgetdocumentedentitywrapper)
+## Methods details:
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnCreateDocumentedEntityWrapper.php#L15)
```php
public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $documentedEntityWrapper);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$documentedEntityWrapper | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnCreateDocumentedEntityWrapper.php#L20)
```php
public function getDocumentedEntityWrapper(): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Return value:*** [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
-
+---
diff --git a/docs/tech/classes/OnGetProjectTemplatesDirs.md b/docs/tech/classes/OnGetProjectTemplatesDirs.md
index db1c1275..43c189ae 100644
--- a/docs/tech/classes/OnGetProjectTemplatesDirs.md
+++ b/docs/tech/classes/OnGetProjectTemplatesDirs.md
@@ -1,146 +1,63 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnGetProjectTemplatesDirs
+---
+# [OnGetProjectTemplatesDirs](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetProjectTemplatesDirs.php#L12) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnGetProjectTemplatesDirs extends \Symfony\Contracts\EventDispatcher\Event
```
+This event occurs when all directories containing document templates are retrieved
-This event occurs when all directories containing document templates are retrieved
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- addTemplatesDir
-
--
- getTemplatesDirs
-
-
-
-
-
-
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [addTemplatesDir](#maddtemplatesdir)
+1. [getTemplatesDirs](#mgettemplatesdirs)
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetProjectTemplatesDirs.php#L14)
```php
public function __construct(array $templatesDirs);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$templatesDirs | [array](https://www.php.net/manual/en/language.types.array.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $templatesDirs |
- array |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `addTemplatesDir` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetProjectTemplatesDirs.php#L23)
```php
public function addTemplatesDir(string $dirName): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$dirName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $dirName |
- string |
- - |
-
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `getTemplatesDirs` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetProjectTemplatesDirs.php#L18)
```php
public function getTemplatesDirs(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md b/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md
index 0ee6845a..28f696c5 100644
--- a/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md
+++ b/docs/tech/classes/OnGetTemplatePathByRelativeDocPath.md
@@ -1,170 +1,73 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnGetTemplatePathByRelativeDocPath
+---
+# [OnGetTemplatePathByRelativeDocPath](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php#L12) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnGetTemplatePathByRelativeDocPath extends \Symfony\Contracts\EventDispatcher\Event
```
+The event occurs when the path to the template file is obtained relative to the path to the document
-The event occurs when the path to the template file is obtained relative to the path to the document
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
+## Initialization methods
-Methods:
+1. [__construct](#m-construct)
+## Methods
-
--
- getCustomTemplateFilePath
-
--
- getTemplateName
-
--
- setCustomTemplateFilePath
-
-
+1. [getCustomTemplateFilePath](#mgetcustomtemplatefilepath)
+1. [getTemplateName](#mgettemplatename)
+1. [setCustomTemplateFilePath](#msetcustomtemplatefilepath)
+## Methods details:
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php#L16)
```php
public function __construct(string $templateName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$templateName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $templateName |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getCustomTemplateFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php#L30)
```php
public function getCustomTemplateFilePath(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
+
# `getTemplateName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php#L20)
```php
public function getTemplateName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `setCustomTemplateFilePath` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGetTemplatePathByRelativeDocPath.php#L25)
```php
public function setCustomTemplateFilePath(string|null $customTemplateFilePath): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$customTemplateFilePath | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $customTemplateFilePath |
- string | null |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/OnGettingResourceLink.md b/docs/tech/classes/OnGettingResourceLink.md
index a11b45e7..fe1ea5cf 100644
--- a/docs/tech/classes/OnGettingResourceLink.md
+++ b/docs/tech/classes/OnGettingResourceLink.md
@@ -1,170 +1,73 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnGettingResourceLink
+---
+# [OnGettingResourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php#L12) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Event
```
+Event occurs when a reference to an entity (resource) is received
-Event occurs when a reference to an entity (resource) is received
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
+## Initialization methods
-Methods:
+1. [__construct](#m-construct)
+## Methods
-
--
- getResourceName
-
--
- getResourceUrl
-
--
- setResourceUrl
-
-
+1. [getResourceName](#mgetresourcename)
+1. [getResourceUrl](#mgetresourceurl)
+1. [setResourceUrl](#msetresourceurl)
+## Methods details:
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php#L16)
```php
public function __construct(string $resourceName);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$resourceName | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $resourceName |
- string |
- - |
-
-
-
-
-
-
-
-
-
-
-
+---
+
# `getResourceName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php#L20)
```php
public function getResourceName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getResourceUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php#L25)
```php
public function getResourceUrl(): null|string;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: null |
string
-
-
-
-
-
-
-
-
+
# `setResourceUrl` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php#L30)
```php
public function setResourceUrl(string|null $resourceUrl): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$resourceUrl | [string](https://www.php.net/manual/en/language.types.string.php) \| [null](https://www.php.net/manual/en/language.types.null.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $resourceUrl |
- string | null |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/OnLoadEntityDocPluginContent.md b/docs/tech/classes/OnLoadEntityDocPluginContent.md
index 9cb57f4d..e656607f 100644
--- a/docs/tech/classes/OnLoadEntityDocPluginContent.md
+++ b/docs/tech/classes/OnLoadEntityDocPluginContent.md
@@ -1,234 +1,98 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+OnLoadEntityDocPluginContent
+---
+# [OnLoadEntityDocPluginContent](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L16) class:
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class OnLoadEntityDocPluginContent extends \Symfony\Contracts\EventDispatcher\Event
```
+Called when entity documentation is generated (plugin content loading)
-Called when entity documentation is generated (plugin content loading)
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Twig\Function\LoadPluginsContent](LoadPluginsContent_2.md)
-Methods:
+## Initialization methods
-
--
- addBlockContentPluginResult
-
--
- getBlockContent
-
--
- getBlockContentPluginResults
-
--
- getBlockType
-
--
- getEntity
-
-
+1. [__construct](#m-construct)
+## Methods
+1. [addBlockContentPluginResult](#maddblockcontentpluginresult)
+1. [getBlockContent](#mgetblockcontent)
+1. [getBlockContentPluginResults](#mgetblockcontentpluginresults)
+1. [getBlockType](#mgetblocktype)
+1. [getEntity](#mgetentity)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L20)
```php
public function __construct(string $blockContent, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $blockType);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$blockContent | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+$entity | [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php) | - |
+$blockType | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `addBlockContentPluginResult` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L42)
```php
public function addBlockContentPluginResult(string $pluginResult): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$pluginResult | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $pluginResult |
- string |
- - |
-
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
-
-
+---
+
# `getBlockContent` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L32)
```php
public function getBlockContent(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getBlockContentPluginResults` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L47)
```php
public function getBlockContentPluginResults(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `getBlockType` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L37)
```php
public function getBlockType(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getEntity` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnLoadEntityDocPluginContent.php#L27)
```php
public function getEntity(): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
```
+***Return value:*** [\BumbleDocGen\Core\Parser\Entity\RootEntityInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityInterface.php)
-
-
Parameters: not specified
-
-
Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface
-
-
-
-
+---
diff --git a/docs/tech/classes/PageHtmlLinkerPlugin.md b/docs/tech/classes/PageHtmlLinkerPlugin.md
index c1d8724f..861e0c28 100644
--- a/docs/tech/classes/PageHtmlLinkerPlugin.md
+++ b/docs/tech/classes/PageHtmlLinkerPlugin.md
@@ -1,210 +1,94 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+PageHtmlLinkerPlugin
+---
+# [PageHtmlLinkerPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageHtmlLinkerPlugin.php#L29) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
final class PageHtmlLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-Adds URLs to empty links in HTML format;
+Adds URLs to empty links in HTML format;
Links may contain:
1) Short entity name
2) Full entity name
3) Relative link to the entity file from the root directory of the project
4) Page title ( title )
5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation
-
-
-Examples of using:
+ 6) Relative reference to the entity document from the root directory of the documentation
+***Examples of using:***
```php
Existent page name => Existent page name
-
```
-
```php
\Namespace\ClassName => Custom title
-
```
-
```php
\Namespace\ClassName => \Namespace\ClassName
-
```
-
```php
Non-existent page name => Non-existent page name
-
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+## Methods details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PageHtmlLinkerPlugin_2.md b/docs/tech/classes/PageHtmlLinkerPlugin_2.md
index a9550bf2..916ce440 100644
--- a/docs/tech/classes/PageHtmlLinkerPlugin_2.md
+++ b/docs/tech/classes/PageHtmlLinkerPlugin_2.md
@@ -1,210 +1,94 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Configuration](../01_configuration.md) **/**
+PageHtmlLinkerPlugin
+---
+# [PageHtmlLinkerPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageHtmlLinkerPlugin.php#L29) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
final class PageHtmlLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-Adds URLs to empty links in HTML format;
+Adds URLs to empty links in HTML format;
Links may contain:
1) Short entity name
2) Full entity name
3) Relative link to the entity file from the root directory of the project
4) Page title ( title )
5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation
-
-
-Examples of using:
+ 6) Relative reference to the entity document from the root directory of the documentation
+***Examples of using:***
```php
Existent page name => Existent page name
-
```
-
```php
\Namespace\ClassName => Custom title
-
```
-
```php
\Namespace\ClassName => \Namespace\ClassName
-
```
-
```php
Non-existent page name => Non-existent page name
-
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+## Methods details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PageLinkerPlugin.md b/docs/tech/classes/PageLinkerPlugin.md
index 94884832..a34ead81 100644
--- a/docs/tech/classes/PageLinkerPlugin.md
+++ b/docs/tech/classes/PageLinkerPlugin.md
@@ -1,210 +1,94 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+PageLinkerPlugin
+---
+# [PageLinkerPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageLinkerPlugin.php#L29) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
final class PageLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-Adds URLs to empty links in HTML format;
+Adds URLs to empty links in MD format;
Links may contain:
1) Short entity name
2) Full entity name
3) Relative link to the entity file from the root directory of the project
4) Page title ( title )
5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation
-
-
-Examples of using:
+ 6) Relative reference to the entity document from the root directory of the documentation
+***Examples of using:***
```php
-[a]Existent page name[/a] => Existent page name
-
+[a]Existent page name[/a] => [Existent page name](/docs/some/page/targetPage.md)
```
-
```php
-[a x-title="Custom title"]\Namespace\ClassName[/a] => Custom title
-
+[a x-title="Custom title"]\Namespace\ClassName[/a] => [Custom title](/docs/some/page/ClassName.md)
```
-
```php
-[a]\Namespace\ClassName[/a] => \Namespace\ClassName
-
+[a]\Namespace\ClassName[/a] => [\Namespace\ClassName](/docs/some/page/ClassName.md)
```
-
```php
[a]Non-existent page name[/a] => Non-existent page name
-
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+## Methods details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PageLinkerPlugin_2.md b/docs/tech/classes/PageLinkerPlugin_2.md
index 6806c5aa..1bd6b8fb 100644
--- a/docs/tech/classes/PageLinkerPlugin_2.md
+++ b/docs/tech/classes/PageLinkerPlugin_2.md
@@ -1,210 +1,94 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Configuration](../01_configuration.md) **/**
+PageLinkerPlugin
+---
+# [PageLinkerPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageLinkerPlugin.php#L29) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
final class PageLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-Adds URLs to empty links in HTML format;
+Adds URLs to empty links in MD format;
Links may contain:
1) Short entity name
2) Full entity name
3) Relative link to the entity file from the root directory of the project
4) Page title ( title )
5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation
-
-
-Examples of using:
+ 6) Relative reference to the entity document from the root directory of the documentation
+***Examples of using:***
```php
-[a]Existent page name[/a] => Existent page name
-
+[a]Existent page name[/a] => [Existent page name](/docs/some/page/targetPage.md)
```
-
```php
-[a x-title="Custom title"]\Namespace\ClassName[/a] => Custom title
-
+[a x-title="Custom title"]\Namespace\ClassName[/a] => [Custom title](/docs/some/page/ClassName.md)
```
-
```php
-[a]\Namespace\ClassName[/a] => \Namespace\ClassName
-
+[a]\Namespace\ClassName[/a] => [\Namespace\ClassName](/docs/some/page/ClassName.md)
```
-
```php
[a]Non-existent page name[/a] => Non-existent page name
-
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+## Methods details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PageRstLinkerPlugin.md b/docs/tech/classes/PageRstLinkerPlugin.md
index db29a47c..c97fee75 100644
--- a/docs/tech/classes/PageRstLinkerPlugin.md
+++ b/docs/tech/classes/PageRstLinkerPlugin.md
@@ -1,200 +1,88 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+PageRstLinkerPlugin
+---
+# [PageRstLinkerPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageRstLinkerPlugin.php#L23) class:
```php
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
final class PageRstLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
-
-Adds URLs to empty links in rst format;
+Adds URLs to empty links in rst format;
Links may contain:
1) Short entity name
2) Full entity name
3) Relative link to the entity file from the root directory of the project
4) Page title ( title )
5) Template key ( BreadcrumbsHelper::getTemplateLinkKey() )
- 6) Relative reference to the entity document from the root directory of the documentation
-
-
-Examples of using:
+ 6) Relative reference to the entity document from the root directory of the documentation
+***Examples of using:***
```php
`Existent page name`_ => `Existent page name `_
-
```
-
```php
`Non-existent page name`_ => Non-existent page name
-
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [beforeCreatingDocFile](#mbeforecreatingdocfile)
+1. [getSubscribedEvents](#mgetsubscribedevents)
+## Methods details:
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- beforeCreatingDocFile
-
--
- getSubscribedEvents
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
-public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Configuration\Configuration $configuration, \Psr\Log\LoggerInterface $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$breadcrumbsHelper | [\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php) | - |
+$rootEntityCollectionsGroup | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollectionsGroup.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$configuration | [\BumbleDocGen\Core\Configuration\Configuration](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php) | - |
+$logger | [\Psr\Log\LoggerInterface](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `beforeCreatingDocFile` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/BeforeCreatingDocFile.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
-
-
Throws:
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61)
```php
// Implemented in BumbleDocGen\Core\Plugin\CorePlugin\PageLinker\BasePageLinker
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PhpDocumentorStubberPlugin.md b/docs/tech/classes/PhpDocumentorStubberPlugin.md
index 41917541..7e9cb95f 100644
--- a/docs/tech/classes/PhpDocumentorStubberPlugin.md
+++ b/docs/tech/classes/PhpDocumentorStubberPlugin.md
@@ -1,143 +1,63 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+PhpDocumentorStubberPlugin
+---
+# [PhpDocumentorStubberPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpDocumentorStubberPlugin.php#L23) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\BasePhpStubber;
final class PhpDocumentorStubberPlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
+Adding links to the documentation of PHP classes in the \phpDocumentor namespace
-Adding links to the documentation of PHP classes in the \phpDocumentor namespace
-
-
-
-
-
-
-
-Methods:
-
-
--
- getSubscribedEvents
-
--
- onCheckIsEntityCanBeLoaded
-
--
- onGettingResourceLink
-
-
-
-
-
-
-
+## Methods
+1. [getSubscribedEvents](#mgetsubscribedevents)
+1. [onCheckIsEntityCanBeLoaded](#moncheckisentitycanbeloaded)
+1. [onGettingResourceLink](#mongettingresourcelink)
-Method details:
-
-
-
-
+## Methods details:
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpDocumentorStubberPlugin.php#L25)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `onCheckIsEntityCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpDocumentorStubberPlugin.php#L73)
```php
public function onCheckIsEntityCanBeLoaded(\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php) | - |
-
Parameters:
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `onGettingResourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpDocumentorStubberPlugin.php#L33)
```php
public function onGettingResourceLink(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/PhpUnitStubberPlugin.md b/docs/tech/classes/PhpUnitStubberPlugin.md
index baaea168..d6e034c1 100644
--- a/docs/tech/classes/PhpUnitStubberPlugin.md
+++ b/docs/tech/classes/PhpUnitStubberPlugin.md
@@ -1,143 +1,63 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+PhpUnitStubberPlugin
+---
+# [PhpUnitStubberPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpUnitStubberPlugin.php#L14) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\BasePhpStubber;
final class PhpUnitStubberPlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
+Adding links to the documentation of PHP classes in the \PHPUnit namespace
-Adding links to the documentation of PHP classes in the \PHPUnit namespace
-
-
-
-
-
-
-
-Methods:
-
-
--
- getSubscribedEvents
-
--
- onCheckIsEntityCanBeLoaded
-
--
- onGettingResourceLink
-
-
-
-
-
-
-
+## Methods
+1. [getSubscribedEvents](#mgetsubscribedevents)
+1. [onCheckIsEntityCanBeLoaded](#moncheckisentitycanbeloaded)
+1. [onGettingResourceLink](#mongettingresourcelink)
-Method details:
-
-
-
-
+## Methods details:
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpUnitStubberPlugin.php#L16)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `onCheckIsEntityCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpUnitStubberPlugin.php#L39)
```php
public function onCheckIsEntityCanBeLoaded(\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php) | - |
-
Parameters:
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `onGettingResourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/BasePhpStubber/PhpUnitStubberPlugin.php#L24)
```php
public function onGettingResourceLink(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/PluginInterface.md b/docs/tech/classes/PluginInterface.md
index f940bb33..d9b22ef4 100644
--- a/docs/tech/classes/PluginInterface.md
+++ b/docs/tech/classes/PluginInterface.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+PluginInterface
+---
+# [PluginInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/PluginInterface.php#L9) class:
```php
namespace BumbleDocGen\Core\Plugin;
@@ -15,17 +15,3 @@ interface PluginInterface extends \Symfony\Component\EventDispatcher\EventSubscr
```
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tech/classes/PregMatch.md b/docs/tech/classes/PregMatch.md
index 18159999..6aa8dde1 100644
--- a/docs/tech/classes/PregMatch.md
+++ b/docs/tech/classes/PregMatch.md
@@ -1,28 +1,22 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+PregMatch
+---
+# [PregMatch](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class PregMatch implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+Perform a regular expression match
-Perform a regular expression match
-
-See:
-
-
-
+***Links:***
+- [https://www.php.net/manual/en/function.preg-match.php](https://www.php.net/manual/en/function.preg-match.php)
Settings:
@@ -38,114 +32,44 @@ See:
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L20)
```php
public function __invoke(string $text, string $pattern): array;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$pattern | [string](https://www.php.net/manual/en/language.types.string.php) | The pattern to search for, as a string. |
-
Parameters:
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $pattern |
- string |
- The pattern to search for, as a string. |
-
-
-
-
-
Return value: array
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L26)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PregMatch.php#L31)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PrepareSourceLink.md b/docs/tech/classes/PrepareSourceLink.md
index 9e834b34..3df3c6a4 100644
--- a/docs/tech/classes/PrepareSourceLink.md
+++ b/docs/tech/classes/PrepareSourceLink.md
@@ -1,22 +1,19 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+PrepareSourceLink
+---
+# [PrepareSourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class PrepareSourceLink implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-The filter converts the string into an anchor that can be used in a GitHub document link
-
-
+The filter converts the string into an anchor that can be used in a GitHub document link
Settings:
@@ -32,109 +29,43 @@ final class PrepareSourceLink implements \BumbleDocGen\Core\Renderer\Twig\Filter
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L17)
```php
public function __invoke(string $text): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L22)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/PrepareSourceLink.php#L27)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/PrintEntityCollectionAsList.md b/docs/tech/classes/PrintEntityCollectionAsList.md
index 46347db8..11fc4a54 100644
--- a/docs/tech/classes/PrintEntityCollectionAsList.md
+++ b/docs/tech/classes/PrintEntityCollectionAsList.md
@@ -1,39 +1,31 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+PrintEntityCollectionAsList
+---
+# [PrintEntityCollectionAsList](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L22) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Function;
final class PrintEntityCollectionAsList implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface
```
+Outputting entity data as MD list
-Outputting entity data as HTML list
-
-
-Examples of using:
-
+***Examples of using:***
```php
{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['ScriptFramework\\ScriptInterface', 'ScriptFramework\\TestScriptInterface'])) }}
The function will output a list of PHP classes that match the ScriptFramework\ScriptInterface and ScriptFramework\TestScriptInterface interfaces
-
```
-
```php
{{ printEntityCollectionAsList(phpEntities) }}
The function will list all documented PHP classes
-
```
-
-
Settings:
@@ -43,175 +35,64 @@ The function will list all documented PHP classes
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L24)
```php
-public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction);
+public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Renderer\Twig\Filter\RemoveLineBrakes $removeLineBrakes);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$removeLineBrakes | [\BumbleDocGen\Core\Renderer\Twig\Filter\RemoveLineBrakes](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L51)
```php
-public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $type = 'ul', bool $skipDescription = false, bool $useFullName = false): string;
+public function __invoke(array $context, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, string $type = 'ul', bool $skipDescription = false, bool $useFullName = false): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | Processed entity collection |
+$type | [string](https://www.php.net/manual/en/language.types.string.php) | List tag type (
/) |
+$skipDescription | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Don't print description of this entities |
+$useFullName | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Use the full name of the entity in the list |
-Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- Processed entity collection |
-
-
- $type |
- string |
- List tag type ( |
-
-
- $skipDescription |
- bool |
- Don't print description of this entities |
-
-
- $useFullName |
- bool |
- Use the full name of the entity in the list |
-
-
-
-
-Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-Throws:
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L30)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php#L35)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/Quotemeta.md b/docs/tech/classes/Quotemeta.md
index 34599b99..dd60d16e 100644
--- a/docs/tech/classes/Quotemeta.md
+++ b/docs/tech/classes/Quotemeta.md
@@ -1,28 +1,22 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+Quotemeta
+---
+# [Quotemeta](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class Quotemeta implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+Quote meta characters
-Quote meta characters
-
-See:
-
-
-
+***Links:***
+- [https://www.php.net/manual/en/function.quotemeta.php](https://www.php.net/manual/en/function.quotemeta.php)
Settings:
@@ -38,109 +32,43 @@ See:
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L15)
```php
public function __invoke(string $text): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L20)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/Quotemeta.php#L25)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/RemoveLineBrakes.md b/docs/tech/classes/RemoveLineBrakes.md
index d7191502..9fd06ecf 100644
--- a/docs/tech/classes/RemoveLineBrakes.md
+++ b/docs/tech/classes/RemoveLineBrakes.md
@@ -1,22 +1,19 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+RemoveLineBrakes
+---
+# [RemoveLineBrakes](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L10) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class RemoveLineBrakes implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
-
-The filter replaces all line breaks with a space
-
-
+The filter replaces all line breaks with a space
Settings:
@@ -32,109 +29,43 @@ final class RemoveLineBrakes implements \BumbleDocGen\Core\Renderer\Twig\Filter\
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
+## Methods details:
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L15)
```php
public function __invoke(string $text): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
-
Parameters:
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L20)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/RemoveLineBrakes.php#L25)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/RendererContext.md b/docs/tech/classes/RendererContext.md
index b0f4450e..eb0b22cc 100644
--- a/docs/tech/classes/RendererContext.md
+++ b/docs/tech/classes/RendererContext.md
@@ -1,256 +1,110 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+RendererContext
+---
+# [RendererContext](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L12) class:
```php
namespace BumbleDocGen\Core\Renderer\Context;
final class RendererContext
```
+Document rendering context
-Document rendering context
-
-
-
-
-
-
-
-Methods:
-
-
--
- addDependency
-
--
- clearDependencies
-
--
- getCurrentDocumentedEntityWrapper
-
--
- getCurrentTemplateFilePatch
- - Getting the path to the template file that is currently being worked on
--
- getDependencies
-
--
- setCurrentDocumentedEntityWrapper
-
--
- setCurrentTemplateFilePatch
- - Saving the path to the template file that is currently being worked on in the context
-
-
-
+## Methods
+1. [addDependency](#madddependency)
+1. [clearDependencies](#mcleardependencies)
+1. [getCurrentDocumentedEntityWrapper](#mgetcurrentdocumentedentitywrapper)
+1. [getCurrentTemplateFilePatch](#mgetcurrenttemplatefilepatch) - Getting the path to the template file that is currently being worked on
+1. [getDependencies](#mgetdependencies)
+1. [setCurrentDocumentedEntityWrapper](#msetcurrentdocumentedentitywrapper)
+1. [setCurrentTemplateFilePatch](#msetcurrenttemplatefilepatch) - Saving the path to the template file that is currently being worked on in the context
+## Methods details:
-
-
-Method details:
-
-
-
-
-
+
# `addDependency` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L53)
```php
public function addDependency(\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface $dependency): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$dependency | [\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/Dependency/RendererDependencyInterface.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `clearDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L48)
```php
public function clearDependencies(): void;
```
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
+
# `getCurrentDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L43)
```php
public function getCurrentDocumentedEntityWrapper(): null|\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
```
+***Return value:*** [null](https://www.php.net/manual/en/language.types.null.php) | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php)
+---
-
Parameters: not specified
-
-
Return value: null |
\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
-
-
-
-
-
+
# `getCurrentTemplateFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L32)
```php
public function getCurrentTemplateFilePatch(): string;
```
+Getting the path to the template file that is currently being worked on
-
Getting the path to the template file that is currently being worked on
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
+---
+
# `getDependencies` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L58)
```php
public function getDependencies(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `setCurrentDocumentedEntityWrapper` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L37)
```php
public function setCurrentDocumentedEntityWrapper(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $currentDocumentedEntityWrapper): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$currentDocumentedEntityWrapper | [\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/DocumentedEntityWrapper.php) | - |
-
Parameters:
-
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
Return value: void
-
-
-
-
-
-
-
+---
+
# `setCurrentTemplateFilePatch` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Context/RendererContext.php#L24)
```php
public function setCurrentTemplateFilePatch(string $currentTemplateFilePath): void;
```
+Saving the path to the template file that is currently being worked on in the context
-
Saving the path to the template file that is currently being worked on in the context
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $currentTemplateFilePath |
- string |
- - |
-
-
-
+***Parameters:***
-
Return value: void
+| Name | Type | Description |
+|:-|:-|:-|
+$currentTemplateFilePath | [string](https://www.php.net/manual/en/language.types.string.php) | - |
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/ServeCommand.md b/docs/tech/classes/ServeCommand.md
index 690c7964..3001479c 100644
--- a/docs/tech/classes/ServeCommand.md
+++ b/docs/tech/classes/ServeCommand.md
@@ -1,12 +1,12 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Console app](../05_console.md) **/**
+ServeCommand
+---
+# [ServeCommand](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/ServeCommand.php#L20) class:
```php
namespace BumbleDocGen\Console\Command;
@@ -14,66 +14,23 @@ namespace BumbleDocGen\Console\Command;
final class ServeCommand extends \BumbleDocGen\Console\Command\BaseCommand
```
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods details:
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/BaseCommand.php#L21)
```php
// Implemented in BumbleDocGen\Console\Command\BaseCommand
public function __construct(string $name = null);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$name | [string](https://www.php.net/manual/en/language.types.string.php) | - |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $name |
- string |
- - |
-
-
-
-
-
-
-
-
+---
diff --git a/docs/tech/classes/StrTypeToUrl.md b/docs/tech/classes/StrTypeToUrl.md
index d4f1dc39..e89eda10 100644
--- a/docs/tech/classes/StrTypeToUrl.md
+++ b/docs/tech/classes/StrTypeToUrl.md
@@ -1,28 +1,22 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[About configuration](../01_configuration.md) **/**
+StrTypeToUrl
+---
+# [StrTypeToUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L18) class:
```php
namespace BumbleDocGen\Core\Renderer\Twig\Filter;
final class StrTypeToUrl implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
```
+The filter converts the string with the data type into a link to the documented entity, if possible.
-The filter converts the string with the data type into a link to the documented entity, if possible.
-
-See:
-
-
-
+***Links:***
+- [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](GetDocumentedEntityUrl_2.md)
Settings:
@@ -38,178 +32,66 @@ See:
+## Initialization methods
+1. [__construct](#m-construct)
+## Methods
+1. [__invoke](#m-invoke)
+1. [getName](#mgetname)
+1. [getOptions](#mgetoptions)
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
+## Methods details:
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L20)
```php
public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \Monolog\Logger $logger);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$rendererHelper | [\BumbleDocGen\Core\Renderer\RendererHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/RendererHelper.php) | - |
+$getDocumentedEntityUrlFunction | [\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php) | - |
+$logger | [\Monolog\Logger](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `__invoke` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L51)
```php
-public function __invoke(string $text, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, bool $useShortLinkVersion = false, bool $createDocument = false): string;
+public function __invoke(array $context, string $text, \BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, bool $useShortLinkVersion = false, bool $createDocument = false, string $separator = ' | '): string;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$context | [array](https://www.php.net/manual/en/language.types.array.php) | - |
+$text | [string](https://www.php.net/manual/en/language.types.string.php) | Processed text |
+$rootEntityCollection | [\BumbleDocGen\Core\Parser\Entity\RootEntityCollection](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Parser/Entity/RootEntityCollection.php) | - |
+$useShortLinkVersion | [bool](https://www.php.net/manual/en/language.types.boolean.php) | Shorten or not the link name. When shortening, only the shortName of the entity will be shown |
+$createDocument | [bool](https://www.php.net/manual/en/language.types.boolean.php) | If true, creates an entity document. Otherwise, just gives a reference to the entity code |
+$separator | [string](https://www.php.net/manual/en/language.types.string.php) | Separator between types |
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $rootEntityCollection |
- \BumbleDocGen\Core\Parser\Entity\RootEntityCollection |
- - |
-
-
- $useShortLinkVersion |
- bool |
- Shorten or not the link name. When shortening, only the shortName of the entity will be shown |
-
-
- $createDocument |
- bool |
- If true, creates an entity document. Otherwise, just gives a reference to the entity code |
-
-
-
-
-
Return value: string
-
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
-
-
-
-
-
+---
+
# `getName` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L27)
```php
public static function getName(): string;
```
+***Return value:*** [string](https://www.php.net/manual/en/language.types.string.php)
+---
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
+
# `getOptions` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php#L32)
```php
public static function getOptions(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
+---
diff --git a/docs/tech/classes/StubberPlugin.md b/docs/tech/classes/StubberPlugin.md
index 17e5683d..c43cdd56 100644
--- a/docs/tech/classes/StubberPlugin.md
+++ b/docs/tech/classes/StubberPlugin.md
@@ -1,201 +1,79 @@
-
-
-
-
+[BumbleDocGen](../../README.md) **/**
+[Technical description of the project](../readme.md) **/**
+[Plugin system](../04_pluginSystem.md) **/**
+StubberPlugin
+---
+# [StubberPlugin](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/ComposerPackagesStubber/StubberPlugin.php#L15) class:
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\ComposerPackagesStubber;
final class StubberPlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
```
+The plugin allows you to automatically provide links to github repositories for documented classes from libraries included in composer
-The plugin allows you to automatically provide links to github repositories for documented classes from libraries included in composer
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
-
-
-
-Methods:
+## Initialization methods
-
--
- getSubscribedEvents
-
--
- onCheckIsEntityCanBeLoaded
-
--
- onGettingResourceLink
-
-
+1. [__construct](#m-construct)
+## Methods
+1. [getSubscribedEvents](#mgetsubscribedevents)
+1. [onCheckIsEntityCanBeLoaded](#moncheckisentitycanbeloaded)
+1. [onGettingResourceLink](#mongettingresourcelink)
+## Methods details:
-
-
-
-
-Method details:
-
-
-
-
-
+
# `__construct` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/ComposerPackagesStubber/StubberPlugin.php#L19)
```php
public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper $composerHelper);
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$composerHelper | [\BumbleDocGen\LanguageHandler\Php\Parser\ComposerHelper](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Parser/ComposerHelper.php) | - |
-
Parameters:
-
-
-
-
-
-
-
-
-
-
+---
+
# `getSubscribedEvents` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/ComposerPackagesStubber/StubberPlugin.php#L23)
```php
public static function getSubscribedEvents(): array;
```
+***Return value:*** [array](https://www.php.net/manual/en/language.types.array.php)
+---
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
+
# `onCheckIsEntityCanBeLoaded` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/ComposerPackagesStubber/StubberPlugin.php#L60)
```php
public function onCheckIsEntityCanBeLoaded(\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/Event/Entity/OnCheckIsEntityCanBeLoaded.php) | - |
-
Parameters:
-
-
-
-
Return value: void
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
+---
-
Throws:
-
-
-
-
-
-
-
-
+
# `onGettingResourceLink` **|** [source code](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/LanguageHandler/Php/Plugin/CorePlugin/ComposerPackagesStubber/StubberPlugin.php#L34)
```php
public function onGettingResourceLink(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink $event): void;
```
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+$event | [\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink](https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/Event/Renderer/OnGettingResourceLink.php) | - |
-
Parameters:
-
-
-
-
Return value: void
-
-
-
Throws:
-
+***Return value:*** [void](https://www.php.net/manual/en/language.types.void.php)
-
-
+---
diff --git a/docs/tech/classes/TextToCodeBlock.md b/docs/tech/classes/TextToCodeBlock.md
deleted file mode 100644
index 195e471b..00000000
--- a/docs/tech/classes/TextToCodeBlock.md
+++ /dev/null
@@ -1,145 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Filter;
-
-final class TextToCodeBlock implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
-```
-
-Convert text to code block
-
-
-
-
-Settings:
-
-
-
- name |
- value |
-
-
- Filter name: |
- textToCodeBlock |
-
-
-
-
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __invoke(string $text, string $codeBlockType): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- Processed text |
-
-
- $codeBlockType |
- string |
- Code block type (e.g. php or console ) |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/classes/TextToHeading.md b/docs/tech/classes/TextToHeading.md
deleted file mode 100644
index 285a8efc..00000000
--- a/docs/tech/classes/TextToHeading.md
+++ /dev/null
@@ -1,145 +0,0 @@
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Twig\Filter;
-
-final class TextToHeading implements \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFilterInterface
-```
-
-Convert text to html header
-
-
-
-
-Settings:
-
-
-
- name |
- value |
-
-
- Filter name: |
- textToHeading |
-
-
-
-
-
-
-
-Methods:
-
-
--
- __invoke
-
--
- getName
-
--
- getOptions
-
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function __invoke(string $text, string $headingType): string;
-```
-
-
-
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
-
- $text |
- string |
- - |
-
-
- $headingType |
- string |
- Choose heading type: H1, H2, H3 |
-
-
-
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getName(): string;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-
-```php
-public static function getOptions(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
diff --git a/docs/tech/readme.md b/docs/tech/readme.md
index 48729cc9..6102614a 100644
--- a/docs/tech/readme.md
+++ b/docs/tech/readme.md
@@ -1,14 +1,25 @@
-
+[BumbleDocGen](../README.md) **/**
+Technical description of the project
-
+---
+
+
+# Technical description of the project
This documentation generator is a library that allows you to create handwritten documentation with dynamic blocks that are loaded from the project code or other places.
-
+## Documentation sections
+
-
+- [Configuration](01_configuration.md)
+- [Parser](02_parser/readme.md)
+- [Renderer](03_renderer/readme.md)
+- [Plugin system](04_pluginSystem.md)
+- [Console app](05_console.md)
+- [Debug documents](06_debugging.md)
+- [Output formats](07_outputFormat.md)
-
+## How it works
```mermaid
graph TD;
@@ -28,20 +39,18 @@ This documentation generator is a library that allows you to create handwritten
To start the documentation generation process, you need to call the following command:
```php
- (new DocGeneratorFactory())->create($configFile)->generate()
+(new DocGeneratorFactory())->create($configFile)->generate();
```
-
or
```php
- (new DocGeneratorFactory())->createByConfigArray($configArray)->generate()
+(new DocGeneratorFactory())->createByConfigArray($configArray)->generate();
```
-
After that, the process of parsing the project code according to the configuration will start, and then filling the templates with data and saving the finished result as final documents.
-
-
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Dec 23 23:00:37 2023 +0300
Page content update date: Mon Jan 15 2024
Made with
Bumble Documentation Generator
\ No newline at end of file
+---
+
+**Last page committer:** fshcherbanich <filipp.shcherbanich@team.bumble.com>
**Last modified date:** Sat Jan 20 00:42:48 2024 +0300
**Page content update date:** Fri Jan 19 2024
Made with [Bumble Documentation Generator](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)
\ No newline at end of file
diff --git a/selfdoc/Twig/CustomFunction/GetConfigParametersDescription.php b/selfdoc/Twig/CustomFunction/GetConfigParametersDescription.php
index d1abaf4b..07deaa2f 100644
--- a/selfdoc/Twig/CustomFunction/GetConfigParametersDescription.php
+++ b/selfdoc/Twig/CustomFunction/GetConfigParametersDescription.php
@@ -13,7 +13,7 @@
final class GetConfigParametersDescription implements CustomFunctionInterface
{
- public function __construct(private ConfigurationParameterBag $parameterBag)
+ public function __construct(private readonly ConfigurationParameterBag $parameterBag)
{
}
@@ -30,11 +30,12 @@ public function __invoke(RootEntityCollection $rootEntityCollection, string $con
$shortName = array_reverse(explode('\\', $defaultValue['class']))[0];
$tmpDefaultValue = "[a x-title='{$shortName}']{$defaultValue['class']}[/a]";
} else {
- $tmpDefaultValue = "\n\n";
+ $tmpDefaultValue = "";
foreach ($defaultValue as $v) {
$shortName = array_reverse(explode('\\', $v['class']))[0];
- $tmpDefaultValue .= "- [a x-title='{$shortName}']{$v['class']}[/a]\n\n";
+ $tmpDefaultValue .= "- [a x-title='{$shortName}']{$v['class']}[/a]
";
}
+ $tmpDefaultValue .= "
";
}
$defaultValue = $tmpDefaultValue;
} else {
@@ -42,7 +43,7 @@ public function __invoke(RootEntityCollection $rootEntityCollection, string $con
}
$params[] = [
'key' => $name,
- 'type' => str_replace([' ', '(', ')'], '', $matches[4] ?? ''),
+ 'type' => str_replace([' ', '(', ')', '|'], ['','','',' \\| '], $matches[4] ?? ''),
'description' => trim($matches[6] ?? ''),
'defaultValue' => $defaultValue,
];
diff --git a/selfdoc/Twig/CustomFunction/PrintClassCollectionAsGroupedTable.php b/selfdoc/Twig/CustomFunction/PrintClassCollectionAsGroupedTable.php
index 165ee93c..54e6d0f4 100644
--- a/selfdoc/Twig/CustomFunction/PrintClassCollectionAsGroupedTable.php
+++ b/selfdoc/Twig/CustomFunction/PrintClassCollectionAsGroupedTable.php
@@ -13,7 +13,7 @@
final class PrintClassCollectionAsGroupedTable implements CustomFunctionInterface
{
- public function __construct(private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction)
+ public function __construct(private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction)
{
}
@@ -26,6 +26,7 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
@@ -34,25 +35,23 @@ public static function getOptions(): array
* @throws DependencyException
* @throws InvalidConfigurationParameterException
*/
- public function __invoke(PhpEntitiesCollection $rootEntityCollection): string
+ public function __invoke(array $context, PhpEntitiesCollection $rootEntityCollection): string
{
$groups = $this->groupEntities($rootEntityCollection);
$getDocumentedEntityUrlFunction = $this->getDocumentedEntityUrlFunction;
- $table = "";
- $table .= "Group name | Class short name | Description |
";
+ $table = "| Group name | Class short name | Description |\n";
+ $table .= "|-|-|-|\n";
foreach ($groups as $groupKey => $entities) {
$firstEntity = array_shift($entities);
- $table .= "{$groupKey} | {$firstEntity->getShortName()} | {$firstEntity->getDescription()} |
";
+ $table .= "| **{$groupKey}** | [{$firstEntity->getShortName()}]({$getDocumentedEntityUrlFunction($context, $rootEntityCollection, $firstEntity->getName())}) | {$firstEntity->getDescription()} |\n";
foreach ($entities as $entity) {
- $table .= "{$entity->getShortName()} | {$entity->getDescription()} |
";
+ $table .= "| | [{$entity->getShortName()}]({$getDocumentedEntityUrlFunction($context, $rootEntityCollection, $entity->getName())}) | {$entity->getDescription()} |\n";
}
- $table .= " |
";
+ $table .= "| | | |\n";
}
-
- $table .= "
";
- return "";
+ return $table;
}
private function groupEntities(PhpEntitiesCollection $rootEntityCollection): array
diff --git a/selfdoc/templates/README.md.twig b/selfdoc/templates/README.md.twig
index 99921573..13d8a631 100644
--- a/selfdoc/templates/README.md.twig
+++ b/selfdoc/templates/README.md.twig
@@ -1,36 +1,38 @@
---
title: BumbleDocGen
---
-{{ "BumbleDocGen: A Documentation Generator for PHP projects 🐝" | textToHeading('H1') }}
+# BumbleDocGen: A Documentation Generator for PHP projects 🐝
-BumbleDocGen is a robust library for generating and maintaining documentation next to the code of large and small PHP projects.
+**BumbleDocGen** is a robust library for generating and maintaining documentation next to the code of large and small PHP projects.
This tool analyzes your codebase and produces a comprehensive set of Markdown documents, including descriptions of classes, methods, and properties alongside navigable internal links.
-{{ "Installation" | textToHeading('H2') }}
+## Installation
Add the BumbleDocGen to the `composer.json` file of your project using the following command:
-{{ 'composer require bumble-tech/bumble-doc-gen' | textToCodeBlock('console') }}
+```console
+composer require bumble-tech/bumble-doc-gen
+```
-{{ "Detailed technical description" | textToHeading('H2') }}
+## Detailed technical description
💡 Please refer to the [a x-title="Description of the technical part of the project"]Technical description of the project[/a] for a detailed explanation of all the classes and methods used.
-{{ "Core Features" | textToHeading('H2') }}
+## Core Features
-- 🔍 [a x-title="Parsing"]Parser[/a]:
+1. 🔍 **[a x-title="Parsing"]Parser[/a]:**
BumbleDocGen analyzes your code and provides a convenient [a]Reflection API[/a].
-- ✍️ [a x-title="Rendering"]Renderer[/a]:
+2. ✍️ **[a x-title="Rendering"]Renderer[/a]:**
BumbleDocGen generates markdown content using templates and fills them with data obtained from parsing your code.
-- 🧠 AI tools for documentation generation:
+3. 🧠 **AI tools for documentation generation:**
BumbleDocGen allows you to use a group of AI tools to help generate project documentation.
-{{ "How to Use" | textToHeading('H2') }}
+## How to Use
-{{ "Entry points" | textToHeading('H3') }}
+### Entry points
BumbleDocGen's interface consists of mainly two classes: [a]DocGenerator[/a] and [a]DocGeneratorFactory[/a].
@@ -42,39 +44,36 @@ BumbleDocGen's interface consists of mainly two classes: [a]DocGenerator[/a] and
{{ displayClassApiMethods('\\BumbleDocGen\\DocGeneratorFactory') | addIndentFromLeft }}
-{{ "Examples of usage" | textToHeading('H3') }}
+### Examples of usage
1) Working with a library in a PHP file
+ ```php
+ require_once 'vendor/autoload.php';
-```php
-require_once 'vendor/autoload.php';
-
-use BumbleDocGen\DocGeneratorFactory;
+ use BumbleDocGen\DocGeneratorFactory;
-// Initialize the factory
-$factory = new DocGeneratorFactory();
+ // Initialize the factory
+ $factory = new DocGeneratorFactory();
-// Create a DocGenerator instance
-$docgen = $factory->create('/path/to/configuration/files');
+ // Create a DocGenerator instance
+ $docgen = $factory->create('/path/to/configuration/files');
-// or $docgen = $factory->createByConfigArray([...]);
-
-// Now call the desired operation
-$docgen->generate();
-```
+ // or $docgen = $factory->createByConfigArray([...]);
+ // Now call the desired operation
+ $docgen->generate();
+ ```
2) Working with the library through a console application
+ ```bash
+ # List of available commands
+ ./vendor/bin/bumbleDocGen list
-```bash
-# List of available commands
-./vendor/bin/bumbleDocGen list
+ # Documentation generation example
+ ./vendor/bin/bumbleDocGen generate -c
-# Documentation generation example
-./vendor/bin/bumbleDocGen generate -c
-
-# Getting detailed information about a command
-./vendor/bin/bumbleDocGen generate -h
-```
+ # Getting detailed information about a command
+ ./vendor/bin/bumbleDocGen generate -h
+ ```
------------------
@@ -82,4 +81,6 @@ $docgen->generate();
To update this documentation, run the following command:
-{{ './bin/bumbleDocGen generate' | textToCodeBlock('console') }}
+```console
+./bin/bumbleDocGen generate
+```
diff --git a/selfdoc/templates/tech/01_configuration.md.twig b/selfdoc/templates/tech/01_configuration.md.twig
index ff3ad1be..6756d82e 100644
--- a/selfdoc/templates/tech/01_configuration.md.twig
+++ b/selfdoc/templates/tech/01_configuration.md.twig
@@ -1,10 +1,10 @@
---
-title: Configuration
+title: About configuration
prevPage: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Configuration" | textToHeading('H1') }}
+# About configuration
Documentation generator configuration can be stored in special files.
They can be in different formats: yaml, json, php arrays, ini, xml
@@ -13,17 +13,20 @@ But it is not necessary to use files to store the configuration; you can also in
During the instance creation process, configuration data is loaded into [a]Configuration[/a] class, and the code works directly with it.
-{{ "Configuration file example" | textToHeading('H2') }}
+# Configuration file example
Let's look at an example of a real configuration in more detail:
-{{ fileGetContents('%WORKING_DIR%/bumble_doc_gen.yaml') | textToCodeBlock('yaml') }}
+```yaml
+{{ fileGetContents('%WORKING_DIR%/bumble_doc_gen.yaml') }}
+```
In this example, we see the real configuration of the self-documentation of this project.
**Here is an example of loading this configuration in PHP code:**
-{{ "// Single file
+```php
+// Single file
$docGenerator = (new DocGeneratorFactory())->create('config.yaml');
// Multiple files
@@ -31,9 +34,9 @@ $docGenerator = (new DocGeneratorFactory())->create('config.yaml', 'config2.yaml
// Passing configuration as an array
$docGenerator = (new DocGeneratorFactory())->createByConfigArray($configArray);
-" | textToCodeBlock('php') }}
+```
-{{ "Handling and inheritance of configuration files" | textToHeading('H2') }}
+## Handling and inheritance of configuration files
The documentation generator can work with several configuration files at once.
When processing configuration files, each subsequent file has a higher priority and overwrites the previously defined parameters, but if the parameter has not yet been defined before, it will be added.
@@ -41,23 +44,12 @@ When processing configuration files, each subsequent file has a higher priority
Each default configuration file inherits the base configuration: `BumbleDocGen/Core/Configuration/defaultConfiguration.yaml`, but the parent configuration file can be changed using the `parent_configuration` parameter.
The inheritance algorithm is as follows: scalar types can be overwritten by each subsequent configuration, while arrays are supplemented with new data instead of overwriting.
-{{ "Configuration parameters" | textToHeading('H2') }}
+## Configuration parameters
{% set parameters = getConfigParametersDescription(phpEntities, '%WORKING_DIR%/src/Core/Configuration/defaultConfiguration.yaml') %}
-
-
-
- Key |
- Type |
- Default value |
- Description |
-
+| Key | Type | Default value | Description |
+|-|-|-|-|
{% for parameter in parameters %}
-
- {{ parameter.key }} |
- {{ parameter.type }} |
- {{ parameter.defaultValue | raw }} |
- {{ parameter.description }} |
-
+| **`{{ parameter.key }}`** | {{ parameter.type }} | {{ parameter.defaultValue | raw }} | {{ parameter.description }} |
{% endfor %}
-
+
diff --git a/selfdoc/templates/tech/02_parser/entity.md.twig b/selfdoc/templates/tech/02_parser/entity.md.twig
index 90d69ba7..4aa06356 100644
--- a/selfdoc/templates/tech/02_parser/entity.md.twig
+++ b/selfdoc/templates/tech/02_parser/entity.md.twig
@@ -2,97 +2,83 @@
title: Entities and entities collections
prevPage: Parser
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Entities and entities collections" | textToHeading('H1') }}
+# Entities and entities collections
Entities are organized outcomes from parsing source code.
They help easily extract details about specific items from templates, allowing users to quickly access and display the information they need.
Entities are always handled through collections. Collections are the result of the project parsing process and are available in both documentation templates and code.
-{{ "Examples of using collections in twig templates" | textToHeading('H2') }}
+## Examples of using collections in twig templates
* Passing a collection to a function:
-{{ "{{ printEntityCollectionAsList(phpEntities) }}" | textToCodeBlock('twig') }}
+```twig
+{{ "{{ printEntityCollectionAsList(phpEntities) }}" }}
+```
* Filtering a collection and passing it to a function:
-{{ "{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['BumbleDocGen\\Core\\Parser\\Entity\\EntityInterface'])) }}" | textToCodeBlock('twig') }}
+```twig
+{{ "{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['BumbleDocGen\\Core\\Parser\\Entity\\EntityInterface'])) }}" }}
+```
* Saving a filtered collection to a variable:
-{{ "{{ {% set filteredCollection = phpEntities.getOnlyInstantiable() %} }}" | textToCodeBlock('twig') }}
+```twig
+{{ "{% set filteredCollection = phpEntities.getOnlyInstantiable() %}" }}
+```
* Using a collection in a for loop:
+```twig
{{ "{% for someClassEntity in phpEntities %}
* {{ someClassEntity.getName() }}
-{% endfor %}" | textToCodeBlock('twig') }}
+{% endfor %}" }}
+```
* Output of all methods of all found entities in `className::methodName()` format:
+```twig
{{ "{% for someClassEntity in phpEntities %}
{% for methodEntity in someClassEntity.getMethodEntitiesCollection() %}
* {{ someClassEntity.getName() }}::{{ methodEntity.getName() }}()
{% endfor %}
-{% endfor %}" | textToCodeBlock('twig') }}
+{% endfor %}" }}
+```
-{{ "Root entities collections" | textToHeading('H2') }}
+## Root entities collections
To further facilitate the handling of these entities, we utilize entity collections.
These collections not only group relevant entities together but also provide convenient methods for filtering and manipulating these entities.
The root collections ([a]RootEntityCollection[/a]), which are directly accessible in your templates, are as follows:
-
-
- Collection class |
- Name in twig template |
- PL |
- Description |
-
- {% for entitiesCollection in phpEntities
- .filterByParentClassNames(['BumbleDocGen\\Core\\Parser\\Entity\\RootEntityCollection'])
- .getOnlyInstantiable()
- %}
- {% set match = entitiesCollection.getRelativeFileName() | preg_match('/(\\/LanguageHandler\\/)([\\s\\S]*?)(?=\\/)/i') %}
-
- {{ drawDocumentedEntityLink(entitiesCollection) }} |
- {{ entitiesCollection.getMethod('getEntityCollectionName', true).getFirstReturnValue() }} |
- {{ match[2] | upper }} |
- {{ entitiesCollection.getDescription() }} |
-
- {% endfor %}
-
+| Collection class | Name in twig template | PL | Description |
+|-|-|-|-|
+{% for entitiesCollection in phpEntities
+ .filterByParentClassNames(['BumbleDocGen\\Core\\Parser\\Entity\\RootEntityCollection'])
+ .getOnlyInstantiable()
+%}
+{% set match = entitiesCollection.getRelativeFileName() | preg_match('/(\\/LanguageHandler\\/)([\\s\\S]*?)(?=\\/)/i') %}
+| {{ drawDocumentedEntityLink(entitiesCollection) }} | **{{ entitiesCollection.getMethod('getEntityCollectionName', true).getFirstReturnValue() }}** | {{ match[2] | upper }} | {{ entitiesCollection.getDescription() }} |
+{% endfor %}
-{{ "Available entities" | textToHeading('H2') }}
+## Available entities
Following is the list of available entities that are consistent with [a]EntityInterface[/a] and can be created.
These classes are a convenient wrapper for accessing data in templates:
-
-
- Entity name |
- Collection name |
- Is root |
- PL |
- Description |
-
+| Entity name | Collection name | Is root | PL | Description |
+|-|-|-|-|-|
{% for entitiesCollection in phpEntities
.filterByParentClassNames(['BumbleDocGen\\Core\\Parser\\Entity\\BaseEntityCollection'])
.getOnlyInstantiable()
%}
- {% set match = entitiesCollection.getRelativeFileName() | preg_match('/(\\/LanguageHandler\\/)([\\s\\S]*?)(?=\\/)/i') %}
- {% set entitiesClasses = findEntitiesClassesByCollectionClassName(entitiesCollection.getName()) %}
- {% for entityClass in entitiesClasses %}
-
- {{ drawDocumentedEntityLink(entityClass) }} |
- {{ drawDocumentedEntityLink(entitiesCollection) }} |
- {% if entityClass.implementsInterface('BumbleDocGen\\Core\\Parser\\Entity\\RootEntityInterface') %}yes{% else %}no{% endif %} |
- {{ match[2] | upper }} |
- {{ entityClass.getDescription() }} |
-
- {% endfor %}
+{% set match = entitiesCollection.getRelativeFileName() | preg_match('/(\\/LanguageHandler\\/)([\\s\\S]*?)(?=\\/)/i') %}
+{% set entitiesClasses = findEntitiesClassesByCollectionClassName(entitiesCollection.getName()) %}
+{% for entityClass in entitiesClasses %}
+| {{ drawDocumentedEntityLink(entityClass) }} | {{ drawDocumentedEntityLink(entitiesCollection) }} | {% if entityClass.implementsInterface('BumbleDocGen\\Core\\Parser\\Entity\\RootEntityInterface') %}yes{% else %}no{% endif %} | {{ match[2] | upper }} | {{ entityClass.getDescription() }} |
{% endfor %}
-
\ No newline at end of file
+{% endfor %}
\ No newline at end of file
diff --git a/selfdoc/templates/tech/02_parser/entityFilterCondition.md.twig b/selfdoc/templates/tech/02_parser/entityFilterCondition.md.twig
index d10019a4..adf982c1 100644
--- a/selfdoc/templates/tech/02_parser/entityFilterCondition.md.twig
+++ b/selfdoc/templates/tech/02_parser/entityFilterCondition.md.twig
@@ -2,9 +2,9 @@
title: Entity filter conditions
prevPage: Parser
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Entity filter conditions" | textToHeading('H1') }}
+# Entity filter conditions
Filters serve as a foundational mechanism within our documentation generator, dictating which segments of the source code are selected during the initial parsing phase.
These rules facilitate a strategic extraction of elements, such as classes, methods, or constants, from the underlying codebase.
@@ -13,7 +13,7 @@ This level of granularity not only streamlines the documentation process but als
All filter conditions implement the [a]ConditionInterface[/a] interface.
-{{ "Mechanism for adding entities to the collection" | textToHeading('H2') }}
+## Mechanism for adding entities to the collection
For each language handler, according to the configuration, the following scheme is applicable:
@@ -35,7 +35,7 @@ flowchart LR
The diagram shows the mechanism for adding root entities, but this also applies to the attributes of each entity,
for example, for PHP there are rules for checking the possibility of adding methods, properties and constants.
-{{ "Filter conditions configuration" | textToHeading('H2') }}
+## Filter conditions configuration
Filter conditions are configured separately for language handlers.
@@ -67,7 +67,7 @@ language_handlers:
- class: \BumbleDocGen\LanguageHandler\Php\Parser\FilterCondition\PropertyFilterCondition\OnlyFromCurrentClassCondition
```
-{{ "Available filters" | textToHeading('H2') }}
+## Available filters
{% set filterConditions = phpEntities.filterByInterfaces(['BumbleDocGen\\Core\\Parser\\FilterCondition\\ConditionInterface']).getOnlyInstantiable() %}
diff --git a/selfdoc/templates/tech/02_parser/readme.md.twig b/selfdoc/templates/tech/02_parser/readme.md.twig
index eeb8d0c6..8b7e9665 100644
--- a/selfdoc/templates/tech/02_parser/readme.md.twig
+++ b/selfdoc/templates/tech/02_parser/readme.md.twig
@@ -1,9 +1,9 @@
---
title: Parser
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Documentation parser" | textToHeading('H1') }}
+# Documentation parser
Most often, we need [a]ProjectParser[/a] in order to get a list of entities for documentation.
But this is not the only use of this tool. The result of the parser's work (a collection of entities) can be used to programmatically analyze the project and perform any operations based on this analysis.
@@ -12,19 +12,21 @@ You can also use the parser for your own purposes other than generating document
In this section, we show how the parser works and what components it consists of.
-{{ "Description of the main components of the parser" | textToHeading('H2') }}
+## Description of the main components of the parser
{{ drawDocumentationMenu(_self) }}
-{{ "Starting the parsing process" | textToHeading('H2') }}
+## Starting the parsing process
-{{ "$parser = new ProjectParser($configuration, $rootEntityCollectionsGroup);
+```php
+$parser = new ProjectParser($configuration, $rootEntityCollectionsGroup);
// Parsing the project and filling RootEntityCollectionsGroup with data
$this->parser->parse();
-$rootEntityCollectionsGroup = $this->parser->getRootEntityCollectionsGroup();" | textToCodeBlock('php') }}
+$rootEntityCollectionsGroup = $this->parser->getRootEntityCollectionsGroup();
+```
-{{ "How it works" | textToHeading('H2') }}
+## How it works
```mermaid
flowchart TD
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md.twig
index ac76af5f..6f3569a3 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassConstantReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP class constant reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP class constant reflection API" | textToHeading('H1') }}
+# PHP class constant reflection API
Class constant reflection entity class: [a]ClassConstantEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md.twig
index 0a3c253b..54f5d5d7 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassMethodReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP class method reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP class method reflection API" | textToHeading('H1') }}
+# PHP class method reflection API
Method reflection entity class: [a]MethodEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md.twig
index a82dbea3..4d87b911 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassPropertyReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP class property reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP class property reflection API" | textToHeading('H1') }}
+# PHP class property reflection API
Property reflection entity class: [a]PropertyEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md.twig
index e57df6db..81b35ce4 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpClassReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP class reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP class reflection API" | textToHeading('H1') }}
+# PHP class reflection API
PHP class reflection [a]ClassEntity[/a] inherits from [a]ClassLikeEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md.twig
index 05ee72f4..4d23d2c2 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEntitiesCollection.md.twig
@@ -2,9 +2,9 @@
title: PHP entities collection
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP entities collection" | textToHeading('H1') }}
+# PHP entities collection
**PHP entities collection API methods:**
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md.twig
index 3a062d29..a94acb1f 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpEnumReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP enum reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP enum reflection API" | textToHeading('H1') }}
+# PHP enum reflection API
PHP enum reflection [a]EnumEntity[/a] inherits from [a]ClassLikeEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md.twig
index dfe79126..f9c017a0 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpInterfaceReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP interface reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP interface reflection API" | textToHeading('H1') }}
+# PHP interface reflection API
PHP interface reflection [a]InterfaceEntity[/a] inherits from [a]ClassLikeEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md.twig
index bb8c7001..48a4ae59 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/phpTraitReflectionApi.md.twig
@@ -2,9 +2,9 @@
title: PHP trait reflection API
prevPage: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "PHP trait reflection API" | textToHeading('H1') }}
+# PHP trait reflection API
PHP trait reflection [a]TraitEntity[/a] inherits from [a]ClassLikeEntity[/a].
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/php/readme.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/php/readme.md.twig
index ff9657fa..4fdb4d6f 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/php/readme.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/php/readme.md.twig
@@ -1,14 +1,14 @@
---
title: Reflection API for PHP
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Reflection API for PHP" | textToHeading('H1') }}
+# Reflection API for PHP
The tool we implemented partially replicates the [standard PHP reflection API](https://www.php.net/manual/en/book.reflection.php), but it has some additional capabilities.
In addition, our Reflection API is available for use in every documentation template, plugin, twig function, etc. at `BumbleDocGen`.
-{{ "Class like reflections" | textToHeading('H2') }}
+## Class like reflections
Using our PHP reflection API you can get information about project entities.
Below is information about the available methods for working with each entity type:
@@ -33,7 +33,7 @@ $entityClassCodeStartLine = $classReflection->getStartLine();
// ... etc.
```
-{{ "Entities collection" | textToHeading('H2') }}
+## Entities collection
Class reflections are stored in collections. The collection is filled either before documents are generated,
if the Reflection API is used to generate documentation, or when special methods are called that, under certain conditions, fill them with the required reflections.
@@ -64,7 +64,7 @@ foreach($entitiesCollection as $classReflection) {
}
```
-{{ "Class like sub entities reflections" | textToHeading('H2') }}
+## Class like sub entities reflections
PHP classes contain methods, properties and constants. Below is information about these child entities:
diff --git a/selfdoc/templates/tech/02_parser/reflectionApi/readme.md.twig b/selfdoc/templates/tech/02_parser/reflectionApi/readme.md.twig
index 7f4be448..a0d4b55f 100644
--- a/selfdoc/templates/tech/02_parser/reflectionApi/readme.md.twig
+++ b/selfdoc/templates/tech/02_parser/reflectionApi/readme.md.twig
@@ -1,9 +1,9 @@
---
title: Reflection API
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Reflection API" | textToHeading('H1') }}
+# Reflection API
The documentation generator has a convenient Reflection API for analyzing the source code of the project being documented.
You can use the Reflection API both in documentation templates and simply in your code where necessary.
@@ -12,9 +12,10 @@ You can use the Reflection API both in documentation templates and simply in you
1) **[a]Reflection API for PHP[/a]**
2) **[Demo](/demo/demo6-reflection-api/demoScript.php)**
-{{ "Example" | textToHeading('H3') }}
+## Example
-{{ '// Create a Reflection API config object. This example shows the config for parsing PHP code
+```php
+// Create a Reflection API config object. This example shows the config for parsing PHP code
$reflectionApiConfig = PhpReflectionApiConfig::create();
/** @var PhpEntitiesCollection $entitiesCollection*/
@@ -26,19 +27,20 @@ $sourceLocators = SourceLocatorsCollection::create(new DirectoriesSourceLocator(
// We can define special filters according to which entities will be loaded
$filter = new TrueCondition();
-// By default the collection is empty. You can populate the collection with data
+// By default, the collection is empty. You can populate the collection with data
$entitiesCollection->loadEntities(
$sourceLocators,
$filter
);
// And now you can use Reflection API
-$filename = $entitiesCollection->get(\'SomeClassName\')?->getAbsoluteFileName();
-' | textToCodeBlock('php') }}
+$filename = $entitiesCollection->get('SomeClassName')?->getAbsoluteFileName();
+```
-{{ "Example 2 - Working with the Reflection API through a default parsing mechanism" | textToHeading('H3') }}
+## Example 2 - Working with the Reflection API through a default parsing mechanism
-{{ '// Create a documentation generator object
+```php
+// Create a documentation generator object
$docGen = (new \BumbleDocGen\DocGeneratorFactory())->create($configFile);
// Next we get a group of entity collections (according to the configuration)
@@ -48,8 +50,8 @@ $entityCollectionsGroup = $docGen->parseAndGetRootEntityCollectionsGroup();
$entitiesCollection = $entityCollectionsGroup->get(PhpEntitiesCollection::class);
// And now you can use Reflection API
-$filename = $entitiesCollection->get(\'SomeClassName\')?->getAbsoluteFileName();
-' | textToCodeBlock('php') }}
+$filename = $entitiesCollection->get('SomeClassName')?->getAbsoluteFileName();
+```
This method is used in the documentation generation process.
The only difference with the first example is that the first option is more convenient to use as a separate tool.
diff --git a/selfdoc/templates/tech/02_parser/sourceLocator.md.twig b/selfdoc/templates/tech/02_parser/sourceLocator.md.twig
index 1abd1872..73b89dcb 100644
--- a/selfdoc/templates/tech/02_parser/sourceLocator.md.twig
+++ b/selfdoc/templates/tech/02_parser/sourceLocator.md.twig
@@ -2,24 +2,26 @@
title: Source locators
prevPage: Parser
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Source locators" | textToHeading('H1') }}
+# Source locators
Source locators are needed so that the parser knows which files to parse, or to get data on a specific file after the primary parsing procedure
Source locators are set in the configuration:
-{{ 'source_locators:
+```yaml
+source_locators:
- class: \\BumbleDocGen\\Core\\Parser\\SourceLocator\\RecursiveDirectoriesSourceLocator
arguments:
directories:
- "%project_root%/src"
- - "%project_root%/selfdoc"' | textToCodeBlock('yaml') }}
+ - "%project_root%/selfdoc"
+```
You can create your own source locators or use any existing ones. All source locators must implement the [a]SourceLocatorInterface[/a] interface.
-{{ "Built-in source locators" | textToHeading('H2') }}
+## Built-in source locators
{{ printEntityCollectionAsList(
phpEntities
diff --git a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/frontMatter.md.twig b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/frontMatter.md.twig
index 264f45a3..e10a3107 100644
--- a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/frontMatter.md.twig
+++ b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/frontMatter.md.twig
@@ -2,9 +2,9 @@
title: Front Matter
prevPage: How to create documentation templates?
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Front Matter" | textToHeading('H1') }}
+# Front Matter
Front Matter is a special block at the top of a document template or generated document that contains certain important meta information.
diff --git a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/readme.md.twig b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/readme.md.twig
index d7db5360..aae5228c 100644
--- a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/readme.md.twig
+++ b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/readme.md.twig
@@ -1,9 +1,9 @@
---
title: How to create documentation templates?
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "How to create documentation templates?" | textToHeading('H1') }}
+# How to create documentation templates?
Templates are `twig` files in which you can write both static text and dynamic blocks that will change from code changes or other required parameters.
@@ -11,34 +11,39 @@ Templates are `twig` files in which you can write both static text and dynamic b
{{ drawDocumentationMenu(_self) }}
-{{ "Examples" | textToHeading('H2') }}
+## Examples
-{{ "1) An example of a template with fully static text:" | textToHeading('H3') }}
+### 1) An example of a template with fully static text:
-{{ "Some static text\nThis text does not change when the code is changed" | textToCodeBlock('twig') }}
+```twig
+Some static text
+This text does not change when the code is changed
+```
After generating the documentation, this page will look exactly like a template.
-{{ "2) An example of a template with static text and dynamic blocks:" | textToHeading('H3') }}
+### 2) An example of a template with static text and dynamic blocks:
-{{ "---
+```twig
+---
title: Some page
prevPage: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }\}
+{{ "{{ drawPageBreadcrumbs() }}" }}
Some static text...
Dynamic block:
-{\{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\\\BumbleDocGen\\\\Core\\\\Parser\\\\SourceLocator\\\\SourceLocatorInterface']).getOnlyInstantiable()) }\}
+{{ "{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\\\BumbleDocGen\\\\Core\\\\Parser\\\\SourceLocator\\\\SourceLocatorInterface']).getOnlyInstantiable()) }}" }}
More static text...
-" | textToCodeBlock('twig') }}
+```
Result after starting the documentation generation process:
-{{ '
+```md
+
Some static text...
@@ -51,39 +56,39 @@ More static text...
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Jul 29 17:43:49 2023 +0300
Page content update date: Sun Jul 30 2023
Made with
Bumble Documentation Generator
-' | textToCodeBlock('html') }}
+```
This is how it looks on the GitHub:
-
+
-{{ "3) Another example of a dynamic block:" | textToHeading('H3') }}
+### 3) Another example of a dynamic block:
Output method description as a dynamic block:
-{{ "Some static text...
+```twig
+Some static text...
Dynamic block:
-{\{ phpEntities
+{{ "{{ phpEntities
.get('\\\\BumbleDocGen\\\\LanguageHandler\\\\LanguageHandlerInterface')
.getMethod('getLanguageKey')
.getDescription()
-}\}
+}}" }}
More static text...
-" | textToCodeBlock('twig') }}
+```
Result after starting the documentation generation process:
-
-
-{{ "Some static text...
+```twig
+Some static text...
Dynamic block:
Unique language handler key
More static text...
-" | textToCodeBlock('twig') }}
\ No newline at end of file
+```
\ No newline at end of file
diff --git a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md.twig b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md.twig
index 3923b06b..fe5ff344 100644
--- a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md.twig
+++ b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md.twig
@@ -2,21 +2,24 @@
title: Templates dynamic blocks
prevPage: How to create documentation templates?
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Templates dynamic blocks" | textToHeading('H1') }}
+# Templates dynamic blocks
There are several ways to create dynamic blocks in templates.
* First of all, these are custom twig functions and filters.
You can use the built-in functions and filters or add your own, so you can implement any logic for generating dynamically changing content.
-{{ "{\{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\\\BumbleDocGen\\\\Core\\\\Parser\\\\SourceLocator\\\\SourceLocatorInterface']).getOnlyInstantiable()) }\}" | textToCodeBlock('twig') }}
+```twig
+{{ "{{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\\\BumbleDocGen\\\\Core\\\\Parser\\\\SourceLocator\\\\SourceLocatorInterface']).getOnlyInstantiable()) }}" }}
+```
* The second way is to output data from variables directly to the template. For example, you can display a list of classes or methods of documented code according to certain rules.
+```twig
{{ "{% for entity in phpEntities.filterByInterfaces(['\\\\BumbleDocGen\\\\Core\\\\Parser\\\\SourceLocator\\\\SourceLocatorInterface']).getOnlyInstantiable() %}
* {{ entity.getName() }}
-{% endfor %}
-" | textToCodeBlock('twig') }}
+{% endfor %}" }}
+```
diff --git a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md.twig b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md.twig
index d3b7a65f..be856426 100644
--- a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md.twig
+++ b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md.twig
@@ -2,14 +2,14 @@
title: Linking templates
prevPage: How to create documentation templates?
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Linking templates" | textToHeading('H1') }}
+# Linking templates
One of the main requirements of the documentation is to be able to easily and quickly implement linking between pages.
We have several options for this, such as using special functions or using a special document linking mechanism (`completing blank links`)
-{{ "Completing blank links" | textToHeading('H2') }}
+## Completing blank links
Plugin [a]PageHtmlLinkerPlugin[/a] have been added to the basic configuration,
which process the text of the filled template before its result is written to a file, and fill in all empty links.
@@ -33,7 +33,7 @@ Examples:
{{ '[a x-title="test"]Existent page name[/a] => <a href="/docs/some/page/targetPage.md">test</a>
' }}
-{{ "Generating links through functions" | textToHeading('H2') }}
+## Generating links through functions
The second way to relink templates is to generate links through functions.
diff --git a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md.twig b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md.twig
index af9addba..85d59e9b 100644
--- a/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md.twig
+++ b/selfdoc/templates/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md.twig
@@ -2,9 +2,9 @@
title: Templates variables
prevPage: How to create documentation templates?
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Templates variables" | textToHeading('H1') }}
+# Templates variables
There are several variables available in each processed template.
diff --git a/selfdoc/templates/tech/03_renderer/02_breadcrumbs.md.twig b/selfdoc/templates/tech/03_renderer/02_breadcrumbs.md.twig
index eb418465..9c5bca15 100644
--- a/selfdoc/templates/tech/03_renderer/02_breadcrumbs.md.twig
+++ b/selfdoc/templates/tech/03_renderer/02_breadcrumbs.md.twig
@@ -2,45 +2,53 @@
title: Documentation structure and breadcrumbs
prevPage: Renderer
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Documentation structure and breadcrumbs" | textToHeading('H1') }}
+# Documentation structure and breadcrumbs
To work with breadcrumbs and get the structure of the documentation, we use the inner class [a]BreadcrumbsHelper[/a].
To build the documentation structure, twig templates from the `templates_dir` configuration are used.
-{{ "Project structure definitions" | textToHeading('H2') }}
+## Project structure definitions
To determine the structure of the project, the actual location of the files in the templates directory is used first of all.
For each directory there is an index file ( readme.md or index.md ), and they are used to determine the exact input of each level of nesting.
-
+
But in addition to building the documentation structure using the actual location of template files in directories,
you can explicitly specify the parent page in each template using the special front matter variable `prevPage`:
-{{ "---
+```markdown
+---
prevPage: Prev page name
----" | textToCodeBlock('markdown') }}
+---
+```
In this way, complex documentation structures can be created with less file nesting:
-
+
-{{ "Displaying breadcrumbs in documents" | textToHeading('H2') }}
+## Displaying breadcrumbs in documents
-There is a built-in function to generate breadcrumbs in templates [a]GeneratePageBreadcrumbs[/a].
+There is a built-in function to generate breadcrumbs in templates [a]DrawPageBreadcrumbs[/a].
Here is how it is used in twig templates:
-{{ '{{ generatePageBreadcrumbs(title, _self) }\}' | textToCodeBlock('twig') }}
+```twig
+{{ '{{ drawPageBreadcrumbs() }}' }}
+```
To build breadcrumbs, the previously compiled project structure and the names of each template are used.
The template name can be specified using the `title` front matter variable:
-{{ "---
+```markdown
+---
title: Some page title
----" | textToCodeBlock('markdown') }}
+---
+```
-Here is an example of the result of the `generatePageBreadcrumbs` function:
+Here is an example of the result of the `drawPageBreadcrumbs` function:
-{{ '' | textToCodeBlock('twig') }}
\ No newline at end of file
+```twig
+{{ '' }}
+```
diff --git a/selfdoc/templates/tech/03_renderer/03_documentStructure.md.twig b/selfdoc/templates/tech/03_renderer/03_documentStructure.md.twig
index 0e841568..68c203b7 100644
--- a/selfdoc/templates/tech/03_renderer/03_documentStructure.md.twig
+++ b/selfdoc/templates/tech/03_renderer/03_documentStructure.md.twig
@@ -2,9 +2,9 @@
title: Document structure of generated entities
prevPage: Renderer
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Document structure of generated entities" | textToHeading('H1') }}
+# Document structure of generated entities
*By default, the documentation generator offers two options for organizing the structure of generated entity documents:*
diff --git a/selfdoc/templates/tech/03_renderer/04_twigCustomFilters.md.twig b/selfdoc/templates/tech/03_renderer/04_twigCustomFilters.md.twig
index d628d61f..f954cf9c 100644
--- a/selfdoc/templates/tech/03_renderer/04_twigCustomFilters.md.twig
+++ b/selfdoc/templates/tech/03_renderer/04_twigCustomFilters.md.twig
@@ -2,9 +2,9 @@
title: Template filters
prevPage: Renderer
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Template filters" | textToHeading('H1') }}
+# Template filters
When generating pages, you can use filters that allow you to modify the content.
Filters available during page generation are defined in the configuration ( `twig_filters` parameter )
@@ -12,7 +12,7 @@ Filters available during page generation are defined in {{ someText | filter(...parameters) }}' }}
@@ -21,7 +21,7 @@ or
{{ '{{ someText | filter }}
' }}
-{{ "Configuration example" | textToHeading('H2') }}
+## Configuration example
You can add your custom filters to the configuration like this:
@@ -34,7 +34,7 @@ twig_filters:
It is important to remember that when a template is inherited, custom filters are not overridden and augmented.
This information is detailed on page [a]01_configuration.md[/a].
-{{ "Defautl template filters" | textToHeading('H2') }}
+## Default template filters
Several filters are already defined in the base configuration.
There are both general filters for all types of entities, and filters that only serve to process entities that belong to a particular PL.
diff --git a/selfdoc/templates/tech/03_renderer/05_twigCustomFunctions.md.twig b/selfdoc/templates/tech/03_renderer/05_twigCustomFunctions.md.twig
index 9da7d28c..5f8f4d5d 100644
--- a/selfdoc/templates/tech/03_renderer/05_twigCustomFunctions.md.twig
+++ b/selfdoc/templates/tech/03_renderer/05_twigCustomFunctions.md.twig
@@ -2,9 +2,9 @@
title: Template functions
prevPage: Renderer
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Template functions" | textToHeading('H1') }}
+# Template functions
When generating pages, you can use functions that allow you to modify the content.
Functions available during page generation are defined in the configuration ( `twig_functions` parameter )
@@ -14,11 +14,11 @@ We use the twig template engine, you can get more information about working with
You can also create your own functions and use them for any purpose, such as loading some additional information into a template, filtering data, or formatting the output of any information.
Each function must implement the [a]CustomFunctionInterface[/a] interface, implement the `__invoke` magic method, and be added to the configuration.
-{{ "How to use a function in a template" | textToHeading('H2') }}
+## How to use a function in a template
{{ '{{ functionName(...parameters) }}
' }}
-{{ "Configuration example" | textToHeading('H2') }}
+## Configuration example
You can add your custom functions to the configuration like this:
@@ -32,7 +32,7 @@ twig_functions:
It is important to remember that when a template is inherited, custom functions are not overridden and augmented.
This information is detailed on page [a]01_configuration.md[/a].
-{{ "Defautl template functions" | textToHeading('H2') }}
+## Default template functions
Several functions are already defined in the base configuration.
There are both general functions for all types of entities, and functions that only serve to process entities that belong to a particular PL.
diff --git a/selfdoc/templates/tech/03_renderer/readme.md.twig b/selfdoc/templates/tech/03_renderer/readme.md.twig
index 5f1411b8..b502d9d6 100644
--- a/selfdoc/templates/tech/03_renderer/readme.md.twig
+++ b/selfdoc/templates/tech/03_renderer/readme.md.twig
@@ -1,9 +1,9 @@
---
title: Renderer
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Documentation renderer" | textToHeading('H1') }}
+# Documentation renderer
Render passes through all files from the directory specified in configuration param `templates_dir`
@@ -11,18 +11,20 @@ If the file ends with **.twig** then the file is processed, otherwise it is simp
to the target directory obtained from configuration param `output_dir`.
We use twig to process templates.
-{{ "More detailed description of renderer components" | textToHeading('H2') }}
+## More detailed description of renderer components
{{ drawDocumentationMenu(_self) }}
-{{ "Starting the rendering process" | textToHeading('H2') }}
+## Starting the rendering process
-{{ "$renderer = new Renderer(...);
+```php
+$renderer = new Renderer(...);
// Starting the process of filling templates with data and saving finished documents
-$renderer->run();" | textToCodeBlock('php') }}
+$renderer->run();
+```
-{{ "How it works" | textToHeading('H2') }}
+## How it works
The process of rendering documents is divided into several stages. We separately generate documentation for templates that were pre-prepared by the user,
and then create documentation for classes that the user refers to from document templates.
diff --git a/selfdoc/templates/tech/04_pluginSystem.md.twig b/selfdoc/templates/tech/04_pluginSystem.md.twig
index b69e12ca..256e92da 100644
--- a/selfdoc/templates/tech/04_pluginSystem.md.twig
+++ b/selfdoc/templates/tech/04_pluginSystem.md.twig
@@ -2,15 +2,15 @@
title: Plugin system
prevPage: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Plugin system" | textToHeading('H1') }}
+# Plugin system
The documentation generator includes the ability to expand the functionality using plugins that allow you to add the necessary functionality to the system without changing its core.
The system is built on the basis of an event model, each plugin class must implement [a]PluginInterface[/a].
-{{ "Configuration example" | textToHeading('H2') }}
+## Configuration example
You can add your plugins to the configuration like this:
@@ -20,18 +20,13 @@ plugins:
- class: \SelfDocConfig\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin
```
-{{ "Default plugins" | textToHeading('H2') }}
+## Default plugins
Below are the plugins that are available by default when working with the library.
Plugins for any programming languages work regardless of which language handler is configured in the configuration.
-
-
- Plugin |
- PL |
- Handles events |
- Description |
-
+| Plugin | PL | Handles events | Description |
+|-|-|-|-|
{% for pluginEntity in phpEntities
.filterByPaths([
'/src/Core',
@@ -41,22 +36,10 @@ Plugins for any programming languages work regardless of which language handler
.getOnlyInstantiable()
%}
{% set match = pluginEntity.getRelativeFileName() | preg_match('/(\\/LanguageHandler\\/)([\\s\\S]*?)(?=\\/)/i') %}
-
- {{ drawDocumentedEntityLink(pluginEntity) }} |
- {% if match[2] %}{{ match[2] | upper }}{% else %}any{% endif %} |
-
-
- {% for key in pluginEntity.getMethod('getSubscribedEvents', true).getFirstReturnValue() | keys %}
- - [a]{{ key }}|short_form[/a]
- {% endfor %}
-
- |
- {{ pluginEntity.getDescription() }} |
-
+| {{ drawDocumentedEntityLink(pluginEntity) }} | {% if match[2] %}{{ match[2] | upper }}{% else %}any{% endif %} | {% for key in pluginEntity.getMethod('getSubscribedEvents', true).getFirstReturnValue() | keys %}- [a]{{ key }}|short_form[/a]
{% endfor %}
| {{ pluginEntity.getDescription() | removeLineBrakes }} |
{% endfor %}
-
-{{ "Default events" | textToHeading('H2') }}
+## Default events
{{ printEntityCollectionAsList( phpEntities
.filterByPaths([
@@ -66,11 +49,11 @@ Plugins for any programming languages work regardless of which language handler
.filterByParentClassNames(['Symfony\\Contracts\\EventDispatcher\\Event'])
.getOnlyInstantiable() ) }}
-{{ "Adding a new plugin" | textToHeading('H2') }}
+## Adding a new plugin
If you decide to add a new plugin, there are a few things you need to do:
-{{ "1) Add plugin class and implement events handling" | textToHeading('H3') }}
+### 1) Add plugin class and implement events handling
```php
namespace Demo\Plugin\DemoFakeResourceLinkPlugin;
@@ -93,7 +76,7 @@ final class DemoFakeResourceLinkPlugin implements \BumbleDocGen\Core\Plugin\Plug
}
```
-{{ "2) Add the new plugin to the configuration" | textToHeading('H3') }}
+### 2) Add the new plugin to the configuration
```yaml
plugins:
diff --git a/selfdoc/templates/tech/05_console.md.twig b/selfdoc/templates/tech/05_console.md.twig
index ee27c1d3..0fa0743e 100644
--- a/selfdoc/templates/tech/05_console.md.twig
+++ b/selfdoc/templates/tech/05_console.md.twig
@@ -2,9 +2,9 @@
title: Console app
prevPage: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Console app" | textToHeading('H1') }}
+# Console app
The documentation generator provides the ability to work through a built-in [a x-title="console application"]App[/a].
It is available via composer:
@@ -14,24 +14,15 @@ vendor/bin/bumbleDocGen list
We use [Symfony Console](https://github.com/symfony/console) as the basis of the console application.
-{{ "Built-in console commands" | textToHeading('H2') }}
+## Built-in console commands
-
-
- Command |
- Parameters |
- Description |
-
+| Command | Parameters | Description |
+|-|-|-|
{% for consoleCommandData in getConsoleCommands() %}
-
- {{ consoleCommandData.name }} |
- {{ consoleCommandData.synopsis|raw }} |
- {{ consoleCommandData.description }} |
-
+| [{{ consoleCommandData.name }}]({{ getDocumentedEntityUrl(phpEntities, consoleCommandData.class) }}) | {{ consoleCommandData.synopsis|raw }} | {{ consoleCommandData.description }} |
{% endfor %}
-
-{{ "Adding a custom command" | textToHeading('H2') }}
+## Adding a custom command
The system allows you to add custom commands to a standard console application.
This can be done using a special configuration option [a x-title="additional_console_commands"]Configuration::getAdditionalConsoleCommands()[/a] (see [a]Configuration[/a] page).
diff --git a/selfdoc/templates/tech/06_debugging.md.twig b/selfdoc/templates/tech/06_debugging.md.twig
index 80c64f51..f4215534 100644
--- a/selfdoc/templates/tech/06_debugging.md.twig
+++ b/selfdoc/templates/tech/06_debugging.md.twig
@@ -2,9 +2,9 @@
title: Debug documents
prevPage: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Debug documents" | textToHeading('H1') }}
+# Debug documents
Our tool provides several options for debugging documentation.
@@ -12,7 +12,7 @@ Our tool provides several options for debugging documentation.
**Here is an example of error output:**
-
+
2) To track exactly how documentation is generated, you can use the interactive mode:
diff --git a/selfdoc/templates/tech/07_outputFormat.md.twig b/selfdoc/templates/tech/07_outputFormat.md.twig
index 4feabc66..fa8e8d08 100644
--- a/selfdoc/templates/tech/07_outputFormat.md.twig
+++ b/selfdoc/templates/tech/07_outputFormat.md.twig
@@ -2,9 +2,9 @@
title: Output formats
prevPage: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Output formats" | textToHeading('H1') }}
+# Output formats
At the moment, the documentation generator is focused on creating documentation in two formats: [GitHub Flavored Markdown](https://github.github.com/gfm/) and HTML.
However, it is possible to create other files with some restrictions.
diff --git a/selfdoc/templates/tech/readme.md.twig b/selfdoc/templates/tech/readme.md.twig
index 7e3efb2c..d8422e25 100644
--- a/selfdoc/templates/tech/readme.md.twig
+++ b/selfdoc/templates/tech/readme.md.twig
@@ -1,17 +1,17 @@
---
title: Technical description of the project
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Technical description of the project" | textToHeading('H1') }}
+# Technical description of the project
This documentation generator is a library that allows you to create handwritten documentation with dynamic blocks that are loaded from the project code or other places.
-{{ "Documentation sections" | textToHeading('H2') }}
+## Documentation sections
{{ drawDocumentationMenu(_self, 1) }}
-{{ "How it works" | textToHeading('H2') }}
+## How it works
```mermaid
graph TD;
@@ -30,10 +30,14 @@ This documentation generator is a library that allows you to create handwritten
To start the documentation generation process, you need to call the following command:
-{{ "(new DocGeneratorFactory())->create($configFile)->generate()" | textToCodeBlock('php') }}
+```php
+(new DocGeneratorFactory())->create($configFile)->generate();
+```
or
-{{ "(new DocGeneratorFactory())->createByConfigArray($configArray)->generate()" | textToCodeBlock('php') }}
+```php
+(new DocGeneratorFactory())->createByConfigArray($configArray)->generate();
+```
After that, the process of parsing the project code according to the configuration will start, and then filling the templates with data and saving the finished result as final documents.
diff --git a/src/Core/Configuration/defaultConfiguration.yaml b/src/Core/Configuration/defaultConfiguration.yaml
index 550dfb09..eef952b3 100644
--- a/src/Core/Configuration/defaultConfiguration.yaml
+++ b/src/Core/Configuration/defaultConfiguration.yaml
@@ -15,7 +15,7 @@ use_shared_cache: true # (bool) Enable cache usage of generated docum
twig_functions: # (array) Functions that can be used in document templates
- class: \BumbleDocGen\Core\Renderer\Twig\Function\DrawDocumentationMenu
- class: \BumbleDocGen\Core\Renderer\Twig\Function\DrawDocumentedEntityLink
- - class: \BumbleDocGen\Core\Renderer\Twig\Function\GeneratePageBreadcrumbs
+ - class: \BumbleDocGen\Core\Renderer\Twig\Function\DrawPageBreadcrumbs
- class: \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl
- class: \BumbleDocGen\Core\Renderer\Twig\Function\LoadPluginsContent
- class: \BumbleDocGen\Core\Renderer\Twig\Function\PrintEntityCollectionAsList
@@ -28,8 +28,6 @@ twig_filters: # (array) Filters that
- class: \BumbleDocGen\Core\Renderer\Twig\Filter\Quotemeta
- class: \BumbleDocGen\Core\Renderer\Twig\Filter\RemoveLineBrakes
- class: \BumbleDocGen\Core\Renderer\Twig\Filter\StrTypeToUrl
- - class: \BumbleDocGen\Core\Renderer\Twig\Filter\TextToCodeBlock
- - class: \BumbleDocGen\Core\Renderer\Twig\Filter\TextToHeading
- class: \BumbleDocGen\Core\Renderer\Twig\Filter\PregMatch
- class: \BumbleDocGen\Core\Renderer\Twig\Filter\Implode
plugins: # (array|null) List of plugins
diff --git a/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php b/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php
index 994a192a..6f3ddea2 100644
--- a/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php
+++ b/src/Core/Plugin/CorePlugin/LastPageCommitter/LastPageCommitter.php
@@ -15,8 +15,8 @@
final class LastPageCommitter implements PluginInterface
{
public function __construct(
- private RendererContext $context,
- private Configuration $configuration
+ private readonly RendererContext $context,
+ private readonly Configuration $configuration
) {
}
@@ -41,10 +41,10 @@ final public function beforeCreatingDocFile(BeforeCreatingDocFile $event): void
$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 ";
+ $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](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md)";
}
$event->setContent($content);
} catch (\Exception) {
diff --git a/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php b/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php
index 6db5f216..c5327b08 100644
--- a/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php
+++ b/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php
@@ -4,6 +4,7 @@
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
+use BumbleDocGen\Core\Configuration\Configuration;
use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException;
use BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup;
use BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile;
@@ -17,10 +18,11 @@
abstract class BasePageLinker implements PluginInterface
{
public function __construct(
- private BreadcrumbsHelper $breadcrumbsHelper,
- private RootEntityCollectionsGroup $rootEntityCollectionsGroup,
- private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
- private LoggerInterface $logger,
+ private readonly BreadcrumbsHelper $breadcrumbsHelper,
+ private readonly RootEntityCollectionsGroup $rootEntityCollectionsGroup,
+ private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
+ private readonly Configuration $configuration,
+ private readonly LoggerInterface $logger,
) {
}
@@ -70,9 +72,11 @@ public static function getSubscribedEvents(): array
*/
final public function beforeCreatingDocFile(BeforeCreatingDocFile $event): void
{
+ $docRelativeFilePath = str_replace($this->configuration->getOutputDir(), '', $event->getOutputFilePatch());
+
$content = preg_replace_callback(
$this->getLinkRegEx(),
- function (array $matches) {
+ function (array $matches) use ($docRelativeFilePath) {
$match = $matches[0] ?? '';
$linkString = $this->getUrlFromMatch($match);
$pageData = $this->breadcrumbsHelper->getPageDataByKey($linkString);
@@ -85,11 +89,12 @@ function (array $matches) {
foreach ($this->rootEntityCollectionsGroup as $rootEntityCollection) {
$entityUrlData = $rootEntityCollection->getEntityLinkData($linkString);
if ($entityUrlData['entityName'] ?? null) {
- $getDocumentedEntityUrl = $this->getDocumentedEntityUrlFunction;
- $entityUrlData['url'] = $getDocumentedEntityUrl(
+ $entityUrlData['url'] = $this->getDocumentedEntityUrlFunction->process(
$rootEntityCollection,
$entityUrlData['entityName'],
- $entityUrlData['cursor']
+ $entityUrlData['cursor'],
+ true,
+ "{$docRelativeFilePath}.twig"
);
return $this->getFilledOutputTemplate(
$this->getCustomTitleFromMatch($match) ?: $entityUrlData['title'],
diff --git a/src/Core/Plugin/CorePlugin/PageLinker/PageLinkerPlugin.php b/src/Core/Plugin/CorePlugin/PageLinker/PageLinkerPlugin.php
index b2f36125..53e58497 100644
--- a/src/Core/Plugin/CorePlugin/PageLinker/PageLinkerPlugin.php
+++ b/src/Core/Plugin/CorePlugin/PageLinker/PageLinkerPlugin.php
@@ -5,7 +5,7 @@
namespace BumbleDocGen\Core\Plugin\CorePlugin\PageLinker;
/**
- * Adds URLs to empty links in HTML format;
+ * Adds URLs to empty links in MD format;
* Links may contain:
* 1) Short entity name
* 2) Full entity name
@@ -15,13 +15,13 @@
* 6) Relative reference to the entity document from the root directory of the documentation
*
* @example
- * [a]Existent page name[/a] => Existent page name
+ * [a]Existent page name[/a] => [Existent page name](/docs/some/page/targetPage.md)
*
* @example
- * [a x-title="Custom title"]\Namespace\ClassName[/a] => Custom title
+ * [a x-title="Custom title"]\Namespace\ClassName[/a] => [Custom title](/docs/some/page/ClassName.md)
*
* @example
- * [a]\Namespace\ClassName[/a] => \Namespace\ClassName
+ * [a]\Namespace\ClassName[/a] => [\Namespace\ClassName](/docs/some/page/ClassName.md)
*
* @example
* [a]Non-existent page name[/a] => Non-existent page name
@@ -47,6 +47,6 @@ protected function getCustomTitleFromMatch(string $match): string
protected function getOutputTemplate(): string
{
- return '%title%';
+ return '[%title%](%url%)';
}
}
diff --git a/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php b/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php
index 83059873..791644b2 100644
--- a/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php
+++ b/src/Core/Renderer/Breadcrumbs/BreadcrumbsHelper.php
@@ -12,14 +12,10 @@
use BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath;
use BumbleDocGen\Core\Plugin\PluginEventDispatcher;
use BumbleDocGen\Core\Renderer\TemplateFile;
-use BumbleDocGen\Core\Renderer\Twig\MainTwigEnvironment;
use DI\DependencyException;
use DI\NotFoundException;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Yaml\Yaml;
-use Twig\Error\LoaderError;
-use Twig\Error\RuntimeError;
-use Twig\Error\SyntaxError;
/**
* Helper entity for working with breadcrumbs
@@ -39,7 +35,6 @@ final class BreadcrumbsHelper
public function __construct(
private readonly Configuration $configuration,
private readonly LocalObjectCache $localObjectCache,
- private readonly BreadcrumbsTwigEnvironment $breadcrumbsTwig,
private readonly PluginEventDispatcher $pluginEventDispatcher,
private readonly string $prevPageNameTemplate = self::DEFAULT_PREV_PAGE_NAME_TEMPLATE
) {
@@ -336,22 +331,4 @@ public function getPageDocFileByKey(string $key): ?string
$pageData = $this->getPageDataByKey($key);
return $pageData['doc_file'] ?? null;
}
-
- /**
- * Returns an HTML string with rendered breadcrumbs
- *
- * @throws SyntaxError
- * @throws NotFoundException
- * @throws RuntimeError
- * @throws DependencyException
- * @throws LoaderError
- * @throws InvalidConfigurationParameterException
- */
- public function renderBreadcrumbs(string $currentPageTitle, string $filePatch, bool $fromCurrent = true): string
- {
- return $this->breadcrumbsTwig->render('breadcrumbs.html.twig', [
- 'currentPageTitle' => $currentPageTitle,
- 'breadcrumbs' => $this->getBreadcrumbs($filePatch, $fromCurrent),
- ]);
- }
}
diff --git a/src/Core/Renderer/Breadcrumbs/templates/breadcrumbs.html.twig b/src/Core/Renderer/Breadcrumbs/templates/breadcrumbs.html.twig
deleted file mode 100644
index 56c0e961..00000000
--- a/src/Core/Renderer/Breadcrumbs/templates/breadcrumbs.html.twig
+++ /dev/null
@@ -1 +0,0 @@
-{% if breadcrumbs %}{% for item in breadcrumbs %}{{ item.title }} / {% endfor %}{{ currentPageTitle }}
{% endif %}
\ No newline at end of file
diff --git a/src/Core/Renderer/Breadcrumbs/templates/breadcrumbs.md.twig b/src/Core/Renderer/Breadcrumbs/templates/breadcrumbs.md.twig
new file mode 100644
index 00000000..d7e0798c
--- /dev/null
+++ b/src/Core/Renderer/Breadcrumbs/templates/breadcrumbs.md.twig
@@ -0,0 +1,7 @@
+{% if breadcrumbs %}
+{% for item in breadcrumbs %}
+[{{ item.title }}]({{ item.url }}) **/**
+{% endfor %}{{ currentPageTitle }}
+
+---
+{% endif %}
\ No newline at end of file
diff --git a/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php b/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php
index 8b550acf..c0e2bc88 100644
--- a/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php
+++ b/src/Core/Renderer/Twig/Filter/StrTypeToUrl.php
@@ -18,9 +18,9 @@
final class StrTypeToUrl implements CustomFilterInterface
{
public function __construct(
- private RendererHelper $rendererHelper,
- private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
- private Logger $logger
+ private readonly RendererHelper $rendererHelper,
+ private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
+ private readonly Logger $logger
) {
}
@@ -33,43 +33,51 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
-
/**
+ * @param array $context
* @param string $text Processed text
* @param RootEntityCollection $rootEntityCollection
* @param bool $useShortLinkVersion Shorten or not the link name. When shortening, only the shortName of the entity will be shown
* @param bool $createDocument
* If true, creates an entity document. Otherwise, just gives a reference to the entity code
+ * @param string $separator Separator between types
*
* @return string
*/
public function __invoke(
+ array $context,
string $text,
RootEntityCollection $rootEntityCollection,
bool $useShortLinkVersion = false,
- bool $createDocument = false
+ bool $createDocument = false,
+ string $separator = ' | '
): string {
$getDocumentedEntityUrlFunction = $this->getDocumentedEntityUrlFunction;
$preparedTypes = [];
$types = explode('|', $text);
foreach ($types as $type) {
+ $name = $type;
+ $data = explode('::', $type);
+ $type = $data[0];
+ $cursor = $data[1] ?? '';
$preloadResourceLink = $this->rendererHelper->getPreloadResourceLink($type);
if ($preloadResourceLink) {
if ($useShortLinkVersion) {
$type = array_reverse(explode('\\', $type))[0];
}
- $preparedTypes[] = "{$type}";
+ $preparedTypes[] = "[{$type}]({$preloadResourceLink})";
continue;
}
try {
$entityOfLink = $rootEntityCollection->getLoadedOrCreateNew($type);
if (!$entityOfLink->isExternalLibraryEntity() && $entityOfLink->isEntityDataCanBeLoaded()) {
if ($entityOfLink->getAbsoluteFileName()) {
- $link = $getDocumentedEntityUrlFunction($rootEntityCollection, $type, '', $createDocument);
+ $link = $getDocumentedEntityUrlFunction($context, $rootEntityCollection, $type, $cursor, $createDocument);
if ($useShortLinkVersion) {
$type = $entityOfLink->getShortName();
@@ -78,7 +86,7 @@ public function __invoke(
}
if ($link && $link !== '#') {
- $preparedTypes[] = "{$type}";
+ $preparedTypes[] = "[$name]({$link})";
} else {
$preparedTypes[] = $type;
}
@@ -97,6 +105,6 @@ public function __invoke(
}
}
- return implode(' | ', $preparedTypes);
+ return implode($separator, $preparedTypes);
}
}
diff --git a/src/Core/Renderer/Twig/Filter/TextToCodeBlock.php b/src/Core/Renderer/Twig/Filter/TextToCodeBlock.php
deleted file mode 100644
index db9b6df6..00000000
--- a/src/Core/Renderer/Twig/Filter/TextToCodeBlock.php
+++ /dev/null
@@ -1,34 +0,0 @@
- ['html'],
- ];
- }
-
- /**
- * @param string $text Processed text
- * @param string $codeBlockType Code block type (e.g. php or console )
- * @return string
- */
- public function __invoke(string $text, string $codeBlockType): string
- {
- $addIndentFromLeftFunction = new AddIndentFromLeft();
- return "```{$codeBlockType}\n{$addIndentFromLeftFunction($text, 1)}\n```\n";
- }
-}
diff --git a/src/Core/Renderer/Twig/Filter/TextToHeading.php b/src/Core/Renderer/Twig/Filter/TextToHeading.php
deleted file mode 100644
index a77ee06c..00000000
--- a/src/Core/Renderer/Twig/Filter/TextToHeading.php
+++ /dev/null
@@ -1,41 +0,0 @@
- "%text%
",
- 'h2' => "%text%
",
- 'h3' => "%text%
",
- ];
-
- public static function getName(): string
- {
- return 'textToHeading';
- }
-
- public static function getOptions(): array
- {
- return [
- 'is_safe' => ['html'],
- ];
- }
-
- /**
- * @param string $text
- * @param string $headingType Choose heading type: H1, H2, H3
- * @return string
- */
- public function __invoke(string $text, string $headingType): string
- {
- $template = $this->templates[strtolower($headingType)] ?? '%text%';
- $content = str_replace('%text%', $text, $template);
- return "";
- }
-}
diff --git a/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php b/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php
index 0b0beffd..4f592f0e 100644
--- a/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php
+++ b/src/Core/Renderer/Twig/Function/DrawDocumentationMenu.php
@@ -9,12 +9,16 @@
use BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper;
use BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory;
use BumbleDocGen\Core\Renderer\Context\RendererContext;
+use BumbleDocGen\Core\Renderer\Twig\Filter\AddIndentFromLeft;
+use BumbleDocGen\Core\Renderer\Twig\MainTwigEnvironment;
use DI\DependencyException;
use DI\NotFoundException;
use Symfony\Component\Finder\Finder;
+use function BumbleDocGen\Core\calculate_relative_url;
+
/**
- * Generate documentation menu in HTML format. To generate the menu, the start page is taken,
+ * Generate documentation menu in MD format. To generate the menu, the start page is taken,
* and all links with this page are recursively collected for it, after which the html menu is created.
*
* @note This function initiates the creation of documents for the displayed entities
@@ -28,10 +32,10 @@
final class DrawDocumentationMenu implements CustomFunctionInterface
{
public function __construct(
- private Configuration $configuration,
- private BreadcrumbsHelper $breadcrumbsHelper,
- private RendererContext $rendererContext,
- private RendererDependencyFactory $dependencyFactory,
+ private readonly Configuration $configuration,
+ private readonly BreadcrumbsHelper $breadcrumbsHelper,
+ private readonly RendererContext $rendererContext,
+ private readonly RendererDependencyFactory $dependencyFactory,
) {
}
@@ -44,10 +48,12 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
/**
+ * @param array $context
* @param null|string $startPageKey
* Relative path to the page from which the menu will be generated (only child pages will be taken into account).
* By default, the main documentation page (readme.md) is used.
@@ -56,12 +62,15 @@ public static function getOptions(): array
* By default, this restriction is disabled.
*
* @return string
- * @throws NotFoundException
* @throws DependencyException
* @throws InvalidConfigurationParameterException
+ * @throws NotFoundException
*/
- public function __invoke(?string $startPageKey = null, ?int $maxDeep = null): string
- {
+ public function __invoke(
+ array $context,
+ ?string $startPageKey = null,
+ ?int $maxDeep = null
+ ): string {
if ($startPageKey) {
$startPageKey = str_replace('.twig', '', $startPageKey);
}
@@ -93,21 +102,29 @@ public function __invoke(?string $startPageKey = null, ?int $maxDeep = null): st
}
}
- $drawPages = function (array $pagesData, int $currentDeep = 1) use ($structure, $maxDeep, &$drawPages): string {
- $html = '";
- return $html;
+ return $md;
};
if ($startPageKey) {
@@ -118,7 +135,6 @@ public function __invoke(?string $startPageKey = null, ?int $maxDeep = null): st
$startPageKey = array_key_first($structure);
}
- $content = isset($structure[$startPageKey]) ? $drawPages($structure[$startPageKey]) : '';
- return "";
+ return isset($structure[$startPageKey]) ? $drawPages($structure[$startPageKey]) : '';
}
}
diff --git a/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php b/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php
index 88eec3a2..1c57bbb9 100644
--- a/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php
+++ b/src/Core/Renderer/Twig/Function/DrawDocumentedEntityLink.php
@@ -20,7 +20,7 @@
*/
final class DrawDocumentedEntityLink implements CustomFunctionInterface
{
- public function __construct(private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction)
+ public function __construct(private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction)
{
}
@@ -33,6 +33,7 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
@@ -48,13 +49,14 @@ public static function getOptions(): array
* @throws InvalidConfigurationParameterException
*/
public function __invoke(
+ array $context,
RootEntityInterface $entity,
string $cursor = '',
bool $useShortName = true
): string {
$getDocumentedEntityUrlFunction = $this->getDocumentedEntityUrlFunction;
- $url = $getDocumentedEntityUrlFunction($entity->getRootEntityCollection(), $entity->getName(), $cursor);
+ $url = $getDocumentedEntityUrlFunction($context, $entity->getRootEntityCollection(), $entity->getName(), $cursor);
$name = $useShortName ? $entity->getShortName() : $entity->getName();
- return "{$name}";
+ return "[{$name}]({$url})";
}
}
diff --git a/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php b/src/Core/Renderer/Twig/Function/DrawEntityBreadcrumbs.php
similarity index 56%
rename from src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php
rename to src/Core/Renderer/Twig/Function/DrawEntityBreadcrumbs.php
index 4b499068..f81b4ad3 100644
--- a/src/Core/Renderer/Twig/Function/GeneratePageBreadcrumbs.php
+++ b/src/Core/Renderer/Twig/Function/DrawEntityBreadcrumbs.php
@@ -6,6 +6,7 @@
use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException;
use BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper;
+use BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment;
use BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory;
use BumbleDocGen\Core\Renderer\Context\RendererContext;
use DI\DependencyException;
@@ -14,21 +15,24 @@
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
+use function BumbleDocGen\Core\calculate_relative_url;
+
/**
- * Function to generate breadcrumbs on the page
+ * @internal
*/
-final class GeneratePageBreadcrumbs implements CustomFunctionInterface
+final class DrawEntityBreadcrumbs implements CustomFunctionInterface
{
public function __construct(
- private BreadcrumbsHelper $breadcrumbsHelper,
- private RendererContext $rendererContext,
- private RendererDependencyFactory $dependencyFactory,
+ private readonly BreadcrumbsTwigEnvironment $breadcrumbsTwig,
+ private readonly BreadcrumbsHelper $breadcrumbsHelper,
+ private readonly RendererContext $rendererContext,
+ private readonly RendererDependencyFactory $dependencyFactory
) {
}
public static function getName(): string
{
- return 'generatePageBreadcrumbs';
+ return 'drawEntityBreadcrumbs';
}
public static function getOptions(): array
@@ -39,33 +43,30 @@ public static function getOptions(): array
}
/**
- * @param string $currentPageTitle Title of the current page
- * @param string $templatePath Path to the template from which the breadcrumbs will be generated
- * @param bool $skipFirstTemplatePage
- * If set to true, the page from which parsing starts will not participate in the formation of breadcrumbs
- * This option is useful when working with the _self value in a template, as it returns the full path to the
- * current template, and the reference to it in breadcrumbs should not be clickable.
- *
- * @return string
* @throws RuntimeError
- * @throws DependencyException
* @throws LoaderError
+ * @throws DependencyException
* @throws SyntaxError
* @throws NotFoundException
* @throws InvalidConfigurationParameterException
*/
public function __invoke(
string $currentPageTitle,
+ string $docUrl,
string $templatePath,
- bool $skipFirstTemplatePage = true
): string {
- $content = $this->breadcrumbsHelper->renderBreadcrumbs(
- $currentPageTitle,
- $templatePath,
- !$skipFirstTemplatePage
- );
- $templatesBreadcrumbs = $this->breadcrumbsHelper->getBreadcrumbsForTemplates($templatePath, !$skipFirstTemplatePage);
+ $templatesBreadcrumbs = $this->breadcrumbsHelper->getBreadcrumbs($templatePath);
+ foreach ($templatesBreadcrumbs as $k => $breadcrumb) {
+ $templatesBreadcrumbs[$k]['url'] = calculate_relative_url($docUrl, $breadcrumb['url']);
+ }
+
+ $content = $this->breadcrumbsTwig->render('breadcrumbs.md.twig', [
+ 'currentPageTitle' => $currentPageTitle,
+ 'breadcrumbs' => $templatesBreadcrumbs,
+ ]);
+
+ $templatesBreadcrumbs = $this->breadcrumbsHelper->getBreadcrumbsForTemplates($templatePath);
foreach ($templatesBreadcrumbs as $templateBreadcrumb) {
$fileDependency = $this->dependencyFactory->createFileDependency(
filePath: $templateBreadcrumb['template'],
@@ -75,6 +76,6 @@ public function __invoke(
$this->rendererContext->addDependency($fileDependency);
}
- return "";
+ return $content;
}
}
diff --git a/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php b/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php
new file mode 100644
index 00000000..72f1f4b9
--- /dev/null
+++ b/src/Core/Renderer/Twig/Function/DrawPageBreadcrumbs.php
@@ -0,0 +1,91 @@
+ ['html'],
+ 'needs_context' => true,
+ ];
+ }
+
+ /**
+ * @param array $context
+ * @param string|null $customPageTitle Custom title of the current page
+ *
+ * @return string
+ * @throws DependencyException
+ * @throws InvalidConfigurationParameterException
+ * @throws LoaderError
+ * @throws NotFoundException
+ * @throws RuntimeError
+ * @throws SyntaxError
+ */
+ public function __invoke(
+ array $context,
+ ?string $customPageTitle = null
+ ): string {
+
+ $templatePath = $context[MainTwigEnvironment::CURRENT_TEMPLATE_NAME_KEY] ?? '';
+ $docUrl = $this->configuration->getOutputDirBaseUrl() . $templatePath;
+ $breadcrumbs = $this->breadcrumbsHelper->getBreadcrumbs($templatePath, false);
+ foreach ($breadcrumbs as $k => $breadcrumb) {
+ $breadcrumbs[$k]['url'] = calculate_relative_url($docUrl, $breadcrumb['url']);
+ }
+
+ $currentPageTitle = $customPageTitle ?: $this->breadcrumbsHelper->getTemplateTitle($templatePath);
+ $content = $this->breadcrumbsTwig->render('breadcrumbs.md.twig', [
+ 'currentPageTitle' => $currentPageTitle,
+ 'breadcrumbs' => $breadcrumbs,
+ ]);
+
+ $templatesBreadcrumbs = $this->breadcrumbsHelper->getBreadcrumbsForTemplates($templatePath);
+ foreach ($templatesBreadcrumbs as $templateBreadcrumb) {
+ $fileDependency = $this->dependencyFactory->createFileDependency(
+ filePath: $templateBreadcrumb['template'],
+ contentFilterRegex: '/^---([^-]+)(---)/',
+ matchIndex: 1
+ );
+ $this->rendererContext->addDependency($fileDependency);
+ }
+
+ return $content;
+ }
+}
diff --git a/src/Core/Renderer/Twig/Function/FileGetContents.php b/src/Core/Renderer/Twig/Function/FileGetContents.php
index 659e1263..88915bdd 100644
--- a/src/Core/Renderer/Twig/Function/FileGetContents.php
+++ b/src/Core/Renderer/Twig/Function/FileGetContents.php
@@ -16,7 +16,7 @@
*/
final class FileGetContents implements CustomFunctionInterface
{
- public function __construct(private ConfigurationParameterBag $parameterBag)
+ public function __construct(private readonly ConfigurationParameterBag $parameterBag)
{
}
diff --git a/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php b/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php
index 15c22fa2..90309477 100644
--- a/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php
+++ b/src/Core/Renderer/Twig/Function/GetDocumentationPageUrl.php
@@ -23,8 +23,8 @@ final class GetDocumentationPageUrl implements CustomFunctionInterface
public const DEFAULT_URL = '#';
public function __construct(
- private BreadcrumbsHelper $breadcrumbsHelper,
- private LoggerInterface $logger,
+ private readonly BreadcrumbsHelper $breadcrumbsHelper,
+ private readonly LoggerInterface $logger,
) {
}
diff --git a/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php b/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php
index 925b6e5f..6d1657f8 100644
--- a/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php
+++ b/src/Core/Renderer/Twig/Function/GetDocumentedEntityUrl.php
@@ -12,10 +12,13 @@
use BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection;
use BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface;
use BumbleDocGen\Core\Renderer\RendererHelper;
+use BumbleDocGen\Core\Renderer\Twig\MainTwigEnvironment;
use DI\DependencyException;
use DI\NotFoundException;
use Monolog\Logger;
+use function BumbleDocGen\Core\calculate_relative_url;
+
/**
* Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called,
* the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
@@ -39,10 +42,10 @@ final class GetDocumentedEntityUrl implements CustomFunctionInterface
public const DEFAULT_URL = '#';
public function __construct(
- private RendererHelper $rendererHelper,
- private DocumentedEntityWrappersCollection $documentedEntityWrappersCollection,
- private Configuration $configuration,
- private Logger $logger
+ private readonly RendererHelper $rendererHelper,
+ private readonly DocumentedEntityWrappersCollection $documentedEntityWrappersCollection,
+ private readonly Configuration $configuration,
+ private readonly Logger $logger
) {
}
@@ -55,10 +58,12 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
/**
+ * @param array $context
* @param RootEntityCollection $rootEntityCollection Processed entity collection
* @param string $entityName
* The full name of the entity for which the URL will be retrieved.
@@ -73,8 +78,34 @@ public static function getOptions(): array
* @throws InvalidConfigurationParameterException
* @throws NotFoundException
*/
- public function __invoke(RootEntityCollection $rootEntityCollection, string $entityName, string $cursor = '', bool $createDocument = true): string
- {
+ public function __invoke(
+ array $context,
+ RootEntityCollection $rootEntityCollection,
+ string $entityName,
+ string $cursor = '',
+ bool $createDocument = true
+ ): string {
+ return $this->process(
+ $rootEntityCollection,
+ $entityName,
+ $cursor,
+ $createDocument,
+ $context[MainTwigEnvironment::CURRENT_TEMPLATE_NAME_KEY] ?? null,
+ );
+ }
+
+ /**
+ * @throws NotFoundException
+ * @throws DependencyException
+ * @throws InvalidConfigurationParameterException
+ */
+ public function process(
+ RootEntityCollection $rootEntityCollection,
+ string $entityName,
+ string $cursor = '',
+ bool $createDocument = true,
+ ?string $callingTemplate = null
+ ): string {
if (str_contains($entityName, ' ')) {
return self::DEFAULT_URL;
}
@@ -90,13 +121,20 @@ public function __invoke(RootEntityCollection $rootEntityCollection, string $ent
$documentedEntity = $this->documentedEntityWrappersCollection->createAndAddDocumentedEntityWrapper($entity);
$rootEntityCollection->add($entity);
$url = $this->configuration->getPageLinkProcessor()->getAbsoluteUrl($documentedEntity->getDocUrl());
+ $url = $url . $entity->cursorToDocAttributeLinkFragment($cursor);
+
+ if ($callingTemplate) {
+ $callingTemplate = "{$this->configuration->getOutputDirBaseUrl()}{$callingTemplate}";
+ $url = calculate_relative_url($callingTemplate, $url);
+ }
} else {
$url = $entity->getFileSourceLink(false);
+ $url = $url . $entity->cursorToDocAttributeLinkFragment($cursor, false);
}
if (!$url) {
return self::DEFAULT_URL;
}
- return $url . $entity->cursorToDocAttributeLinkFragment($cursor);
+ return $url;
} else {
$this->logger->warning(
"GetDocumentedEntityUrl: Entity {$entityName} not found in specified sources"
diff --git a/src/Core/Renderer/Twig/Function/LoadPluginsContent.php b/src/Core/Renderer/Twig/Function/LoadPluginsContent.php
index 2599c7eb..a9118bf6 100644
--- a/src/Core/Renderer/Twig/Function/LoadPluginsContent.php
+++ b/src/Core/Renderer/Twig/Function/LoadPluginsContent.php
@@ -17,7 +17,7 @@
*/
final class LoadPluginsContent implements CustomFunctionInterface
{
- public function __construct(private PluginEventDispatcher $pluginEventDispatcher)
+ public function __construct(private readonly PluginEventDispatcher $pluginEventDispatcher)
{
}
diff --git a/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php b/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php
index 6b0a70ed..d0c743ec 100644
--- a/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php
+++ b/src/Core/Renderer/Twig/Function/PrintEntityCollectionAsList.php
@@ -6,9 +6,10 @@
use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException;
use BumbleDocGen\Core\Parser\Entity\RootEntityCollection;
+use BumbleDocGen\Core\Renderer\Twig\Filter\RemoveLineBrakes;
/**
- * Outputting entity data as HTML list
+ * Outputting entity data as MD list
*
* @note This function initiates the creation of documents for the displayed entities
*
@@ -20,8 +21,10 @@
*/
final class PrintEntityCollectionAsList implements CustomFunctionInterface
{
- public function __construct(private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction)
- {
+ public function __construct(
+ private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
+ private readonly RemoveLineBrakes $removeLineBrakes
+ ) {
}
public static function getName(): string
@@ -33,35 +36,41 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
/**
+ * @param array $context
* @param RootEntityCollection $rootEntityCollection Processed entity collection
* @param string $type List tag type (/)
* @param bool $skipDescription Don't print description of this entities
* @param bool $useFullName Use the full name of the entity in the list
* @return string
- * @throws InvalidConfigurationParameterException
*/
public function __invoke(
+ array $context,
RootEntityCollection $rootEntityCollection,
string $type = 'ul',
bool $skipDescription = false,
bool $useFullName = false,
): string {
- $result = "<{$type}>";
+ $result = '';
+ $prefix = '1. ';
+ if ($type === 'ul') {
+ $prefix = '- ';
+ }
foreach ($rootEntityCollection as $entity) {
$description = $entity->getDescription();
- $descriptionText = !$skipDescription && $description ? " - {$description}" : '';
+ $descriptionText = call_user_func($this->removeLineBrakes, !$skipDescription && $description ? " - {$description}" : '');
$entityDocUrl = call_user_func_array($this->getDocumentedEntityUrlFunction, [
+ $context,
$rootEntityCollection,
$entity->getName()
]);
$name = $useFullName ? $entity->getName() : $entity->getShortName();
- $result .= "- {$name}{$descriptionText}
";
+ $result .= "{$prefix} [{$name}]({$entityDocUrl}){$descriptionText}\n";
}
- $result .= "{$type}>";
- return "";
+ return $result;
}
}
diff --git a/src/Core/Renderer/Twig/MainTwigEnvironment.php b/src/Core/Renderer/Twig/MainTwigEnvironment.php
index e691f8f9..b8e2ec4d 100644
--- a/src/Core/Renderer/Twig/MainTwigEnvironment.php
+++ b/src/Core/Renderer/Twig/MainTwigEnvironment.php
@@ -17,7 +17,7 @@
final class MainTwigEnvironment
{
- public const TMP_TEMPLATE_PREFIX = '~bumbleDocGen';
+ public const CURRENT_TEMPLATE_NAME_KEY = '__templateName';
private Environment $twig;
private bool $isEnvLoaded = false;
@@ -78,6 +78,7 @@ public function render($name, array $context = []): string
$reflectionProperty->setValue($this->twig, "__TwigTemplate_" . md5($this->twigTemplatePrefixKey));
}
+ $context[self::CURRENT_TEMPLATE_NAME_KEY] = $name;
return $this->twig->render($name, $context);
}
}
diff --git a/src/Core/utils.php b/src/Core/utils.php
index b665d2e2..b01019a8 100644
--- a/src/Core/utils.php
+++ b/src/Core/utils.php
@@ -19,3 +19,23 @@ function get_class_short(string $className): string
return end($classNameParts);
}
}
+
+if (!function_exists('BumbleDocGen\Core\calculate_relative_url')) {
+ function calculate_relative_url(string $from, string $to): string
+ {
+ $from = explode('/', $from);
+ $to = explode('/', $to);
+
+ array_pop($from);
+ $toFileName = array_pop($to);
+
+ $commonParts = array_intersect_assoc($from, $to);
+ $diffFrom = array_diff_assoc($from, $commonParts);
+
+ $wayToCommonPath = implode('/', array_fill(0, count($diffFrom), '..'));
+ $diffTo = array_diff_assoc($to, $commonParts);
+ $newPath = $diffTo ? implode('/', $diffTo) . '/' . $toFileName : $toFileName;
+
+ return ltrim("{$wayToCommonPath}/{$newPath}", '/');
+ }
+}
diff --git a/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php b/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php
index 332d998b..26ba5ebf 100644
--- a/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php
+++ b/src/LanguageHandler/Php/Parser/Entity/BaseEntity.php
@@ -23,6 +23,8 @@
use BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings;
use BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsEntityCanBeLoaded;
use DI\Attribute\Inject;
+use DI\DependencyException;
+use DI\NotFoundException;
use phpDocumentor\Reflection\DocBlock;
use Psr\Cache\InvalidArgumentException;
use Psr\Log\LoggerInterface;
@@ -271,15 +273,20 @@ public function isDeprecated(): bool
*/
public function hasDescriptionLinks(): bool
{
- return count($this->getDescriptionDocBlockLinks()) > 0;
+ return count($this->getDescriptionLinks()) > 0;
}
/**
+ * Get parsed links from description and doc blocks `see` and `link`
+ *
* @return DocBlockLink[]
*
+ * @api
+ *
+ * @throws InvalidConfigurationParameterException
* @throws \Exception
*/
- #[CacheableMethod] protected function getDescriptionDocBlockLinks(): array
+ #[CacheableMethod] public function getDescriptionLinks(): array
{
$links = [];
$docBlock = $this->getDocBlock();
@@ -406,22 +413,6 @@ className: $className,
return $links;
}
- /**
- * Get parsed links from description and doc blocks `see` and `link`
- *
- * @return DocBlockLink[]
- *
- * @api
- *
- * @throws InvalidConfigurationParameterException
- * @throws \Exception
- */
- public function getDescriptionLinks(): array
- {
- $linksData = $this->getDescriptionDocBlockLinks();
- return $this->getPreparedDocBlockLinks($linksData);
- }
-
/**
* Checking if an entity has `throws` docBlock
*
@@ -436,11 +427,15 @@ public function hasThrows(): bool
}
/**
+ * Get parsed throws from `throws` doc block
+ *
* @return DocBlockLink[]
*
+ * @api
+ *
* @throws InvalidConfigurationParameterException
*/
- #[CacheableMethod] public function getThrowsDocBlockLinks(): array
+ #[CacheableMethod] public function getThrows(): array
{
$throws = [];
$implementingClassEntity = $this->getDocCommentEntity()->getCurrentRootEntity();
@@ -473,86 +468,6 @@ className: $className,
return $throws;
}
- /**
- * Get parsed throws from `throws` doc block
- *
- * @return DocBlockLink[]
- *
- * @api
- *
- * @throws InvalidConfigurationParameterException
- */
- public function getThrows(): array
- {
- $throwsData = $this->getThrowsDocBlockLinks();
- return $this->getPreparedDocBlockLinks($throwsData);
- }
-
- /**
- * @param DocBlockLink[] $docBlockLinks
- *
- * @return DocBlockLink[]
- *
- * @throws InvalidConfigurationParameterException
- */
- private function getPreparedDocBlockLinks(array $docBlockLinks): array
- {
- $preparedDocBlockLinksLinks = [];
- foreach ($docBlockLinks as $data) {
- if ($data->url) {
- $preparedDocBlockLinksLinks[] = $data;
- continue;
- }
-
- $className = $data->className;
- $name = $data->name;
- $url = null;
- if ($data->className) {
- $entityData = $this->getRootEntityCollection()->getEntityLinkData(
- $data->className,
- $this->getImplementingClass()->getName(),
- false
- );
- if (!$entityData['entityName'] && !str_contains($data->className, '\\')) {
- try {
- $className = $this->getDocCommentEntity()->getCurrentRootEntity()->getNamespaceName() . "\\{$data->className}";
- $entityData = $this->getRootEntityCollection()->getEntityLinkData(
- $className,
- $this->getDocCommentEntity()->getCurrentRootEntity()->getName(),
- false
- );
- } catch (\Exception $e) {
- $this->logger->error($e->getMessage());
- }
- }
-
- if ($entityData['entityName']) {
- $url = call_user_func(
- $this->documentedEntityUrlFunction,
- $this->getRootEntityCollection(),
- $entityData['entityName'],
- $entityData['cursor']
- );
- } else {
- $preloadResourceLink = $this->rendererHelper->getPreloadResourceLink($data->className);
- if ($preloadResourceLink) {
- $url = $preloadResourceLink;
- } else {
- $this->logger->warning("Unable to get URL data for entity `{$data->className}`");
- }
- }
- $name = $entityData['title'];
- }
- $preparedDocBlockLinksLinks[] = new DocBlockLink(
- name: $name,
- description: $data->description,
- className: $className,
- url: $url
- );
- }
- return $preparedDocBlockLinksLinks;
- }
-
/**
* Checking if an entity has `example` docBlock
*
diff --git a/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php b/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php
index 59e2a776..311857d3 100644
--- a/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php
+++ b/src/LanguageHandler/Php/Parser/Entity/SubEntity/ClassConstant/ClassConstantEntity.php
@@ -15,6 +15,7 @@
use BumbleDocGen\LanguageHandler\Php\Parser\PhpParser\NodeValueCompiler;
use PhpParser\ConstExprEvaluationException;
use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\PrettyPrinter\Standard;
use Psr\Log\LoggerInterface;
/**
@@ -53,12 +54,12 @@ class ClassConstantEntity extends BaseEntity
public function __construct(
Configuration $configuration,
- private ClassLikeEntity $classEntity,
+ private readonly ClassLikeEntity $classEntity,
ParserHelper $parserHelper,
LocalObjectCache $localObjectCache,
- LoggerInterface $logger,
- private string $constantName,
- private string $implementingClassName,
+ private readonly LoggerInterface $logger,
+ private readonly string $constantName,
+ private readonly string $implementingClassName,
) {
parent::__construct(
$configuration,
@@ -158,6 +159,64 @@ public function getNamespaceName(): string
return $this->getRootEntity()->getNamespaceName();
}
+ /**
+ * Get a text representation of class constant modifiers
+ *
+ * @api
+ *
+ * @throws InvalidConfigurationParameterException
+ */
+ #[CacheableMethod] public function getModifiersString(): string
+ {
+ $modifiersString = [];
+ if ($this->isPrivate()) {
+ $modifiersString[] = 'private';
+ } elseif ($this->isProtected()) {
+ $modifiersString[] = 'protected';
+ } elseif ($this->isPublic()) {
+ $modifiersString[] = 'public';
+ }
+
+ $modifiersString[] = $this->getType();
+ return implode(' ', $modifiersString);
+ }
+
+ /**
+ * Get current class constant type
+ *
+ * @api
+ *
+ * @throws InvalidConfigurationParameterException
+ */
+ #[CacheableMethod] public function getType(): string
+ {
+ $type = $this->getAst()->type;
+ if ($type) {
+ $astPrinter = new Standard();
+ $typeString = $astPrinter->prettyPrint([$type]);
+ $typeString = str_replace('?', 'null|', $typeString);
+ } else {
+ try {
+ $typeString = gettype($this->getValue());
+ } catch (\Exception) {
+ $typeString = 'mixed';
+ $docBlock = $this->getDocBlock();
+ $typesFromDoc = [];
+ foreach ($docBlock->getTagsByName('var') as $param) {
+ try {
+ $typesFromDoc[] = (string)$param->getType();
+ } catch (\Exception $e) {
+ $this->logger->error($e->getMessage());
+ }
+ }
+ if ($typesFromDoc) {
+ $typeString = implode('|', $typesFromDoc);
+ }
+ }
+ }
+ return $this->prepareTypeString($typeString);
+ }
+
/**
* Check if a constant is a public constant
*
diff --git a/src/LanguageHandler/Php/PhpHandlerSettings.php b/src/LanguageHandler/Php/PhpHandlerSettings.php
index 10cd084b..90b55844 100644
--- a/src/LanguageHandler/Php/PhpHandlerSettings.php
+++ b/src/LanguageHandler/Php/PhpHandlerSettings.php
@@ -24,8 +24,8 @@ final class PhpHandlerSettings
public const DEFAULT_SETTINGS_FILE = __DIR__ . '/phpHandlerDefaultSettings.yaml';
public function __construct(
- private ConfigurationParameterBag $parameterBag,
- private LocalObjectCache $localObjectCache
+ private readonly ConfigurationParameterBag $parameterBag,
+ private readonly LocalObjectCache $localObjectCache
) {
$parameterBag->addValueFromFileIfNotExists('', self::DEFAULT_SETTINGS_FILE);
}
@@ -154,6 +154,29 @@ public function getFileSourceBaseUrl(): ?string
return $fileSourceBaseUrl;
}
+ /**
+ * If `true` - parameters and properties in class documents refer to generated documents and not to external sources
+ *
+ * @throws InvalidConfigurationParameterException
+ */
+ public function getPropRefsInternalLinksMode(): bool
+ {
+ try {
+ return $this->localObjectCache->getMethodCachedResult(__METHOD__, '');
+ } catch (ObjectNotFoundException) {
+ }
+ $propRefsInternalLinksMode = $this->parameterBag->validateAndGetBooleanValue(
+ $this->getSettingsKey('prop_refs_internal_links_mode')
+ );
+ $this->localObjectCache->cacheMethodResult(__METHOD__, '', $propRefsInternalLinksMode);
+ return $propRefsInternalLinksMode;
+ }
+
+ final public function changePropRefsInternalLinksMode(bool $propRefsInternalLinksMode): void
+ {
+ $this->localObjectCache->cacheMethodResult(__CLASS__ . '::getPropRefsInternalLinksMode', '', $propRefsInternalLinksMode);
+ }
+
/**
* @throws InvalidConfigurationParameterException
*/
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php
index 08fbf021..e047a5ba 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/Daux.php
@@ -14,6 +14,7 @@
use BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath;
use BumbleDocGen\Core\Plugin\PluginInterface;
use BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper;
+use BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings;
/**
* @internal
@@ -25,8 +26,10 @@ final class Daux implements PluginInterface
public function __construct(
private readonly Configuration $configuration,
- private readonly BreadcrumbsHelper $breadcrumbsHelper
+ private readonly BreadcrumbsHelper $breadcrumbsHelper,
+ PhpHandlerSettings $phpHandlerSettings
) {
+ $phpHandlerSettings->changePropRefsInternalLinksMode(true);
}
public static function getSubscribedEvents(): array
@@ -53,14 +56,16 @@ final public function beforeCreatingDocFile(BeforeCreatingDocFile|BeforeCreating
);
// MD links are not always converted to HTML correctly. This hack fixes that
- $content = preg_replace('/\[([^\[]+)\]\((.*)\)/', '$1', $content);
+ $content = preg_replace('/\[([^\[]+)\]\(([^)]+)(\))/', '$1', $content);
// Hack to make images work in generated HTML
$content = preg_replace_callback('/(src=("|\')\/)([^"\']+)/', function (array $elements): string {
return explode('?', $elements[0])[0];
}, $content);
- $content = preg_replace('/(\/readme.md)("|\')/i', '/index.md$2', $content);
+ $content = preg_replace('/(\/readme.md)("|\')(>)/i', '/index.md$2>', $content);
+ $content = preg_replace('/("|\')(readme.md)("|\')(>)/i', '$1index.md$1>', $content);
+
$event->setContent($content);
$outputFileName = $event->getOutputFilePatch();
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Entities_Map.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Entities_Map.md.twig
index 3b9bc477..e1ab12fc 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Entities_Map.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Entities_Map.md.twig
@@ -2,8 +2,8 @@
title: Project entities map
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Entities map" | textToHeading('H1') }}
+# Entities map
{{ drawClassMap( phpEntities ) }}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Classes.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Classes.md.twig
index af6001a4..8823806a 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Classes.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Classes.md.twig
@@ -2,9 +2,9 @@
title: Project classes
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project classes" | textToHeading('H1') }}
+# Project classes
Name | Namespace |
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Interfaces.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Interfaces.md.twig
index 43c47edc..1174f6a7 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Interfaces.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Interfaces.md.twig
@@ -2,9 +2,9 @@
title: Project interfaces
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project interfaces" | textToHeading('H1') }}
+# Project interfaces
Name | Namespace |
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Traits.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Traits.md.twig
index a380c2e3..a8ce20be 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Traits.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/Project_Traits.md.twig
@@ -2,9 +2,9 @@
title: Project traits
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project traits" | textToHeading('H1') }}
+# Project traits
Name | Namespace |
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/index.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/index.md.twig
index 93a96255..6a795e55 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/index.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/Daux/templates/-Project_Structure/index.md.twig
@@ -2,9 +2,9 @@
title: Project structure
prevPage: /
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project structure" | textToHeading('H1') }}
+# Project structure
* Interfaces
* Classes
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php
index ed17c712..171fbb07 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/EntityDocUnifiedPlacePlugin.php
@@ -8,6 +8,7 @@
use BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper;
use BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath;
use BumbleDocGen\Core\Plugin\PluginInterface;
+use BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings;
/**
* This plugin changes the algorithm for saving entity documents. The standard system stores each file
@@ -19,6 +20,12 @@ final class EntityDocUnifiedPlacePlugin implements PluginInterface
private const TEMPLATES_FOLDER = __DIR__ . DIRECTORY_SEPARATOR . 'templates';
public const ENTITY_DOC_STRUCTURE_DIR_NAME = '__structure';
+ public function __construct(
+ PhpHandlerSettings $phpHandlerSettings
+ ) {
+ $phpHandlerSettings->changePropRefsInternalLinksMode(true);
+ }
+
public static function getSubscribedEvents(): array
{
return [
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/classes.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/classes.md.twig
index af6001a4..8823806a 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/classes.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/classes.md.twig
@@ -2,9 +2,9 @@
title: Project classes
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project classes" | textToHeading('H1') }}
+# Project classes
Name | Namespace |
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/interfaces.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/interfaces.md.twig
index 43c47edc..1174f6a7 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/interfaces.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/interfaces.md.twig
@@ -2,9 +2,9 @@
title: Project interfaces
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project interfaces" | textToHeading('H1') }}
+# Project interfaces
Name | Namespace |
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/map.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/map.md.twig
index 3b9bc477..e1ab12fc 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/map.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/map.md.twig
@@ -2,8 +2,8 @@
title: Project entities map
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Entities map" | textToHeading('H1') }}
+# Entities map
{{ drawClassMap( phpEntities ) }}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/readme.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/readme.md.twig
index 93a96255..6a795e55 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/readme.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/readme.md.twig
@@ -2,9 +2,9 @@
title: Project structure
prevPage: /
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project structure" | textToHeading('H1') }}
+# Project structure
* Interfaces
* Classes
diff --git a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/traits.md.twig b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/traits.md.twig
index a380c2e3..a8ce20be 100644
--- a/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/traits.md.twig
+++ b/src/LanguageHandler/Php/Plugin/CorePlugin/EntityDocUnifiedPlace/templates/__structure/traits.md.twig
@@ -2,9 +2,9 @@
title: Project traits
prevPage: Project structure
---
-{{ generatePageBreadcrumbs(title, _self) }}
+{{ drawPageBreadcrumbs() }}
-{{ "Project traits" | textToHeading('H1') }}
+# Project traits
Name | Namespace |
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassRendererTwigEnvironment.php b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassRendererTwigEnvironment.php
index 48edf8f5..db1071a8 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassRendererTwigEnvironment.php
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassRendererTwigEnvironment.php
@@ -4,6 +4,7 @@
namespace BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\PhpClassToMd;
+use BumbleDocGen\Core\Renderer\Twig\Function\DrawEntityBreadcrumbs;
use BumbleDocGen\Core\Renderer\Twig\MainExtension;
use Twig\Environment;
use Twig\Error\LoaderError;
@@ -15,13 +16,20 @@ final class PhpClassRendererTwigEnvironment
{
private Environment $twig;
- public function __construct(MainExtension $mainExtension)
- {
+ public function __construct(
+ MainExtension $mainExtension,
+ DrawEntityBreadcrumbs $drawEntityBreadcrumbsFunction
+ ) {
$loader = new FilesystemLoader([
__DIR__ . '/templates',
]);
$this->twig = new Environment($loader);
$this->twig->addExtension($mainExtension);
+ $this->twig->addFunction(new \Twig\TwigFunction(
+ $drawEntityBreadcrumbsFunction->getName(),
+ $drawEntityBreadcrumbsFunction,
+ $drawEntityBreadcrumbsFunction->getOptions()
+ ));
}
/**
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassToMdDocRenderer.php b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassToMdDocRenderer.php
index 908297ff..f1942cb4 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassToMdDocRenderer.php
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/PhpClassToMdDocRenderer.php
@@ -4,10 +4,14 @@
namespace BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\PhpClassToMd;
+use BumbleDocGen\Core\Configuration\Configuration;
+use BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException;
use BumbleDocGen\Core\Parser\Entity\RootEntityInterface;
use BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
use BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;
+use BumbleDocGen\Core\Renderer\Twig\MainTwigEnvironment;
use BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassLikeEntity;
+use BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings;
use Twig\Error\LoaderError;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
@@ -22,7 +26,9 @@ class PhpClassToMdDocRenderer implements EntityDocRendererInterface
public const BLOCK_BEFORE_DETAILS = 'before_details';
public function __construct(
- private PhpClassRendererTwigEnvironment $classRendererTwig
+ private readonly PhpClassRendererTwigEnvironment $classRendererTwig,
+ private readonly Configuration $configuration,
+ private readonly PhpHandlerSettings $phpHandlerSettings
) {
}
@@ -45,12 +51,16 @@ public function isAvailableForEntity(RootEntityInterface $entity): bool
* @throws RuntimeError
* @throws SyntaxError
* @throws LoaderError
+ * @throws InvalidConfigurationParameterException
*/
public function getRenderedText(DocumentedEntityWrapper $entityWrapper): string
{
return $this->classRendererTwig->render('class.md.twig', [
'classEntity' => $entityWrapper->getDocumentTransformableEntity(),
- 'parentDocFilePath' => $entityWrapper->getParentDocFilePath()
+ 'parentDocFilePath' => $entityWrapper->getParentDocFilePath(),
+ 'docUrl' => $this->configuration->getOutputDirBaseUrl() . $entityWrapper->getDocUrl(),
+ MainTwigEnvironment::CURRENT_TEMPLATE_NAME_KEY => $entityWrapper->getDocUrl() . '.twig',
+ 'propRefsInternalLinksMode' => $this->phpHandlerSettings->getPropRefsInternalLinksMode()
]);
}
}
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classHeader.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classHeader.md.twig
index c6ec5b81..7d2dbf99 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classHeader.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classHeader.md.twig
@@ -1,3 +1 @@
-
- {{ classEntity.getShortName() }} {% if classEntity.isEnum() %}enum{% else %}class{% endif %}:
-
\ No newline at end of file
+# [{{ classEntity.getShortName() }}]({{ classEntity.getFileSourceLink() }}) {% if classEntity.isEnum() %}enum{% else %}class{% endif %}:
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classMainInfo.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classMainInfo.md.twig
index 30e6a61f..5a7c8a06 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classMainInfo.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_classMainInfo.md.twig
@@ -1,5 +1,5 @@
-{% if classEntity.isInternal() %}:warning: Is internal{% endif %}
-{% if classEntity.isDeprecated() %}:no_entry: Deprecated{% endif %}
+{% if classEntity.isInternal() %}⚠️ Internal {% endif %}
+{% if classEntity.isDeprecated() %}⛔ Deprecated{% endif %}
```php
{% if classEntity.getNamespaceName() %}
@@ -9,29 +9,23 @@ namespace {{ classEntity.getNamespaceName() }};
{{ classEntity.getModifiersString() }} {{ classEntity.getShortName() }}{% if classEntity.isInterface() and classEntity.getInterfaceNames() %} extends \{{ classEntity.getInterfaceNames() | implode(', \\') }}{% else %}{% if classEntity.getParentClassName() %} extends \{{ classEntity.getParentClassName() }}{% endif %}{% if classEntity.getInterfaceNames() %} implements \{{ classEntity.getInterfaceNames() | implode(', \\') }}{% endif %}{% endif %}
```
-
-{% if classEntity.getDescription() %}{{ classEntity.getDescription() | raw }}
{% endif %}
-
+{% if classEntity.getDescription() %}
+{{ classEntity.getDescription() | raw }}
+{% endif %}
{% if classEntity.hasDescriptionLinks() %}
-See:
-
+***Links:***
{% for link in classEntity.getDescriptionLinks() %}
- -
- {{ link.name }}{% if link.description %} - {{ link.description | removeLineBrakes }} {% endif %}
-
+- {% if link.url %}[{{ link.name }}]({{ link.url }}){% elseif link.className %}{{ link.className|strTypeToUrl(classEntity.getRootEntityCollection(), false, true) }}{% else %}{{ link.name }}{% endif %}{% if link.description %} - {{ link.description | removeLineBrakes }} {% endif %}
+
{% endfor %}
-
{% endif %}
{% if classEntity.hasExamples() %}
-
-Examples of using:
+***Examples of using:***
{% for exampleData in classEntity.getExamples() %}
-
```php
{{ exampleData.example | raw }}
-
```
{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_constants.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_constants.md.twig
index 4229f14c..c3307f59 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_constants.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_constants.md.twig
@@ -1,12 +1,8 @@
-{% if not classEntity.getConstantEntitiesCollection().isEmpty() %}
-Constants:
-
- {% for constantEntity in classEntity.getConstantEntitiesCollection() %}
- - #
-
{{ constantEntity.getName() }}
{% if constantEntity.isInternal() %}:warning: Is internal {% endif %} {% if constantEntity.isDeprecated() %}:no_entry: Deprecated {% endif %} {% if constantEntity.getRelativeFileName() %}
- | source
- code {% endif %}
- {% endfor %}
-
+{% if not classEntity.getPropertyEntitiesCollection().isEmpty() %}
+## Constants:
+
+{% for constantEntity in classEntity.getConstantEntitiesCollection() %}
+1. {{ constantEntity.getModifiersString() }} {% if constantEntity.isDeprecated() %}~~`{{ constantEntity.getName() }}`~~{% else %}`{{ constantEntity.getName() }}`{% endif %} {% if constantEntity.getDescription() %}- {{ constantEntity.getDescription() | removeLineBrakes | raw }}{% endif %}
+
+{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_enumCases.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_enumCases.md.twig
index 33a20242..5711ba09 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_enumCases.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_enumCases.md.twig
@@ -1,9 +1,8 @@
{% if classEntity.getCasesNames() %}
-Cases:
+## Cases:
-
- {% for caseName in classEntity.getCasesNames() %}
- - {{ caseName }}
- {% endfor %}
-
+{% for caseName in classEntity.getCasesNames() %}
+1. **{{ caseName }}**
+
+{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_method_details.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_method_details.md.twig
index ce1a5da2..d72ae9ba 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_method_details.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_method_details.md.twig
@@ -1,15 +1,8 @@
{% if not methodEntitiesCollection.isEmpty() %}
-Method details:
-
+## Methods details:
{% for methodEntity in methodEntitiesCollection %}
-
-
-- #
- {{ methodEntity.getName() }}
- {% if methodEntity.isInternal() %}:warning: Is internal {% endif %} {% if methodEntity.isDeprecated() %}:no_entry: Deprecated {% endif %}
- {% if methodEntity.getFileSourceLink() %} | source code{% endif %}
-
+
# `{{ methodEntity.getName() }}` {% if methodEntity.isInternal() %}⚠️ Internal {% endif %} {% if methodEntity.isDeprecated() %}⛔ Deprecated {% endif %}{% if methodEntity.getFileSourceLink() %}**|** [source code]({{ methodEntity.getFileSourceLink() }}){% endif %}
```php
{% if methodEntity.isImplementedInParentClass() %}
@@ -22,80 +15,41 @@
{% endif %}
{{ methodEntity.getModifiersString() | raw }} {{ methodEntity.getName() }}({{ methodEntity.getParametersString() | raw }}){% if not methodEntity.isConstructor() %}: {{ methodEntity.getReturnType() | raw }}{% endif %};
```
-
-{% if methodEntity.getDescription() %}
{{ methodEntity.getDescription() }}
{% endif %}
-
-
-{% if methodEntity.getParameters() %}
-
Parameters:
-
-
-
-
- Name |
- Type |
- Description |
-
-
-
- {% for parameter in methodEntity.getParameters() %}
-
- ${{ parameter.name }}{% if parameter.isVariadic %} (variadic){% endif %} |
- {{ parameter.expectedType | strTypeToUrl(methodEntity.getRootEntityCollection()) }} |
- {% if parameter.description %}{{ parameter.description | addIndentFromLeft(1, true) }}{% else %}-{% endif %} |
-
- {% endfor %}
-
-
-{% else %}
-
Parameters: not specified
-{% endif %}
-
-{% if not methodEntity.isConstructor() %}
-{% if methodEntity.getReturnType() %}
-
Return value: {{ methodEntity.getReturnType() | strTypeToUrl(methodEntity.getRootEntityCollection()) }}
-{% else %}
-
Return value: not specified
-{% endif %}
+{% if methodEntity.getDescription() %}
+{{ methodEntity.getDescription() | raw }}
{% endif %}
+{% if methodEntity.getParameters() %}
-{% if methodEntity.hasThrows() %}
-
-
Throws:
-
-{% for throw in methodEntity.getThrows() %}
--
- {{ throw.name }}{% if throw.description %} - {{ throw.description | removeLineBrakes }} {% endif %}
-
+***Parameters:***
+| Name | Type | Description |
+|:-|:-|:-|
+{% for parameter in methodEntity.getParameters() %}
+${{ parameter.name }}{% if parameter.isVariadic %} (variadic){% endif %} | {{ parameter.expectedType | strTypeToUrl(methodEntity.getRootEntityCollection(), false, propRefsInternalLinksMode, ' \\| ') }} | {% if parameter.description %}{{ parameter.description | addIndentFromLeft(1, true) }}{% else %}-{% endif %} |
{% endfor %}
-
{% endif %}
+{% if not methodEntity.isConstructor() and methodEntity.getReturnType() %}
+***Return value:*** {{ methodEntity.getReturnType() | strTypeToUrl(methodEntity.getRootEntityCollection(), false, propRefsInternalLinksMode) }}
+{% endif %}
{% if methodEntity.hasDescriptionLinks() %}
-
See:
-
+***Links:***
{% for link in methodEntity.getDescriptionLinks() %}
- -
- {{ link.name }}{% if link.description %} - {{ link.description | removeLineBrakes }} {% endif %}
-
+- {% if link.url %}[{{ link.name }}]({{ link.url }}){% elseif link.className %}{{ link.className|strTypeToUrl(classEntity.getRootEntityCollection(), false, true) }}{% else %}{{ link.name }}{% endif %}{% if link.description %} - {{ link.description | removeLineBrakes }} {% endif %}
+
{% endfor %}
-
{% endif %}
{% if methodEntity.hasExamples() %}
-
-
Examples of using:
-
+***Examples of using:***
{% for exampleData in methodEntity.getExamples() %}
```php
{{ exampleData.example | raw }}
```
-
{% endfor %}
{% endif %}
-
-
+
+---
{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_methods.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_methods.md.twig
index aba10500..a691f247 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_methods.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_methods.md.twig
@@ -1,12 +1,8 @@
{% if not methodEntitiesCollection.isEmpty() %}
-{{ blockName }}:
+## {{ blockName }}
-
{% for methodEntity in methodEntitiesCollection %}
--
- {% if methodEntity.isDeprecated() %}
{{ methodEntity.getName() }}{% else %}{{ methodEntity.getName() }}{% endif %}
- {% if methodEntity.getDescription() %}- {{ methodEntity.getDescription() | removeLineBrakes | raw }}{% endif %}
-
+1. [{% if methodEntity.isDeprecated() %}~~{{ methodEntity.getName() }}~~{% else %}{{ methodEntity.getName() }}{% endif %}](#m{{ methodEntity.getName() | prepareSourceLink }}) {% if methodEntity.getDescription() %}- {{ methodEntity.getDescription() | removeLineBrakes | raw }}{% endif %}
+
{% endfor %}
-
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_properties.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_properties.md.twig
index 50cee9ca..397df1ad 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_properties.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_properties.md.twig
@@ -1,11 +1,8 @@
{% if not classEntity.getPropertyEntitiesCollection().isEmpty() %}
-Properties:
+## Properties:
-
- {% for propertyEntity in classEntity.getPropertyEntitiesCollection() %}
- -
- {{ propertyEntity.getName() }} {% if propertyEntity.getDescription() %}-
- {{ propertyEntity.getDescription() | removeLineBrakes }}{% endif %}
- {% endfor %}
-
+{% for propertyEntity in classEntity.getPropertyEntitiesCollection() %}
+1. [{% if propertyEntity.isDeprecated() %}~~{{ propertyEntity.getName() }}~~{% else %}{{ propertyEntity.getName() }}{% endif %}](#p{{ propertyEntity.getName() | prepareSourceLink }}) {% if propertyEntity.getDescription() %}- {{ propertyEntity.getDescription() | removeLineBrakes | raw }}{% endif %}
+
+{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_property_details.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_property_details.md.twig
index 2ad9272a..65d588f4 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_property_details.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_property_details.md.twig
@@ -1,12 +1,8 @@
{% if not classEntity.getPropertyEntitiesCollection().isEmpty() %}
-Property details:
-
+## Properties details:
{% for propertyEntity in classEntity.getPropertyEntitiesCollection() %}
-* #
- ${{ propertyEntity.getName() }}
- {% if propertyEntity.isInternal() %}:warning: Is internal {% endif %} {% if propertyEntity.isDeprecated() %}:no_entry: Deprecated {% endif %}
- {% if propertyEntity.getFileSourceLink() %} **|** source code{% endif %}
+# `{{ propertyEntity.getName() }}` {% if propertyEntity.isInternal() %}⚠️ Internal {% endif %} {% if propertyEntity.isDeprecated() %}⛔ Deprecated {% endif %}{% if propertyEntity.getFileSourceLink() %}**|** [source code]({{ propertyEntity.getFileSourceLink() }}){% endif %}
```php
{% if propertyEntity.isImplementedInParentClass() %}
@@ -16,20 +12,18 @@
{{ propertyEntity.getModifiersString() }} ${{ propertyEntity.getName() }};
```
-
-{% if propertyEntity.getDescription() %}{{ propertyEntity.getDescription() }}
{% endif %}
-
+{% if propertyEntity.getDescription() %}
+{{ propertyEntity.getDescription() | raw }}
+{% endif %}
{% if propertyEntity.hasDescriptionLinks() %}
-See:
-
+***Links:***
{% for link in propertyEntity.getDescriptionLinks() %}
- -
- {{ link.name }}{% if link.description %} - {{ link.description | removeLineBrakes }} {% endif %}
-
+- {% if link.url %}[{{ link.name }}]({{ link.url }}){% elseif link.className %}{{ link.className|strTypeToUrl(classEntity.getRootEntityCollection(), false, true) }}{% else %}{{ link.name }}{% endif %}{% if link.description %} - {{ link.description | removeLineBrakes }} {% endif %}
+
{% endfor %}
-
{% endif %}
+---
{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_traits.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_traits.md.twig
index 332310a1..11e9b895 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_traits.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/_traits.md.twig
@@ -1,9 +1,8 @@
{% if classEntity.hasTraits() %}
-Traits:
+## Traits:
-
- {% for traitName in classEntity.getTraitsNames() %}
- - {{ traitName | strTypeToUrl(classEntity.getRootEntityCollection()) }}
- {% endfor %}
-
+{% for traitName in classEntity.getTraitsNames() %}
+1. {{ traitName | strTypeToUrl(classEntity.getRootEntityCollection(), false, propRefsInternalLinksMode) }}
+
+{% endfor %}
{% endif %}
\ No newline at end of file
diff --git a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/class.md.twig b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/class.md.twig
index de49e276..86516b5d 100644
--- a/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/class.md.twig
+++ b/src/LanguageHandler/Php/Renderer/EntityDocRenderer/PhpClassToMd/templates/class.md.twig
@@ -1,31 +1,15 @@
-{{ generatePageBreadcrumbs(classEntity.getShortName(), parentDocFilePath, false) }}
-
-{% include '_classHeader.md.twig' with {'classEntity': classEntity} only %}
-
+{{ drawEntityBreadcrumbs(classEntity.getShortName(), docUrl, parentDocFilePath, false) }}
+{% include '_classHeader.md.twig' %}
{{ loadPluginsContent('', classEntity, constant('BumbleDocGen\\LanguageHandler\\Php\\Renderer\\EntityDocRenderer\\PhpClassToMd\\PhpClassToMdDocRenderer::BLOCK_AFTER_HEADER')) }}
-
-
-{% include '_classMainInfo.md.twig' with {'classEntity': classEntity} only %}
-
-
+{% include '_classMainInfo.md.twig' %}
{{ loadPluginsContent('', classEntity, constant('BumbleDocGen\\LanguageHandler\\Php\\Renderer\\EntityDocRenderer\\PhpClassToMd\\PhpClassToMdDocRenderer::BLOCK_AFTER_MAIN_INFO')) }}
-
-
-{% include '_enumCases.md.twig' with {'classEntity': classEntity} only %}
-
-{% include '_methods.md.twig' with {'blockName': 'Initialization methods', 'methodEntitiesCollection': classEntity.getMethodEntitiesCollection().getInitializations()} only %}
-
-{% include '_methods.md.twig' with {'blockName': 'Methods', 'methodEntitiesCollection': classEntity.getMethodEntitiesCollection().getAllExceptInitializations()} only %}
-
-{% include '_traits.md.twig' with {'classEntity': classEntity} only %}
-
-{% include '_constants.md.twig' with {'classEntity': classEntity} only %}
-
-{% include '_properties.md.twig' with {'classEntity': classEntity} only %}
-
+{% include '_enumCases.md.twig' %}
+{% include '_methods.md.twig' with {'blockName': 'Initialization methods', 'methodEntitiesCollection': classEntity.getMethodEntitiesCollection().getInitializations()} %}
+{% include '_methods.md.twig' with {'blockName': 'Methods', 'methodEntitiesCollection': classEntity.getMethodEntitiesCollection().getAllExceptInitializations()} %}
+{% include '_traits.md.twig' %}
+{% include '_properties.md.twig' %}
+{% include '_constants.md.twig' %}
{{ loadPluginsContent('', classEntity, constant('BumbleDocGen\\LanguageHandler\\Php\\Renderer\\EntityDocRenderer\\PhpClassToMd\\PhpClassToMdDocRenderer::BLOCK_BEFORE_DETAILS')) }}
-
-{% include '_property_details.md.twig' with {'classEntity': classEntity} only %}
-
-{% include '_method_details.md.twig' with {'methodEntitiesCollection': classEntity.getMethodEntitiesCollection()} only %}
+{% include '_property_details.md.twig' %}
+{% include '_method_details.md.twig' with {'methodEntitiesCollection': classEntity.getMethodEntitiesCollection()} %}
diff --git a/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php b/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php
index b9ef5162..1298c6de 100644
--- a/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php
+++ b/src/LanguageHandler/Php/Renderer/Twig/Function/DisplayClassApiMethods.php
@@ -20,8 +20,8 @@
final class DisplayClassApiMethods implements CustomFunctionInterface
{
public function __construct(
- private RootEntityCollectionsGroup $rootEntityCollectionsGroup,
- private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
+ private readonly RootEntityCollectionsGroup $rootEntityCollectionsGroup,
+ private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
) {
}
@@ -32,7 +32,9 @@ public static function getName(): string
public static function getOptions(): array
{
- return [];
+ return [
+ 'needs_context' => true,
+ ];
}
/**
@@ -42,7 +44,7 @@ public static function getOptions(): array
* @throws NotFoundException
* @throws InvalidConfigurationParameterException
*/
- public function __invoke(string $className): ?string
+ public function __invoke(array $context, string $className): ?string
{
$entitiesCollection = $this->rootEntityCollectionsGroup->get(PhpEntitiesCollection::NAME);
if (!$entitiesCollection) {
@@ -55,6 +57,7 @@ public function __invoke(string $className): ?string
if ($method->isApi()) {
$description = $method->getDescription();
$entityDocUrl = call_user_func_array($this->getDocumentedEntityUrlFunction, [
+ $context,
$entitiesCollection,
$classEntity->getName(),
$method->getName()
diff --git a/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php b/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php
index e7af807b..c5d3dc3f 100644
--- a/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php
+++ b/src/LanguageHandler/Php/Renderer/Twig/Function/DrawClassMap.php
@@ -27,8 +27,8 @@ final class DrawClassMap implements CustomFunctionInterface
private array $fileClassmap;
public function __construct(
- private GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
- private RootEntityCollectionsGroup $rootEntityCollectionsGroup,
+ private readonly GetDocumentedEntityUrl $getDocumentedEntityUrlFunction,
+ private readonly RootEntityCollectionsGroup $rootEntityCollectionsGroup,
) {
}
@@ -41,24 +41,27 @@ public static function getOptions(): array
{
return [
'is_safe' => ['html'],
+ 'needs_context' => true,
];
}
/**
+ * @param array $context
* @param PhpEntitiesCollection ...$entitiesCollections
* The collection of entities for which the class map will be generated
* @return string
*
- * @throws NotFoundException
* @throws DependencyException
* @throws InvalidConfigurationParameterException
+ * @throws NotFoundException
*/
public function __invoke(
+ array $context,
PhpEntitiesCollection ...$entitiesCollections,
): string {
$structure = $this->convertDirectoryStructureToFormattedString(
- $this->getDirectoryStructure(...$entitiesCollections),
+ $this->getDirectoryStructure($context, ...$entitiesCollections),
);
return "";
}
@@ -66,12 +69,13 @@ public function __invoke(
/**
* @throws InvalidConfigurationParameterException
*/
- protected function appendClassToDirectoryStructure(array $directoryStructure, ClassLikeEntity $classEntity): array
+ protected function appendClassToDirectoryStructure(array $context, array $directoryStructure, ClassLikeEntity $classEntity): array
{
$entitiesCollection = $this->rootEntityCollectionsGroup->get(PhpEntitiesCollection::NAME);
$this->fileClassmap[$classEntity->getRelativeFileName()] = call_user_func_array(
callback: $this->getDocumentedEntityUrlFunction,
args: [
+ $context,
$entitiesCollection,
$classEntity->getName()
]
@@ -94,7 +98,7 @@ protected function appendClassToDirectoryStructure(array $directoryStructure, Cl
* @throws DependencyException
* @throws InvalidConfigurationParameterException
*/
- public function getDirectoryStructure(PhpEntitiesCollection ...$entitiesCollections): array
+ public function getDirectoryStructure(array $context, PhpEntitiesCollection ...$entitiesCollections): array
{
$entities = [];
foreach ($entitiesCollections as $entitiesCollection) {
@@ -108,7 +112,7 @@ public function getDirectoryStructure(PhpEntitiesCollection ...$entitiesCollecti
ksort($entities, SORT_STRING);
$directoryStructure = [];
foreach ($entities as $classEntity) {
- $directoryStructure = $this->appendClassToDirectoryStructure($directoryStructure, $classEntity);
+ $directoryStructure = $this->appendClassToDirectoryStructure($context, $directoryStructure, $classEntity);
}
return $directoryStructure;
}
diff --git a/src/LanguageHandler/Php/phpHandlerDefaultSettings.yaml b/src/LanguageHandler/Php/phpHandlerDefaultSettings.yaml
index 5f4bc695..13c1f9a7 100644
--- a/src/LanguageHandler/Php/phpHandlerDefaultSettings.yaml
+++ b/src/LanguageHandler/Php/phpHandlerDefaultSettings.yaml
@@ -33,6 +33,8 @@ language_handlers:
file_source_base_url: null
+ prop_refs_internal_links_mode: false
+
use_composer_autoload: true # whether to use composer to load the class map or not
composer_config_file: "%project_root%/composer.json"
composer_vendor_dir: "%project_root%/vendor"