```php
@@ -298,7 +370,7 @@ public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\L
```php
@@ -388,7 +460,7 @@ public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProc
```php
@@ -422,7 +494,7 @@ public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```php
@@ -484,7 +556,7 @@ public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\Sou
```php
@@ -546,7 +618,7 @@ public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
```php
@@ -580,7 +652,7 @@ public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\Cu
```php
@@ -636,7 +708,7 @@ public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```php
diff --git a/docs/tech/1.configuration/classes/DocumentedEntityWrappersCollection.md b/docs/tech/1.configuration/classes/DocumentedEntityWrappersCollection.md
index fd7a969f..6759727b 100644
--- a/docs/tech/1.configuration/classes/DocumentedEntityWrappersCollection.md
+++ b/docs/tech/1.configuration/classes/DocumentedEntityWrappersCollection.md
@@ -2,7 +2,7 @@
@@ -60,11 +60,11 @@ final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \T
```php
-public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
+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);
```
@@ -89,6 +89,11 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
| $localObjectCache |
@@ -371,7 +382,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
```php
@@ -430,7 +441,7 @@ public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocu
```php
@@ -461,7 +472,7 @@ public function documentCreationAllowed(): bool;
```php
@@ -494,7 +505,7 @@ public function entityCacheIsOutdated(): bool;
```php
@@ -516,6 +527,9 @@ public function entityDataCanBeLoaded(): bool;
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
+ \Exception
+
@@ -525,7 +539,7 @@ public function entityDataCanBeLoaded(): bool;
```php
@@ -555,11 +569,11 @@ public function getAbsoluteFileName(): string|null;
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
@@ -578,7 +592,7 @@ public function getCacheKey(): string;
```php
@@ -608,7 +622,7 @@ public function getCachedEntityDependencies(): array;
```php
@@ -639,7 +653,7 @@ public function getCasesNames(): array;
```php
@@ -687,7 +701,7 @@ public function getConstant(string $name): string|array|int|bool|null|float;
```php
@@ -746,7 +760,7 @@ public function getConstantEntity(string $constantName, bool $unsafe = true): \B
```php
@@ -783,7 +797,7 @@ public function getConstantEntityCollection(): \BumbleDocGen\LanguageHandler\Php
```php
@@ -814,7 +828,7 @@ public function getConstants(): array;
```php
@@ -845,7 +859,7 @@ public function getConstantsData(): array;
```php
@@ -882,7 +896,7 @@ public function getDescription(): string;
```php
@@ -915,7 +929,7 @@ public function getDescriptionLinks(): array;
```php
@@ -952,7 +966,7 @@ public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```php
@@ -985,7 +999,7 @@ public function getDocComment(): string;
```php
@@ -1022,7 +1036,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\
```php
@@ -1045,7 +1059,7 @@ public function getDocNote(): string;
```php
@@ -1076,7 +1090,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En
```php
@@ -1107,7 +1121,7 @@ public function getEndLine(): int;
```php
@@ -1128,7 +1142,7 @@ public function getEntityDependencies(): array;
```php
@@ -1151,7 +1165,7 @@ public function getExamples(): array;
```php
@@ -1182,7 +1196,7 @@ public function getExtends(): string|null;
```php
@@ -1210,7 +1224,7 @@ public function getFileContent(): string;
```php
@@ -1231,7 +1245,7 @@ public function getFileName(): string|null;
```php
@@ -1278,7 +1292,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
```php
@@ -1301,7 +1315,7 @@ public function getFirstExample(): string;
```php
@@ -1332,7 +1346,7 @@ public function getFullFileName(): string|null;
```php
@@ -1363,7 +1377,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec
```php
@@ -1394,7 +1408,7 @@ public function getInterfaceNames(): array;
```php
@@ -1425,7 +1439,7 @@ public function getInterfacesEntities(): array;
```php
@@ -1456,7 +1470,7 @@ public function getInterfacesString(): string;
```php
@@ -1515,7 +1529,7 @@ public function getMethodEntity(string $methodName, bool $unsafe = true): \Bumbl
```php
@@ -1552,7 +1566,7 @@ public function getMethodEntityCollection(): \BumbleDocGen\LanguageHandler\Php\P
```php
@@ -1583,7 +1597,7 @@ public function getMethodsData(): array;
```php
@@ -1614,7 +1628,7 @@ public function getModifiersString(): string;
```php
@@ -1635,7 +1649,7 @@ public function getName(): string;
```php
@@ -1666,7 +1680,7 @@ public function getNamespaceName(): string;
```php
@@ -1687,7 +1701,7 @@ public function getObjectId(): string;
```php
@@ -1718,7 +1732,7 @@ public function getParentClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entit
```php
@@ -1749,7 +1763,7 @@ public function getParentClassName(): string|null;
```php
@@ -1780,7 +1794,7 @@ public function getParentClassNames(): array;
```php
@@ -1801,7 +1815,7 @@ public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHa
```php
@@ -1839,7 +1853,7 @@ public function getPluginData(string $pluginKey): array|null;
```php
@@ -1870,7 +1884,7 @@ public function getPropertiesData(): array;
```php
@@ -1929,7 +1943,7 @@ public function getPropertyEntity(string $propertyName, bool $unsafe = true): \B
```php
@@ -1966,7 +1980,7 @@ public function getPropertyEntityCollection(): \BumbleDocGen\LanguageHandler\Php
```php
@@ -1987,7 +2001,7 @@ public function getReflector(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\
```php
@@ -2035,7 +2049,7 @@ public function getRelativeFileName(bool $loadIfEmpty = true): string|null;
```php
@@ -2056,7 +2070,7 @@ public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Par
```php
@@ -2077,7 +2091,7 @@ public function getShortName(): string;
```php
@@ -2108,7 +2122,7 @@ public function getStartLine(): int;
```php
@@ -2141,7 +2155,7 @@ public function getThrows(): array;
```php
@@ -2172,7 +2186,7 @@ public function getTraitsNames(): array;
```php
@@ -2210,7 +2224,7 @@ public function hasAnnotationKey(string $annotationKey): bool;
```php
@@ -2258,7 +2272,7 @@ public function hasConstant(string $constant): bool;
```php
@@ -2288,7 +2302,7 @@ public function hasDescriptionLinks(): bool;
```php
@@ -2311,7 +2325,7 @@ public function hasExamples(): bool;
```php
@@ -2359,7 +2373,7 @@ public function hasMethod(string $method): bool;
```php
@@ -2407,7 +2421,7 @@ public function hasParentClass(string $parentClassName): bool;
```php
@@ -2455,7 +2469,7 @@ public function hasProperty(string $property): bool;
```php
@@ -2478,7 +2492,7 @@ public function hasThrows(): bool;
```php
@@ -2509,7 +2523,7 @@ public function hasTraits(): bool;
```php
@@ -2557,7 +2571,7 @@ public function implementsInterface(string $interfaceName): bool;
```php
@@ -2588,7 +2602,7 @@ public function isAbstract(): bool;
```php
@@ -2609,7 +2623,7 @@ public function isClassLoad(): bool;
```php
@@ -2632,7 +2646,7 @@ public function isDeprecated(): bool;
```php
@@ -2662,7 +2676,7 @@ public function isEntityDataCacheOutdated(): bool;
```php
@@ -2695,7 +2709,7 @@ public function isEntityFileCanBeLoad(): bool;
```php
@@ -2733,7 +2747,7 @@ public static function isEntityNameValid(string $entityName): bool;
```php
@@ -2757,6 +2771,27 @@ public function isEnum(): bool;
+
+
+
+
+
+
+```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
+
+
Parameters: not specified
+
+
Return value: bool
+
+
@@ -2764,7 +2799,7 @@ public function isEnum(): bool;
```php
@@ -2795,7 +2830,7 @@ public function isInGit(): bool;
```php
@@ -2826,7 +2861,7 @@ public function isInstantiable(): bool;
```php
@@ -2857,7 +2892,7 @@ public function isInterface(): bool;
```php
@@ -2880,7 +2915,7 @@ public function isInternal(): bool;
```php
@@ -2928,7 +2963,7 @@ public function isSubclassOf(string $className): bool;
```php
@@ -2959,7 +2994,7 @@ public function isTrait(): bool;
```php
@@ -3002,20 +3037,20 @@ public function loadPluginData(string $pluginKey, array $data): void;
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function reloadEntityDependenciesCache(): void;
+public function reloadEntityDependenciesCache(): array;
```
Parameters: not specified
-
Return value: void
+
Return value: array
Throws:
@@ -3025,6 +3060,46 @@ public function reloadEntityDependenciesCache(): void;
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
+
+public function removeEntityValueFromCache(string $key): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $key |
+ string |
+ - |
+
+
+
+
+
Return value: void
+
+
@@ -3032,7 +3107,7 @@ public function reloadEntityDependenciesCache(): void;
```php
@@ -3062,7 +3137,7 @@ public function removeNotUsedEntityDataCache(): void;
```php
diff --git a/docs/tech/2.parser/classes/ConstantEntity.md b/docs/tech/2.parser/classes/ConstantEntity.md
index cfb51506..4c4312f3 100644
--- a/docs/tech/2.parser/classes/ConstantEntity.md
+++ b/docs/tech/2.parser/classes/ConstantEntity.md
@@ -147,6 +147,9 @@ class ConstantEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Bas
reloadEntityDependenciesCache
+
+ removeEntityValueFromCache
+
removeNotUsedEntityDataCache
@@ -237,7 +240,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
```php
@@ -270,7 +273,7 @@ public function entityCacheIsOutdated(): bool;
```php
@@ -300,11 +303,11 @@ public function getAbsoluteFileName(): string|null;
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
@@ -323,7 +326,7 @@ public function getCacheKey(): string;
```php
@@ -384,7 +387,7 @@ public function getDescription(): string;
```php
@@ -448,7 +451,7 @@ public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```php
@@ -502,7 +505,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\
```php
@@ -556,7 +559,7 @@ public function getEndLine(): int;
```php
@@ -610,7 +613,7 @@ public function getFileName(): string|null;
```php
@@ -657,7 +660,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
```php
@@ -805,7 +808,7 @@ public function getNamespaceName(): string;
```php
@@ -943,7 +946,7 @@ public function getStartLine(): int;
```php
@@ -976,7 +979,7 @@ public function getThrows(): array;
```php
@@ -1006,7 +1009,7 @@ public function hasDescriptionLinks(): bool;
```php
@@ -1029,7 +1032,7 @@ public function hasExamples(): bool;
```php
@@ -1052,7 +1055,7 @@ public function hasThrows(): bool;
```php
@@ -1075,7 +1078,7 @@ public function isDeprecated(): bool;
```php
@@ -1105,7 +1108,7 @@ public function isEntityDataCacheOutdated(): bool;
```php
@@ -1138,7 +1141,7 @@ public function isEntityFileCanBeLoad(): bool;
```php
@@ -1254,20 +1257,20 @@ public function isPublic(): bool;
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function reloadEntityDependenciesCache(): void;
+public function reloadEntityDependenciesCache(): array;
```
Parameters: not specified
-
Return value: void
+
Return value: array
Throws:
@@ -1277,6 +1280,46 @@ public function reloadEntityDependenciesCache(): void;
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
+
+public function removeEntityValueFromCache(string $key): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $key |
+ string |
+ - |
+
+
+
+
+
Return value: void
+
+
@@ -1284,7 +1327,7 @@ public function reloadEntityDependenciesCache(): void;
```php
diff --git a/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md b/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md
deleted file mode 100644
index aacfc757..00000000
--- a/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception implements \Throwable, \Stringable
-```
-
-
Exception is the base class for
-all Exceptions.
-
-See:
-
-
-
-
-
-
-
-
Initialization methods:
-
-
--
- __construct
- - Construct the exception. Note: The message is NOT binary safe.
-
-
-
Methods:
-
-
--
- __toString
- - String representation of the exception
--
- __wakeup
-
--
- getCode
- - Gets the Exception code
--
- getFile
- - Gets the file in which the exception occurred
--
- getLine
- - Gets the line in which the exception occurred
--
- getMessage
- - Gets the Exception message
--
- getPrevious
- - Returns previous Exception
--
- getTrace
- - Gets the stack trace
--
- getTraceAsString
- - Gets the stack trace as a string
-
-
-
-
-
-
-
-
-
Method details:
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
-```
-
-
Construct the exception. Note: The message is NOT binary safe.
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $message |
- string |
- [optional] The Exception message to throw. |
-
-
- | $code |
- int |
- [optional] The Exception code. |
-
-
- | $previous |
- \Throwable | null |
- [optional] The previous throwable used for the exception chaining. |
-
-
-
-
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __toString(): string;
-```
-
-
String representation of the exception
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __wakeup(): mixed;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: mixed
-
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getCode(): mixed|int;
-```
-
-
Gets the Exception code
-
-
Parameters: not specified
-
-
Return value: mixed |
int
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getFile(): string;
-```
-
-
Gets the file in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getLine(): int;
-```
-
-
Gets the line in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getMessage(): string;
-```
-
-
Gets the Exception message
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getPrevious(): \Throwable|null;
-```
-
-
Returns previous Exception
-
-
Parameters: not specified
-
-
Return value: \Throwable |
null
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getTrace(): array;
-```
-
-
Gets the stack trace
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
See:
-
-
-
-
-
-
-- #
- getTraceAsString
-
-
-
-```php
-// Implemented in Exception
-
-public function getTraceAsString(): string;
-```
-
-
Gets the stack trace as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/2.parser/classes/LocatedInCondition.md b/docs/tech/2.parser/classes/LocatedInCondition.md
index e71384a0..928c362e 100644
--- a/docs/tech/2.parser/classes/LocatedInCondition.md
+++ b/docs/tech/2.parser/classes/LocatedInCondition.md
@@ -132,7 +132,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf
Throws:
diff --git a/docs/tech/2.parser/classes/LocatedNotInCondition.md b/docs/tech/2.parser/classes/LocatedNotInCondition.md
index d9e0eef3..2becdf60 100644
--- a/docs/tech/2.parser/classes/LocatedNotInCondition.md
+++ b/docs/tech/2.parser/classes/LocatedNotInCondition.md
@@ -132,7 +132,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf
Throws:
diff --git a/docs/tech/2.parser/classes/MethodEntity.md b/docs/tech/2.parser/classes/MethodEntity.md
index d9f75e11..5e958af8 100644
--- a/docs/tech/2.parser/classes/MethodEntity.md
+++ b/docs/tech/2.parser/classes/MethodEntity.md
@@ -201,6 +201,9 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE
reloadEntityDependenciesCache
+
+ removeEntityValueFromCache
+
removeNotUsedEntityDataCache
@@ -296,7 +299,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
```php
@@ -329,7 +332,7 @@ public function entityCacheIsOutdated(): bool;
```php
@@ -359,7 +362,7 @@ public function getAbsoluteFileName(): string|null;
```php
@@ -390,11 +393,11 @@ public function getBodyCode(): string;
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
@@ -413,7 +416,7 @@ public function getCacheKey(): string;
```php
@@ -443,7 +446,7 @@ public function getCachedEntityDependencies(): array;
```php
@@ -480,7 +483,7 @@ public function getDescription(): string;
```php
@@ -567,7 +570,7 @@ public function getDocBlock(bool $recursive = true): \phpDocumentor\Reflection\D
```php
@@ -635,7 +638,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\
```php
@@ -666,7 +669,7 @@ public function getDocCommentLine(): int|null;
```php
@@ -703,7 +706,7 @@ public function getDocCommentLineRecursive(): int|null;
```php
@@ -740,7 +743,7 @@ public function getDocCommentRecursive(): string;
```php
@@ -763,7 +766,7 @@ public function getDocNote(): string;
```php
@@ -794,7 +797,7 @@ public function getEndLine(): int;
```php
@@ -817,7 +820,7 @@ public function getExamples(): array;
```php
@@ -848,7 +851,7 @@ public function getFileName(): string|null;
```php
@@ -895,7 +898,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
```php
@@ -918,7 +921,7 @@ public function getFirstExample(): string;
```php
@@ -970,7 +973,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser
```php
@@ -1022,7 +1025,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec
```php
@@ -1053,7 +1056,7 @@ public function getModifiersString(): string;
```php
@@ -1105,7 +1108,7 @@ public function getNamespaceName(): string;
```php
@@ -1128,7 +1131,7 @@ public function getObjectId(): string;
```php
@@ -1168,7 +1171,7 @@ public function getParameters(): array;
```php
@@ -1226,7 +1229,7 @@ public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHa
```php
@@ -1263,7 +1266,7 @@ public function getPrototype(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\
```php
@@ -1363,7 +1366,7 @@ public function getShortName(): string;
```php
@@ -1400,7 +1403,7 @@ public function getSignature(): string;
```php
@@ -1431,7 +1434,7 @@ public function getStartColumn(): int;
```php
@@ -1462,7 +1465,7 @@ public function getStartLine(): int;
```php
@@ -1495,7 +1498,7 @@ public function getThrows(): array;
```php
@@ -1525,7 +1528,7 @@ public function hasDescriptionLinks(): bool;
```php
@@ -1548,7 +1551,7 @@ public function hasExamples(): bool;
```php
@@ -1571,7 +1574,7 @@ public function hasThrows(): bool;
```php
@@ -1592,7 +1595,7 @@ public function isConstructor(): bool;
```php
@@ -1615,7 +1618,7 @@ public function isDeprecated(): bool;
```php
@@ -1636,7 +1639,7 @@ public function isDynamic(): bool;
```php
@@ -1666,7 +1669,7 @@ public function isEntityDataCacheOutdated(): bool;
```php
@@ -1699,7 +1702,7 @@ public function isEntityFileCanBeLoad(): bool;
```php
@@ -1720,7 +1723,7 @@ public function isImplementedInParentClass(): bool;
```php
@@ -1757,7 +1760,7 @@ public function isInitialization(): bool;
```php
@@ -1780,7 +1783,7 @@ public function isInternal(): bool;
```php
@@ -1811,7 +1814,7 @@ public function isPrivate(): bool;
```php
@@ -1842,7 +1845,7 @@ public function isProtected(): bool;
```php
@@ -1873,7 +1876,7 @@ public function isPublic(): bool;
```php
@@ -1904,7 +1907,7 @@ public function isStatic(): bool;
```php
@@ -1942,20 +1945,20 @@ public static function parseAnnotationParams(array $params): array;
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function reloadEntityDependenciesCache(): void;
+public function reloadEntityDependenciesCache(): array;
```
Parameters: not specified
-
Return value: void
+
Return value: array
Throws:
@@ -1965,6 +1968,46 @@ public function reloadEntityDependenciesCache(): void;
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
+
+public function removeEntityValueFromCache(string $key): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $key |
+ string |
+ - |
+
+
+
+
+
Return value: void
+
+
@@ -1972,7 +2015,7 @@ public function reloadEntityDependenciesCache(): void;
```php
diff --git a/docs/tech/2.parser/classes/PropertyEntity.md b/docs/tech/2.parser/classes/PropertyEntity.md
index 71088233..617c0494 100644
--- a/docs/tech/2.parser/classes/PropertyEntity.md
+++ b/docs/tech/2.parser/classes/PropertyEntity.md
@@ -159,6 +159,9 @@ class PropertyEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Bas
reloadEntityDependenciesCache
+
+ removeEntityValueFromCache
+
removeNotUsedEntityDataCache
@@ -249,7 +252,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
```php
@@ -282,7 +285,7 @@ public function entityCacheIsOutdated(): bool;
```php
@@ -312,11 +315,11 @@ public function getAbsoluteFileName(): string|null;
```php
-// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
public function getCacheKey(): string;
```
@@ -335,7 +338,7 @@ public function getCacheKey(): string;
```php
@@ -365,7 +368,7 @@ public function getCachedEntityDependencies(): array;
```php
@@ -396,7 +399,7 @@ public function getDefaultValue(): string|array|int|bool|null|float;
```php
@@ -433,7 +436,7 @@ public function getDescription(): string;
```php
@@ -503,7 +506,7 @@ public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;
```php
@@ -573,7 +576,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\
```php
@@ -596,7 +599,7 @@ public function getDocNote(): string;
```php
@@ -627,7 +630,7 @@ public function getEndLine(): int;
```php
@@ -650,7 +653,7 @@ public function getExamples(): array;
```php
@@ -681,7 +684,7 @@ public function getFileName(): string|null;
```php
@@ -728,7 +731,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
```php
@@ -751,7 +754,7 @@ public function getFirstExample(): string;
```php
@@ -772,7 +775,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser
```php
@@ -824,7 +827,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec
```php
@@ -861,7 +864,7 @@ public function getModifiersString(): string;
```php
@@ -882,7 +885,7 @@ public function getName(): string;
```php
@@ -913,7 +916,7 @@ public function getNamespaceName(): string;
```php
@@ -999,7 +1002,7 @@ public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Par
```php
@@ -1020,7 +1023,7 @@ public function getShortName(): string;
```php
@@ -1051,7 +1054,7 @@ public function getStartLine(): int;
```php
@@ -1084,7 +1087,7 @@ public function getThrows(): array;
```php
@@ -1121,7 +1124,7 @@ public function getType(): string;
```php
@@ -1151,7 +1154,7 @@ public function hasDescriptionLinks(): bool;
```php
@@ -1174,7 +1177,7 @@ public function hasExamples(): bool;
```php
@@ -1197,7 +1200,7 @@ public function hasThrows(): bool;
```php
@@ -1220,7 +1223,7 @@ public function isDeprecated(): bool;
```php
@@ -1250,7 +1253,7 @@ public function isEntityDataCacheOutdated(): bool;
```php
@@ -1283,7 +1286,7 @@ public function isEntityFileCanBeLoad(): bool;
```php
@@ -1304,7 +1307,7 @@ public function isImplementedInParentClass(): bool;
```php
@@ -1327,7 +1330,7 @@ public function isInternal(): bool;
```php
@@ -1358,7 +1361,7 @@ public function isPrivate(): bool;
```php
@@ -1389,7 +1392,7 @@ public function isProtected(): bool;
```php
@@ -1420,20 +1423,20 @@ public function isPublic(): bool;
```php
// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity
-public function reloadEntityDependenciesCache(): void;
+public function reloadEntityDependenciesCache(): array;
```
Parameters: not specified
-
Return value: void
+
Return value: array
Throws:
@@ -1443,6 +1446,46 @@ public function reloadEntityDependenciesCache(): void;
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait
+
+public function removeEntityValueFromCache(string $key): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $key |
+ string |
+ - |
+
+
+
+
+
Return value: void
+
+
@@ -1450,7 +1493,7 @@ public function reloadEntityDependenciesCache(): void;
```php
diff --git a/docs/tech/2.parser/classes/ReflectionException.md b/docs/tech/2.parser/classes/ReflectionException.md
index 484bd11f..3447c81b 100644
--- a/docs/tech/2.parser/classes/ReflectionException.md
+++ b/docs/tech/2.parser/classes/ReflectionException.md
@@ -1,5 +1,5 @@
-
+
ReflectionException class:
diff --git a/docs/tech/2.parser/classes/RootEntityInterface.md b/docs/tech/2.parser/classes/RootEntityInterface.md
index 66a1490f..420020ae 100644
--- a/docs/tech/2.parser/classes/RootEntityInterface.md
+++ b/docs/tech/2.parser/classes/RootEntityInterface.md
@@ -1,5 +1,5 @@
-
+
RootEntityInterface class:
@@ -63,6 +63,9 @@ their entities need to correspond to the same interfaces
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
@@ -148,7 +151,7 @@ public function getAbsoluteFileName(): string|null;
```php
@@ -169,7 +172,7 @@ public function getEntityDependencies(): array;
```php
@@ -213,7 +216,7 @@ public function getFileName(): string|null;
```php
@@ -374,6 +377,27 @@ public static function isEntityNameValid(string $entityName): bool;
Return value: bool
+
+
+
+
+
+```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
+
+
Parameters: not specified
+
+
Return value: bool
+
+
@@ -381,7 +405,7 @@ public static function isEntityNameValid(string $entityName): bool;
```php
diff --git a/docs/tech/2.parser/entity.md b/docs/tech/2.parser/entity.md
index 9ad24f95..b3230099 100644
--- a/docs/tech/2.parser/entity.md
+++ b/docs/tech/2.parser/entity.md
@@ -123,4 +123,4 @@ These classes are a convenient wrapper for accessing data in templates:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with
Bumble Documentation Generator
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/2.parser/readme.md b/docs/tech/2.parser/readme.md
index e359c9f0..9d462717 100644
--- a/docs/tech/2.parser/readme.md
+++ b/docs/tech/2.parser/readme.md
@@ -41,4 +41,4 @@ In this section, we show how the parser works and what components it consists of
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/2.parser/sourceLocator.md b/docs/tech/2.parser/sourceLocator.md
index df7da3c3..c7cae9be 100644
--- a/docs/tech/2.parser/sourceLocator.md
+++ b/docs/tech/2.parser/sourceLocator.md
@@ -30,4 +30,4 @@ You can create your own source locators or use any existing ones. All source loc
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/01_templates.md b/docs/tech/3.renderer/01_templates.md
index 4e9dcb57..72ce1bb5 100644
--- a/docs/tech/3.renderer/01_templates.md
+++ b/docs/tech/3.renderer/01_templates.md
@@ -101,4 +101,4 @@ Result after starting the documentation generation process:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/02_breadcrumbs.md b/docs/tech/3.renderer/02_breadcrumbs.md
index b979e42c..38a39bce 100644
--- a/docs/tech/3.renderer/02_breadcrumbs.md
+++ b/docs/tech/3.renderer/02_breadcrumbs.md
@@ -51,4 +51,4 @@ Here is an example of the result of the `generatePageBreadcrumbs` function:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/03_documentStructure.md b/docs/tech/3.renderer/03_documentStructure.md
index 158325da..f7a420ff 100644
--- a/docs/tech/3.renderer/03_documentStructure.md
+++ b/docs/tech/3.renderer/03_documentStructure.md
@@ -19,4 +19,4 @@ plugins:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/04_twigCustomFilters.md b/docs/tech/3.renderer/04_twigCustomFilters.md
index ac2c586a..cb110aaa 100644
--- a/docs/tech/3.renderer/04_twigCustomFilters.md
+++ b/docs/tech/3.renderer/04_twigCustomFilters.md
@@ -263,4 +263,4 @@ Here is a list of filters available by default:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/05_twigCustomFunctions.md b/docs/tech/3.renderer/05_twigCustomFunctions.md
index 5b2947ed..9a0db2a5 100644
--- a/docs/tech/3.renderer/05_twigCustomFunctions.md
+++ b/docs/tech/3.renderer/05_twigCustomFunctions.md
@@ -177,7 +177,7 @@ Here is a list of functions available by default:
| $pluginEventDispatcher |
@@ -107,7 +112,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
```php
@@ -134,7 +139,7 @@ public function count(): int;
```php
@@ -165,6 +170,13 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
+Throws:
+
+
@@ -172,7 +184,7 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En
```php
@@ -193,7 +205,7 @@ public function getDocumentedEntitiesRelations(): array;
```php
diff --git a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_3.md b/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_3.md
deleted file mode 100644
index 54a1ffda..00000000
--- a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_3.md
+++ /dev/null
@@ -1,226 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Context;
-
-final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \Traversable, \Countable
-```
-
-
-
-
-
-
-
-
-
Initialization methods:
-
-
--
- __construct
-
-
-
-
Methods:
-
-
--
- count
- - Count elements of an object
--
- createAndAddDocumentedEntityWrapper
-
--
- getDocumentedEntitiesRelations
-
--
- getIterator
- - Retrieve an external iterator
-
-
-
-
-
-
-
-
-
Method details:
-
-
-
-
-
-```php
-public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);
-```
-
-
-
-
Parameters:
-
-
-
-
-
-
-
-
-
-
-
-```php
-public function count(): int;
-```
-
-
Count elements of an object
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-
-```php
-public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;
-```
-
-
-
-
Parameters:
-
-
-
-
Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper
-
-
-
-
-
-
-
-
-```php
-public function getDocumentedEntitiesRelations(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-
-```php
-public function getIterator(): \Generator;
-```
-
-
Retrieve an external iterator
-
-
Parameters: not specified
-
-
Return value: \Generator
-
-
-
Throws:
-
-
-
-
See:
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/DrawClassMap.md b/docs/tech/3.renderer/classes/DrawClassMap.md
index 1d07d031..84f0f7ed 100644
--- a/docs/tech/3.renderer/classes/DrawClassMap.md
+++ b/docs/tech/3.renderer/classes/DrawClassMap.md
@@ -165,13 +165,13 @@ public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEn
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
@@ -267,13 +267,13 @@ public function getDirectoryStructure(\BumbleDocGen\LanguageHandler\Php\Parser\E
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
diff --git a/docs/tech/3.renderer/classes/DrawDocumentationMenu.md b/docs/tech/3.renderer/classes/DrawDocumentationMenu.md
index 77fd7c92..39e7b383 100644
--- a/docs/tech/3.renderer/classes/DrawDocumentationMenu.md
+++ b/docs/tech/3.renderer/classes/DrawDocumentationMenu.md
@@ -21,7 +21,7 @@ and all links with this page are recursively collected for it, after which the h
See:
@@ -196,7 +196,7 @@ public function __invoke(string|null $startPageKey = null, int|null $maxDeep = n
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
diff --git a/docs/tech/3.renderer/classes/DrawDocumentedEntityLink.md b/docs/tech/3.renderer/classes/DrawDocumentedEntityLink.md
index 8355ffe1..21f61981 100644
--- a/docs/tech/3.renderer/classes/DrawDocumentedEntityLink.md
+++ b/docs/tech/3.renderer/classes/DrawDocumentedEntityLink.md
@@ -169,13 +169,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $e
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
diff --git a/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs.md b/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs.md
index 7b7eee1e..b251ade9 100644
--- a/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs.md
+++ b/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs.md
@@ -175,7 +175,7 @@ public function __invoke(string $currentPageTitle, string $templatePath, bool $s
\DI\NotFoundException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
diff --git a/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs_2.md b/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs_2.md
index 3060d122..cbfa1200 100644
--- a/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs_2.md
+++ b/docs/tech/3.renderer/classes/GeneratePageBreadcrumbs_2.md
@@ -175,7 +175,7 @@ public function __invoke(string $currentPageTitle, string $templatePath, bool $s
\DI\NotFoundException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
diff --git a/docs/tech/3.renderer/classes/GetClassMethodsBodyCode.md b/docs/tech/3.renderer/classes/GetClassMethodsBodyCode.md
index d73a9038..a34314a8 100644
--- a/docs/tech/3.renderer/classes/GetClassMethodsBodyCode.md
+++ b/docs/tech/3.renderer/classes/GetClassMethodsBodyCode.md
@@ -151,7 +151,7 @@ public function __invoke(string $className, array $methodsNames): string|null;
Throws:
diff --git a/docs/tech/3.renderer/classes/GetDocumentationPageUrl.md b/docs/tech/3.renderer/classes/GetDocumentationPageUrl.md
index c3abac92..026c1f00 100644
--- a/docs/tech/3.renderer/classes/GetDocumentationPageUrl.md
+++ b/docs/tech/3.renderer/classes/GetDocumentationPageUrl.md
@@ -177,7 +177,7 @@ public function __invoke(string $key): string;
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
diff --git a/docs/tech/3.renderer/classes/GetDocumentationPageUrl_2.md b/docs/tech/3.renderer/classes/GetDocumentationPageUrl_2.md
index 18f74b4b..13464c1f 100644
--- a/docs/tech/3.renderer/classes/GetDocumentationPageUrl_2.md
+++ b/docs/tech/3.renderer/classes/GetDocumentationPageUrl_2.md
@@ -177,7 +177,7 @@ public function __invoke(string $key): string;
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl.md
index 3c66c451..bfae4f01 100644
--- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl.md
+++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl.md
@@ -25,7 +25,7 @@ See:
\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection
- \BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection
+
\BumbleDocGen\Core\Renderer\Context\RendererContext::$entityWrappersCollection
@@ -211,13 +211,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md
index dc59f8b2..2ce0dbe3 100644
--- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md
+++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md
@@ -21,11 +21,11 @@ the `EntityDocRendererInterface::getDocFileExtension()` directory will be create
See:
@@ -211,13 +211,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md
index d7fa2b43..94533a93 100644
--- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md
+++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md
@@ -1,5 +1,5 @@
-
+
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
diff --git a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException.md b/docs/tech/3.renderer/classes/InvalidConfigurationParameterException.md
index e81d87c3..e5223cd5 100644
--- a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException.md
+++ b/docs/tech/3.renderer/classes/InvalidConfigurationParameterException.md
@@ -1,5 +1,5 @@
-
+
InvalidConfigurationParameterException class:
diff --git a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_2.md b/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_2.md
deleted file mode 100644
index 53b4583e..00000000
--- a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_2.md
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception implements \Throwable, \Stringable
-```
-
-Exception is the base class for
-all Exceptions.
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
- - Construct the exception. Note: The message is NOT binary safe.
-
-
-Methods:
-
-
--
- __toString
- - String representation of the exception
--
- __wakeup
-
--
- getCode
- - Gets the Exception code
--
- getFile
- - Gets the file in which the exception occurred
--
- getLine
- - Gets the line in which the exception occurred
--
- getMessage
- - Gets the Exception message
--
- getPrevious
- - Returns previous Exception
--
- getTrace
- - Gets the stack trace
--
- getTraceAsString
- - Gets the stack trace as a string
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
-```
-
-
Construct the exception. Note: The message is NOT binary safe.
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $message |
- string |
- [optional] The Exception message to throw. |
-
-
- | $code |
- int |
- [optional] The Exception code. |
-
-
- | $previous |
- \Throwable | null |
- [optional] The previous throwable used for the exception chaining. |
-
-
-
-
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __toString(): string;
-```
-
-
String representation of the exception
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __wakeup(): mixed;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: mixed
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getCode(): mixed|int;
-```
-
-
Gets the Exception code
-
-
Parameters: not specified
-
-
Return value: mixed |
int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getFile(): string;
-```
-
-
Gets the file in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getLine(): int;
-```
-
-
Gets the line in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getMessage(): string;
-```
-
-
Gets the Exception message
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getPrevious(): \Throwable|null;
-```
-
-
Returns previous Exception
-
-
Parameters: not specified
-
-
Return value: \Throwable |
null
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getTrace(): array;
-```
-
-
Gets the stack trace
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
See:
-
-
-
-
-
-- #
- getTraceAsString
-
-
-
-```php
-// Implemented in Exception
-
-public function getTraceAsString(): string;
-```
-
-
Gets the stack trace as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_3.md b/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_3.md
deleted file mode 100644
index a8e2343c..00000000
--- a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_3.md
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception implements \Throwable, \Stringable
-```
-
-Exception is the base class for
-all Exceptions.
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
- - Construct the exception. Note: The message is NOT binary safe.
-
-
-Methods:
-
-
--
- __toString
- - String representation of the exception
--
- __wakeup
-
--
- getCode
- - Gets the Exception code
--
- getFile
- - Gets the file in which the exception occurred
--
- getLine
- - Gets the line in which the exception occurred
--
- getMessage
- - Gets the Exception message
--
- getPrevious
- - Returns previous Exception
--
- getTrace
- - Gets the stack trace
--
- getTraceAsString
- - Gets the stack trace as a string
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
-```
-
-
Construct the exception. Note: The message is NOT binary safe.
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $message |
- string |
- [optional] The Exception message to throw. |
-
-
- | $code |
- int |
- [optional] The Exception code. |
-
-
- | $previous |
- \Throwable | null |
- [optional] The previous throwable used for the exception chaining. |
-
-
-
-
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __toString(): string;
-```
-
-
String representation of the exception
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __wakeup(): mixed;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: mixed
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getCode(): mixed|int;
-```
-
-
Gets the Exception code
-
-
Parameters: not specified
-
-
Return value: mixed |
int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getFile(): string;
-```
-
-
Gets the file in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getLine(): int;
-```
-
-
Gets the line in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getMessage(): string;
-```
-
-
Gets the Exception message
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getPrevious(): \Throwable|null;
-```
-
-
Returns previous Exception
-
-
Parameters: not specified
-
-
Return value: \Throwable |
null
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getTrace(): array;
-```
-
-
Gets the stack trace
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
See:
-
-
-
-
-
-- #
- getTraceAsString
-
-
-
-```php
-// Implemented in Exception
-
-public function getTraceAsString(): string;
-```
-
-
Gets the stack trace as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_4.md b/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_4.md
deleted file mode 100644
index 5bdbfb7b..00000000
--- a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_4.md
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception implements \Throwable, \Stringable
-```
-
-Exception is the base class for
-all Exceptions.
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
- - Construct the exception. Note: The message is NOT binary safe.
-
-
-Methods:
-
-
--
- __toString
- - String representation of the exception
--
- __wakeup
-
--
- getCode
- - Gets the Exception code
--
- getFile
- - Gets the file in which the exception occurred
--
- getLine
- - Gets the line in which the exception occurred
--
- getMessage
- - Gets the Exception message
--
- getPrevious
- - Returns previous Exception
--
- getTrace
- - Gets the stack trace
--
- getTraceAsString
- - Gets the stack trace as a string
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
-```
-
-
Construct the exception. Note: The message is NOT binary safe.
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $message |
- string |
- [optional] The Exception message to throw. |
-
-
- | $code |
- int |
- [optional] The Exception code. |
-
-
- | $previous |
- \Throwable | null |
- [optional] The previous throwable used for the exception chaining. |
-
-
-
-
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __toString(): string;
-```
-
-
String representation of the exception
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __wakeup(): mixed;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: mixed
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getCode(): mixed|int;
-```
-
-
Gets the Exception code
-
-
Parameters: not specified
-
-
Return value: mixed |
int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getFile(): string;
-```
-
-
Gets the file in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getLine(): int;
-```
-
-
Gets the line in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getMessage(): string;
-```
-
-
Gets the Exception message
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getPrevious(): \Throwable|null;
-```
-
-
Returns previous Exception
-
-
Parameters: not specified
-
-
Return value: \Throwable |
null
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getTrace(): array;
-```
-
-
Gets the stack trace
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
See:
-
-
-
-
-
-- #
- getTraceAsString
-
-
-
-```php
-// Implemented in Exception
-
-public function getTraceAsString(): string;
-```
-
-
Gets the stack trace as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_5.md b/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_5.md
deleted file mode 100644
index 6a63ea19..00000000
--- a/docs/tech/3.renderer/classes/InvalidConfigurationParameterException_5.md
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Configuration\Exception;
-
-final class InvalidConfigurationParameterException extends \Exception implements \Throwable, \Stringable
-```
-
-Exception is the base class for
-all Exceptions.
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
- - Construct the exception. Note: The message is NOT binary safe.
-
-
-Methods:
-
-
--
- __toString
- - String representation of the exception
--
- __wakeup
-
--
- getCode
- - Gets the Exception code
--
- getFile
- - Gets the file in which the exception occurred
--
- getLine
- - Gets the line in which the exception occurred
--
- getMessage
- - Gets the Exception message
--
- getPrevious
- - Returns previous Exception
--
- getTrace
- - Gets the stack trace
--
- getTraceAsString
- - Gets the stack trace as a string
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
-```
-
-
Construct the exception. Note: The message is NOT binary safe.
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $message |
- string |
- [optional] The Exception message to throw. |
-
-
- | $code |
- int |
- [optional] The Exception code. |
-
-
- | $previous |
- \Throwable | null |
- [optional] The previous throwable used for the exception chaining. |
-
-
-
-
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __toString(): string;
-```
-
-
String representation of the exception
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __wakeup(): mixed;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: mixed
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getCode(): mixed|int;
-```
-
-
Gets the Exception code
-
-
Parameters: not specified
-
-
Return value: mixed |
int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getFile(): string;
-```
-
-
Gets the file in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getLine(): int;
-```
-
-
Gets the line in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getMessage(): string;
-```
-
-
Gets the Exception message
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getPrevious(): \Throwable|null;
-```
-
-
Returns previous Exception
-
-
Parameters: not specified
-
-
Return value: \Throwable |
null
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getTrace(): array;
-```
-
-
Gets the stack trace
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
See:
-
-
-
-
-
-- #
- getTraceAsString
-
-
-
-```php
-// Implemented in Exception
-
-public function getTraceAsString(): string;
-```
-
-
Gets the stack trace as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/PageHtmlLinkerPlugin.md b/docs/tech/3.renderer/classes/PageHtmlLinkerPlugin.md
index aaa648ad..79de64fa 100644
--- a/docs/tech/3.renderer/classes/PageHtmlLinkerPlugin.md
+++ b/docs/tech/3.renderer/classes/PageHtmlLinkerPlugin.md
@@ -180,10 +180,10 @@ public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\B
\DI\DependencyException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+
\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
diff --git a/docs/tech/3.renderer/classes/PrintEntityCollectionAsList.md b/docs/tech/3.renderer/classes/PrintEntityCollectionAsList.md
index c03d19cf..a8086d43 100644
--- a/docs/tech/3.renderer/classes/PrintEntityCollectionAsList.md
+++ b/docs/tech/3.renderer/classes/PrintEntityCollectionAsList.md
@@ -168,7 +168,7 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $
Throws:
diff --git a/docs/tech/3.renderer/classes/ReflectionException.md b/docs/tech/3.renderer/classes/ReflectionException.md
index d62e456e..89c5be36 100644
--- a/docs/tech/3.renderer/classes/ReflectionException.md
+++ b/docs/tech/3.renderer/classes/ReflectionException.md
@@ -1,5 +1,5 @@
-
+
ReflectionException class:
diff --git a/docs/tech/3.renderer/classes/ReflectionException_3.md b/docs/tech/3.renderer/classes/ReflectionException_3.md
deleted file mode 100644
index 0d51cfa2..00000000
--- a/docs/tech/3.renderer/classes/ReflectionException_3.md
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception;
-
-final class ReflectionException extends \Exception implements \Throwable, \Stringable
-```
-
-Exception is the base class for
-all Exceptions.
-
-See:
-
-
-
-
-
-
-
-Initialization methods:
-
-
--
- __construct
- - Construct the exception. Note: The message is NOT binary safe.
-
-
-Methods:
-
-
--
- __toString
- - String representation of the exception
--
- __wakeup
-
--
- getCode
- - Gets the Exception code
--
- getFile
- - Gets the file in which the exception occurred
--
- getLine
- - Gets the line in which the exception occurred
--
- getMessage
- - Gets the Exception message
--
- getPrevious
- - Returns previous Exception
--
- getTrace
- - Gets the stack trace
--
- getTraceAsString
- - Gets the stack trace as a string
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
-```
-
-
Construct the exception. Note: The message is NOT binary safe.
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $message |
- string |
- [optional] The Exception message to throw. |
-
-
- | $code |
- int |
- [optional] The Exception code. |
-
-
- | $previous |
- \Throwable | null |
- [optional] The previous throwable used for the exception chaining. |
-
-
-
-
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __toString(): string;
-```
-
-
String representation of the exception
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function __wakeup(): mixed;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: mixed
-
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getCode(): mixed|int;
-```
-
-
Gets the Exception code
-
-
Parameters: not specified
-
-
Return value: mixed |
int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getFile(): string;
-```
-
-
Gets the file in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getLine(): int;
-```
-
-
Gets the line in which the exception occurred
-
-
Parameters: not specified
-
-
Return value: int
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getMessage(): string;
-```
-
-
Gets the Exception message
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getPrevious(): \Throwable|null;
-```
-
-
Returns previous Exception
-
-
Parameters: not specified
-
-
Return value: \Throwable |
null
-
-
-
-
See:
-
-
-
-
-
-
-```php
-// Implemented in Exception
-
-public function getTrace(): array;
-```
-
-
Gets the stack trace
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
See:
-
-
-
-
-
-- #
- getTraceAsString
-
-
-
-```php
-// Implemented in Exception
-
-public function getTraceAsString(): string;
-```
-
-
Gets the stack trace as a string
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
See:
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/RendererContext.md b/docs/tech/3.renderer/classes/RendererContext.md
index 2938cd52..b8df10a8 100644
--- a/docs/tech/3.renderer/classes/RendererContext.md
+++ b/docs/tech/3.renderer/classes/RendererContext.md
@@ -1,5 +1,5 @@
-
+
RendererContext class:
diff --git a/docs/tech/3.renderer/classes/RendererContext_3.md b/docs/tech/3.renderer/classes/RendererContext_3.md
deleted file mode 100644
index ab188eda..00000000
--- a/docs/tech/3.renderer/classes/RendererContext_3.md
+++ /dev/null
@@ -1,259 +0,0 @@
-
-
-
-
-
-
-
-
-
-```php
-namespace BumbleDocGen\Core\Renderer\Context;
-
-final class RendererContext
-```
-
-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
-
-
-
-
-
-
-
-
-Method details:
-
-
-
-
-
-```php
-public function addDependency(\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface $dependency): void;
-```
-
-
-
-
Parameters:
-
-
-
-
Return value: void
-
-
-
-
-
-
-
-```php
-public function clearDependencies(): void;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: void
-
-
-
-
-
-
-
-
-
-```php
-public function getCurrentTemplateFilePatch(): string;
-```
-
-
Getting the path to the template file that is currently being worked on
-
-
Parameters: not specified
-
-
Return value: string
-
-
-
-
-
-
-
-```php
-public function getDependencies(): array;
-```
-
-
-
-
Parameters: not specified
-
-
Return value: array
-
-
-
-
-
-
-
-```php
-public function setCurrentDocumentedEntityWrapper(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $currentDocumentedEntityWrapper): void;
-```
-
-
-
-
Parameters:
-
-
-
-
Return value: void
-
-
-
-
-
-
-
-```php
-public function setCurrentTemplateFilePatch(string $currentTemplateFilePath): void;
-```
-
-
Saving the path to the template file that is currently being worked on in the context
-
-
Parameters:
-
-
-
-
- | Name |
- Type |
- Description |
-
-
-
-
- | $currentTemplateFilePath |
- string |
- - |
-
-
-
-
-
Return value: void
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/RootEntityCollection.md b/docs/tech/3.renderer/classes/RootEntityCollection.md
index f2af393f..57f757a4 100644
--- a/docs/tech/3.renderer/classes/RootEntityCollection.md
+++ b/docs/tech/3.renderer/classes/RootEntityCollection.md
@@ -298,7 +298,7 @@ public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntit
See:
diff --git a/docs/tech/3.renderer/classes/RootEntityInterface.md b/docs/tech/3.renderer/classes/RootEntityInterface.md
index 7d97a5c6..1ba150ef 100644
--- a/docs/tech/3.renderer/classes/RootEntityInterface.md
+++ b/docs/tech/3.renderer/classes/RootEntityInterface.md
@@ -63,6 +63,9 @@ their entities need to correspond to the same interfaces
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
@@ -148,7 +151,7 @@ public function getAbsoluteFileName(): string|null;
```php
@@ -169,7 +172,7 @@ public function getEntityDependencies(): array;
```php
@@ -213,7 +216,7 @@ public function getFileName(): string|null;
```php
@@ -374,6 +377,27 @@ public static function isEntityNameValid(string $entityName): bool;
Return value: bool
+
+
+
+
+
+
+```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
+
+
Parameters: not specified
+
+
Return value: bool
+
+
@@ -381,7 +405,7 @@ public static function isEntityNameValid(string $entityName): bool;
```php
diff --git a/docs/tech/3.renderer/classes/RootEntityInterface_2.md b/docs/tech/3.renderer/classes/RootEntityInterface_2.md
index 7badee12..f771214c 100644
--- a/docs/tech/3.renderer/classes/RootEntityInterface_2.md
+++ b/docs/tech/3.renderer/classes/RootEntityInterface_2.md
@@ -1,5 +1,5 @@
-
+
RootEntityInterface class:
@@ -63,6 +63,9 @@ their entities need to correspond to the same interfaces
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
@@ -148,7 +151,7 @@ public function getAbsoluteFileName(): string|null;
```php
@@ -169,7 +172,7 @@ public function getEntityDependencies(): array;
```php
@@ -213,7 +216,7 @@ public function getFileName(): string|null;
```php
@@ -374,6 +377,27 @@ public static function isEntityNameValid(string $entityName): bool;
Return value: bool
+
+
+
+
+
+```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
+
+
Parameters: not specified
+
+
Return value: bool
+
+
@@ -381,7 +405,7 @@ public static function isEntityNameValid(string $entityName): bool;
```php
diff --git a/docs/tech/3.renderer/classes/StrTypeToUrl.md b/docs/tech/3.renderer/classes/StrTypeToUrl.md
index 89c5aa44..3ceef34f 100644
--- a/docs/tech/3.renderer/classes/StrTypeToUrl.md
+++ b/docs/tech/3.renderer/classes/StrTypeToUrl.md
@@ -2,7 +2,7 @@
@@ -77,7 +77,7 @@ See:
```php
@@ -124,7 +124,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\RendererHelper $renderer
```php
@@ -170,22 +170,6 @@ public function __invoke(string $text, \BumbleDocGen\Core\Parser\Entity\RootEnti
Return value: string
-
Throws:
-
-
@@ -193,7 +177,7 @@ public function __invoke(string $text, \BumbleDocGen\Core\Parser\Entity\RootEnti
```php
@@ -214,7 +198,7 @@ public static function getName(): string;
```php
diff --git a/docs/tech/3.renderer/readme.md b/docs/tech/3.renderer/readme.md
index 37d1604e..800c1393 100644
--- a/docs/tech/3.renderer/readme.md
+++ b/docs/tech/3.renderer/readme.md
@@ -60,4 +60,4 @@ This process is presented in the form of a diagram below.
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Mon Nov 06 2023
Made with
Bumble Documentation Generator
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/templatesLinking.md b/docs/tech/3.renderer/templatesLinking.md
index 32623d36..acd69845 100644
--- a/docs/tech/3.renderer/templatesLinking.md
+++ b/docs/tech/3.renderer/templatesLinking.md
@@ -27,4 +27,4 @@ You can also implement your own functions for relinking if necessary.
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/templatesVariables.md b/docs/tech/3.renderer/templatesVariables.md
index 18860755..cf73d7a0 100644
--- a/docs/tech/3.renderer/templatesVariables.md
+++ b/docs/tech/3.renderer/templatesVariables.md
@@ -11,4 +11,4 @@ There are several variables available in each processed template.
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Tue Oct 31 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/4.pluginSystem/classes/AfterLoadingClassEntityCollection.md b/docs/tech/4.pluginSystem/classes/AfterLoadingClassEntityCollection.md
index 044d0ff5..d1fde6a2 100644
--- a/docs/tech/4.pluginSystem/classes/AfterLoadingClassEntityCollection.md
+++ b/docs/tech/4.pluginSystem/classes/AfterLoadingClassEntityCollection.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Parser;
-final class AfterLoadingClassEntityCollection extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class AfterLoadingClassEntityCollection extends \Symfony\Contracts\EventDispatcher\Event
```
The event is called after the initial creation of a collection of class entities
diff --git a/docs/tech/4.pluginSystem/classes/AfterRenderingEntities.md b/docs/tech/4.pluginSystem/classes/AfterRenderingEntities.md
index ee57fae3..37f8776d 100644
--- a/docs/tech/4.pluginSystem/classes/AfterRenderingEntities.md
+++ b/docs/tech/4.pluginSystem/classes/AfterRenderingEntities.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class AfterRenderingEntities extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class AfterRenderingEntities extends \Symfony\Contracts\EventDispatcher\Event
```
Event is the base class for classes containing event data.
diff --git a/docs/tech/4.pluginSystem/classes/BeforeCreatingDocFile.md b/docs/tech/4.pluginSystem/classes/BeforeCreatingDocFile.md
index 28977bea..6c8bd9da 100644
--- a/docs/tech/4.pluginSystem/classes/BeforeCreatingDocFile.md
+++ b/docs/tech/4.pluginSystem/classes/BeforeCreatingDocFile.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class BeforeCreatingDocFile extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class BeforeCreatingDocFile extends \Symfony\Contracts\EventDispatcher\Event
```
Called before the content of the documentation document is saved to a file
diff --git a/docs/tech/4.pluginSystem/classes/BeforeRenderingDocFiles.md b/docs/tech/4.pluginSystem/classes/BeforeRenderingDocFiles.md
index 10df4a78..68122b37 100644
--- a/docs/tech/4.pluginSystem/classes/BeforeRenderingDocFiles.md
+++ b/docs/tech/4.pluginSystem/classes/BeforeRenderingDocFiles.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class BeforeRenderingDocFiles extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class BeforeRenderingDocFiles extends \Symfony\Contracts\EventDispatcher\Event
```
The event occurs before the main documents begin rendering
diff --git a/docs/tech/4.pluginSystem/classes/BeforeRenderingEntities.md b/docs/tech/4.pluginSystem/classes/BeforeRenderingEntities.md
index a57268a7..0ad8070a 100644
--- a/docs/tech/4.pluginSystem/classes/BeforeRenderingEntities.md
+++ b/docs/tech/4.pluginSystem/classes/BeforeRenderingEntities.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class BeforeRenderingEntities extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+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
diff --git a/docs/tech/4.pluginSystem/classes/OnAddClassEntityToCollection.md b/docs/tech/4.pluginSystem/classes/OnAddClassEntityToCollection.md
index cd2cd987..8247594d 100644
--- a/docs/tech/4.pluginSystem/classes/OnAddClassEntityToCollection.md
+++ b/docs/tech/4.pluginSystem/classes/OnAddClassEntityToCollection.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Parser;
-final class OnAddClassEntityToCollection extends \Symfony\Contracts\EventDispatcher\Event implements \BumbleDocGen\Core\Plugin\OnlySingleExecutionEvent, \Psr\EventDispatcher\StoppableEventInterface
+final class OnAddClassEntityToCollection extends \Symfony\Contracts\EventDispatcher\Event implements \BumbleDocGen\Core\Plugin\OnlySingleExecutionEvent
```
Called when each class entity is added to the entity collection
diff --git a/docs/tech/4.pluginSystem/classes/OnCheckIsClassEntityCanBeLoad.md b/docs/tech/4.pluginSystem/classes/OnCheckIsClassEntityCanBeLoad.md
index 72a1eac6..2c3a1991 100644
--- a/docs/tech/4.pluginSystem/classes/OnCheckIsClassEntityCanBeLoad.md
+++ b/docs/tech/4.pluginSystem/classes/OnCheckIsClassEntityCanBeLoad.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity;
-final class OnCheckIsClassEntityCanBeLoad extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class OnCheckIsClassEntityCanBeLoad extends \Symfony\Contracts\EventDispatcher\Event
```
Event is the base class for classes containing event data.
diff --git a/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md b/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md
index 300a593b..b0dbaf39 100644
--- a/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md
+++ b/docs/tech/4.pluginSystem/classes/OnCreateDocumentedEntityWrapper.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class OnCreateDocumentedEntityWrapper extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class OnCreateDocumentedEntityWrapper extends \Symfony\Contracts\EventDispatcher\Event
```
The event occurs when an entity is added to the list for documentation
diff --git a/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md b/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md
index 889c3574..e9d504ac 100644
--- a/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md
+++ b/docs/tech/4.pluginSystem/classes/OnGetProjectTemplatesDirs.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class OnGetProjectTemplatesDirs extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class OnGetProjectTemplatesDirs extends \Symfony\Contracts\EventDispatcher\Event
```
This event occurs when all directories containing document templates are retrieved
diff --git a/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md b/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md
index ec4c765d..64f9ac0b 100644
--- a/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md
+++ b/docs/tech/4.pluginSystem/classes/OnGetTemplatePathByRelativeDocPath.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class OnGetTemplatePathByRelativeDocPath extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+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
diff --git a/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md b/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md
index c8ede590..55ab7614 100644
--- a/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md
+++ b/docs/tech/4.pluginSystem/classes/OnGettingResourceLink.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Event
```
Event occurs when a reference to an entity (resource) is received
diff --git a/docs/tech/4.pluginSystem/classes/OnLoadEntityDocPluginContent.md b/docs/tech/4.pluginSystem/classes/OnLoadEntityDocPluginContent.md
index f0ceccd6..e03471f4 100644
--- a/docs/tech/4.pluginSystem/classes/OnLoadEntityDocPluginContent.md
+++ b/docs/tech/4.pluginSystem/classes/OnLoadEntityDocPluginContent.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
-final class OnLoadEntityDocPluginContent extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class OnLoadEntityDocPluginContent extends \Symfony\Contracts\EventDispatcher\Event
```
Called when entity documentation is generated (plugin content loading)
diff --git a/docs/tech/4.pluginSystem/classes/OnLoadSourceLocatorsCollection.md b/docs/tech/4.pluginSystem/classes/OnLoadSourceLocatorsCollection.md
index bba0eed7..0bc4f882 100644
--- a/docs/tech/4.pluginSystem/classes/OnLoadSourceLocatorsCollection.md
+++ b/docs/tech/4.pluginSystem/classes/OnLoadSourceLocatorsCollection.md
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Core\Plugin\Event\Parser;
-final class OnLoadSourceLocatorsCollection extends \Symfony\Contracts\EventDispatcher\Event implements \Psr\EventDispatcher\StoppableEventInterface
+final class OnLoadSourceLocatorsCollection extends \Symfony\Contracts\EventDispatcher\Event
```
Called when source locators are loaded
diff --git a/docs/tech/4.pluginSystem/classes/PhpUnitStubberPlugin.md b/docs/tech/4.pluginSystem/classes/PhpUnitStubberPlugin.md
index 1c6e9b9c..30956139 100644
--- a/docs/tech/4.pluginSystem/classes/PhpUnitStubberPlugin.md
+++ b/docs/tech/4.pluginSystem/classes/PhpUnitStubberPlugin.md
@@ -71,7 +71,7 @@ public static function getSubscribedEvents(): array;
```php
diff --git a/docs/tech/4.pluginSystem/classes/StubberPlugin.md b/docs/tech/4.pluginSystem/classes/StubberPlugin.md
index e47ed002..eae9c06f 100644
--- a/docs/tech/4.pluginSystem/classes/StubberPlugin.md
+++ b/docs/tech/4.pluginSystem/classes/StubberPlugin.md
@@ -2,7 +2,7 @@
@@ -57,11 +57,11 @@ final class StubberPlugin implements \BumbleDocGen\Core\Plugin\PluginInterface,
```php
-public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration);
+public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\ComposerParser $composerParser);
```
@@ -78,8 +78,8 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
@@ -94,7 +94,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
```php
@@ -115,7 +115,7 @@ public static function getSubscribedEvents(): array;
```php
@@ -160,7 +160,7 @@ public function onCheckIsClassEntityCanBeLoad(\BumbleDocGen\LanguageHandler\Php\
```php
diff --git a/docs/tech/4.pluginSystem/readme.md b/docs/tech/4.pluginSystem/readme.md
index b93c5027..01f7ca5b 100644
--- a/docs/tech/4.pluginSystem/readme.md
+++ b/docs/tech/4.pluginSystem/readme.md
@@ -190,4 +190,4 @@ plugins: