diff --git a/.gitignore b/.gitignore index 0bc45760..5cbbce09 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ composer.phar /vendor/ .idea -/SelfDoc/__cache/ /demo/demo1/docs/ /demo/demo1/__cache/ /demo/demo2-templates-generation/__cache/ @@ -13,3 +12,4 @@ composer.phar /last_run.log /.phpunit.result.cache /demo/demo2-templates-generation/templates/ +/.bumbleDocGenCache/ diff --git a/SelfDoc/Configuration/config.yaml b/SelfDoc/Configuration/config.yaml deleted file mode 100644 index 5fa09bea..00000000 --- a/SelfDoc/Configuration/config.yaml +++ /dev/null @@ -1,25 +0,0 @@ -project_root: '%DOC_GEN_LIB_PATH%' -templates_dir: '%DOC_GEN_LIB_PATH%/SelfDoc/Configuration/templates' -cache_dir: '%project_root%/SelfDoc/__cache' -language_handlers: - php: - class: \BumbleDocGen\LanguageHandler\Php\PhpHandler - settings: - file_source_base_url: 'https://github.com/bumble-tech/bumble-doc-gen/blob/master' - async_source_loading_enabled: true -source_locators: - - class: \BumbleDocGen\Core\Parser\SourceLocator\RecursiveDirectoriesSourceLocator - arguments: - directories: - - "%project_root%/BumbleDocGen" - - "%project_root%/SelfDoc" -twig_filters: - - class: \SelfDoc\Configuration\Twig\CustomFilter\EvalString -twig_functions: - - class: \SelfDoc\Configuration\Twig\CustomFunction\FindEntitiesClassesByCollectionClassName - - class: \SelfDoc\Configuration\Twig\CustomFunction\PrintClassCollectionAsGroupedTable - - class: \SelfDoc\Configuration\Twig\CustomFunction\GetConfigParametersDescription -plugins: - - class: \SelfDoc\Configuration\Plugin\RoaveStubber\BetterReflectionStubberPlugin - - class: \SelfDoc\Configuration\Plugin\TwigFilterClassParser\TwigFilterClassParserPlugin - - class: \SelfDoc\Configuration\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin diff --git a/SelfDoc/Console/App.php b/SelfDoc/Console/App.php deleted file mode 100644 index 51804d51..00000000 --- a/SelfDoc/Console/App.php +++ /dev/null @@ -1,17 +0,0 @@ -add(new GenerateCommand()); - } -} diff --git a/SelfDoc/Console/Command/GenerateCommand.php b/SelfDoc/Console/Command/GenerateCommand.php deleted file mode 100644 index a6665750..00000000 --- a/SelfDoc/Console/Command/GenerateCommand.php +++ /dev/null @@ -1,42 +0,0 @@ -setName('generate'); - } - - /** - * @throws SyntaxError - * @throws NotFoundException - * @throws RuntimeError - * @throws DependencyException - * @throws LoaderError - * @throws InvalidArgumentException - */ - protected function execute( - \Symfony\Component\Console\Input\InputInterface $input, - \Symfony\Component\Console\Output\OutputInterface $output - ): int - { - $docGenerator = (new DocGeneratorFactory())->create( - dirname(__DIR__, 2) . '/Configuration/config.yaml' - ); - $docGenerator->generate(); - return self::SUCCESS; - } -} diff --git a/SelfDoc/docGen.php b/SelfDoc/docGen.php deleted file mode 100644 index 574dc74b..00000000 --- a/SelfDoc/docGen.php +++ /dev/null @@ -1,8 +0,0 @@ -#!/usr/bin/env php -run(); \ No newline at end of file diff --git a/bin/bumbleDocGen b/bin/bumbleDocGen new file mode 100755 index 00000000..ddd02ff5 --- /dev/null +++ b/bin/bumbleDocGen @@ -0,0 +1,22 @@ +#!/usr/bin/env php +run(); diff --git a/bumble_doc_gen.yaml b/bumble_doc_gen.yaml new file mode 100644 index 00000000..cd0da1e7 --- /dev/null +++ b/bumble_doc_gen.yaml @@ -0,0 +1,27 @@ +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' + async_source_loading_enabled: true +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 +plugins: + - class: \SelfDocConfig\Plugin\RoaveStubber\BetterReflectionStubberPlugin + - class: \SelfDocConfig\Plugin\TwigFilterClassParser\TwigFilterClassParserPlugin + - class: \SelfDocConfig\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin diff --git a/composer.json b/composer.json index 2fa304d1..b1a3cfcd 100644 --- a/composer.json +++ b/composer.json @@ -46,16 +46,16 @@ }, "autoload": { "psr-4": { - "BumbleDocGen\\": "BumbleDocGen/" + "BumbleDocGen\\": "src/" }, "files": [ - "BumbleDocGen/Core/utils.php" + "src/Core/utils.php" ] }, "autoload-dev": { "psr-4": { "Test\\": "tests/", - "SelfDoc\\": "SelfDoc/" + "SelfDocConfig\\": "selfdoc/" } }, "config": { @@ -63,5 +63,8 @@ "php-http/discovery": true, "captainhook/plugin-composer": true } - } + }, + "bin": [ + "bin/bumbleDocGen" + ] } diff --git a/docs/readme.md b/docs/README.md similarity index 83% rename from docs/readme.md rename to docs/README.md index be5deb5d..df29b435 100644 --- a/docs/readme.md +++ b/docs/README.md @@ -49,6 +49,8 @@ BumbleDocGen's interface consists of mainly two classes: BumbleDocGen / DocGenerator
+ BumbleDocGen / DocGenerator

- DocGenerator class: + DocGenerator class:

@@ -55,11 +55,11 @@ final class DocGenerator @@ -74,7 +74,7 @@ final class DocGenerator ```php @@ -106,32 +106,32 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo $configuration - \BumbleDocGen\Core\Configuration\Configuration + \BumbleDocGen\Core\Configuration\Configuration - $parser - \BumbleDocGen\Core\Parser\ProjectParser + \BumbleDocGen\Core\Parser\ProjectParser - $parserHelper - \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper + \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper - $renderer - \BumbleDocGen\Core\Renderer\Renderer + \BumbleDocGen\Core\Renderer\Renderer - $rootEntityCollectionsGroup - \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup + \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup - $logger - \Monolog\Logger + \Monolog\Logger - @@ -146,7 +146,7 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo ```php @@ -163,10 +163,10 @@ public function addMissingDocBlocks(): void; Throws: @@ -186,7 +186,7 @@ public function addMissingDocBlocks(): void; ```php @@ -206,13 +206,13 @@ public function fillInReadmeMdTemplate(): void; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \DI\DependencyException
    • + \DI\DependencyException
  • - \Tectalic\OpenAi\ClientException
    • + \Tectalic\OpenAi\ClientException
  • - \DI\NotFoundException
    • + \DI\NotFoundException
  • \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
    • @@ -226,7 +226,7 @@ public function fillInReadmeMdTemplate(): void; ```php @@ -254,7 +254,7 @@ public function generate(): void; ```php @@ -271,16 +271,16 @@ public function generateProjectTemplatesStructure(): void; Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getThrows(): array; +``` + +
    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 hasDescriptionLinks(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function hasExamples(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function hasThrows(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isDeprecated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait + +public function isEntityDataCacheOutdated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isEntityFileCanBeLoad(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isInternal(): bool; +``` + + + +Parameters: not specified + +Return value: bool + +
    @@ -559,7 +1161,7 @@ public function getStartLine(): int; ```php @@ -590,7 +1192,7 @@ public function isPrivate(): bool; ```php @@ -621,7 +1223,7 @@ public function isProtected(): bool; ```php @@ -645,6 +1247,66 @@ public function isPublic(): bool; +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function reloadEntityDependenciesCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait + +public function removeNotUsedEntityDataCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + +
    diff --git a/docs/tech/2.parser/classes/ConstantEntityCollection.md b/docs/tech/2.parser/classes/ConstantEntityCollection.md index 9e2f4516..da8e409c 100644 --- a/docs/tech/2.parser/classes/ConstantEntityCollection.md +++ b/docs/tech/2.parser/classes/ConstantEntityCollection.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / ConstantEntityCollection
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / ConstantEntityCollection

    - ConstantEntityCollection class: + ConstantEntityCollection class:

    @@ -39,9 +39,21 @@ final class ConstantEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Ba
  • get
    • +
  • + getIterator + - Retrieve an external iterator
    • +
  • + has +
    • +
  • + isEmpty +
  • loadConstantEntities
    • +
  • + remove +
  • unsafeGet
    • @@ -60,7 +72,7 @@ final class ConstantEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Ba ```php @@ -82,17 +94,17 @@ public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Clas $classEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity - $phpHandlerSettings - \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings + \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings - $cacheablePhpEntityFactory - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory - @@ -107,7 +119,7 @@ public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Clas ```php @@ -129,7 +141,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEnti $constantEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity - @@ -140,7 +152,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEnti -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntityCollection @@ -150,7 +162,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEnti ```php @@ -178,7 +190,106 @@ public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parse -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | null + + + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function getIterator(): \Generator; +``` + +
    Retrieve an external iterator
    + +Parameters: not specified + +Return value: \Generator + + +Throws: + + + +See: + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function has(string $objectName): bool; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function isEmpty(): bool; +``` + + + +Parameters: not specified + +Return value: bool
    @@ -188,7 +299,7 @@ public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parse ```php @@ -205,10 +316,10 @@ public function loadConstantEntities(): void; Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function remove(string $objectName): void; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: void + +
    @@ -225,7 +376,7 @@ public function loadConstantEntities(): void; ```php @@ -253,19 +404,19 @@ public function unsafeGet(string $constantName): \BumbleDocGen\LanguageHandler\P -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | null Throws:
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator + +public function getFinder(): \Symfony\Component\Finder\Finder; +``` + + + +Parameters: not specified + +Return value: \Symfony\Component\Finder\Finder + +
    diff --git a/docs/tech/2.parser/classes/DynamicMethodEntity.md b/docs/tech/2.parser/classes/DynamicMethodEntity.md index 38fb8e42..6f3ff0f4 100644 --- a/docs/tech/2.parser/classes/DynamicMethodEntity.md +++ b/docs/tech/2.parser/classes/DynamicMethodEntity.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / DynamicMethodEntity
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / DynamicMethodEntity

    - DynamicMethodEntity class: + DynamicMethodEntity class:

    @@ -135,7 +135,7 @@ class DynamicMethodEntity implements \BumbleDocGen\LanguageHandler\Php\Parser\En ```php @@ -157,17 +157,17 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf $configuration - \BumbleDocGen\Core\Configuration\Configuration + \BumbleDocGen\Core\Configuration\Configuration - $parserHelper - \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper + \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper - $classEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity - @@ -187,7 +187,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf ```php @@ -208,7 +208,7 @@ public function entityCacheIsOutdated(): bool; ```php @@ -236,7 +236,7 @@ public function getAbsoluteFileName(): string|null; ```php @@ -257,7 +257,7 @@ public function getBodyCode(): string; ```php @@ -268,7 +268,7 @@ public function getCallMethod(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity Throws: @@ -285,7 +285,7 @@ public function getCallMethod(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity ```php @@ -306,7 +306,7 @@ public function getDescription(): string; ```php @@ -334,7 +334,7 @@ public function getEndLine(): int; ```php @@ -365,7 +365,7 @@ public function getFileName(): string|null; ```php @@ -386,7 +386,7 @@ public function getFirstReturnValue(): mixed; ```php @@ -397,7 +397,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity @@ -407,7 +407,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser ```php @@ -435,7 +435,7 @@ public function getImplementingClassName(): string; ```php @@ -463,7 +463,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec ```php @@ -484,7 +484,7 @@ public function getModifiersString(): string; ```php @@ -505,7 +505,7 @@ public function getName(): string; ```php @@ -536,7 +536,7 @@ public function getNamespaceName(): string; ```php @@ -557,7 +557,7 @@ public function getObjectId(): string; ```php @@ -578,7 +578,7 @@ public function getParameters(): array; ```php @@ -599,7 +599,7 @@ public function getParametersString(): string; ```php @@ -630,7 +630,7 @@ public function getReturnType(): string; ```php @@ -641,7 +641,7 @@ public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity @@ -651,7 +651,7 @@ public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity ```php @@ -662,7 +662,7 @@ public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\Root Parameters: not specified -Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection @@ -672,7 +672,7 @@ public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\Root ```php @@ -693,7 +693,7 @@ public function getShortName(): string; ```php @@ -721,7 +721,7 @@ public function getStartColumn(): int; ```php @@ -749,7 +749,7 @@ public function getStartLine(): int; ```php @@ -770,7 +770,7 @@ public function isDynamic(): bool; ```php @@ -804,7 +804,7 @@ public function isInitialization(): bool; ```php @@ -825,7 +825,7 @@ public function isPrivate(): bool; ```php @@ -846,7 +846,7 @@ public function isProtected(): bool; ```php @@ -867,7 +867,7 @@ public function isPublic(): bool; ```php diff --git a/docs/tech/2.parser/classes/EntityInterface.md b/docs/tech/2.parser/classes/EntityInterface.md index 7577d260..cd202273 100644 --- a/docs/tech/2.parser/classes/EntityInterface.md +++ b/docs/tech/2.parser/classes/EntityInterface.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / EntityInterface
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / EntityInterface

    - EntityInterface class: + EntityInterface class:

    @@ -62,7 +62,7 @@ interface EntityInterface ```php @@ -83,7 +83,7 @@ public function entityCacheIsOutdated(): bool; ```php @@ -104,7 +104,7 @@ public function getAbsoluteFileName(): string|null; ```php @@ -125,7 +125,7 @@ public function getFileName(): string|null; ```php @@ -146,7 +146,7 @@ public function getName(): string; ```php @@ -167,7 +167,7 @@ public function getObjectId(): string; ```php @@ -178,7 +178,7 @@ public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\Root Parameters: not specified -Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection @@ -188,7 +188,7 @@ public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\Root ```php diff --git a/docs/tech/2.parser/classes/FalseCondition.md b/docs/tech/2.parser/classes/FalseCondition.md index d8b092a4..dfd9997f 100644 --- a/docs/tech/2.parser/classes/FalseCondition.md +++ b/docs/tech/2.parser/classes/FalseCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / FalseCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / FalseCondition

    - FalseCondition class: + FalseCondition class:

    @@ -44,7 +44,7 @@ final class FalseCondition implements \BumbleDocGen\Core\Parser\FilterCondition\ ```php @@ -66,7 +66,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/FileIteratorSourceLocator.md b/docs/tech/2.parser/classes/FileIteratorSourceLocator.md index 88367c7a..c9c48cb3 100644 --- a/docs/tech/2.parser/classes/FileIteratorSourceLocator.md +++ b/docs/tech/2.parser/classes/FileIteratorSourceLocator.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Source locators / FileIteratorSourceLocator
    + BumbleDocGen / Technical description of the project / Parser / Source locators / FileIteratorSourceLocator

    - FileIteratorSourceLocator class: + FileIteratorSourceLocator class:

    @@ -30,6 +30,13 @@ final class FileIteratorSourceLocator extends \BumbleDocGen\Core\Parser\SourceLo +

    Methods:

    + +
      +
    1. + getFinder +
      2. +
    @@ -44,7 +51,7 @@ final class FileIteratorSourceLocator extends \BumbleDocGen\Core\Parser\SourceLo ```php @@ -74,6 +81,29 @@ public function __construct(\Iterator $fileInfoIterator); + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator + +public function getFinder(): \Symfony\Component\Finder\Finder; +``` + + + +Parameters: not specified + +Return value: \Symfony\Component\Finder\Finder + +
    diff --git a/docs/tech/2.parser/classes/FileTextContainsCondition.md b/docs/tech/2.parser/classes/FileTextContainsCondition.md index 1a1c0f54..63465ee0 100644 --- a/docs/tech/2.parser/classes/FileTextContainsCondition.md +++ b/docs/tech/2.parser/classes/FileTextContainsCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / FileTextContainsCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / FileTextContainsCondition

    - FileTextContainsCondition class: + FileTextContainsCondition class:

    @@ -51,7 +51,7 @@ final class FileTextContainsCondition implements \BumbleDocGen\Core\Parser\Filte ```php @@ -88,7 +88,7 @@ public function __construct(string $substring); ```php @@ -110,7 +110,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/InvalidConfigurationParameterException.md b/docs/tech/2.parser/classes/InvalidConfigurationParameterException.md index 1b8ef345..528879c8 100644 --- a/docs/tech/2.parser/classes/InvalidConfigurationParameterException.md +++ b/docs/tech/2.parser/classes/InvalidConfigurationParameterException.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / InvalidConfigurationParameterException
    + BumbleDocGen / Technical description of the project / Parser / InvalidConfigurationParameterException

    - InvalidConfigurationParameterException class: + InvalidConfigurationParameterException class:

    @@ -29,13 +29,363 @@ See: +

    Initialization methods:

    +
      +
    1. + __construct + - Construct the exception. Note: The message is NOT binary safe.
      2. +
    +

    Methods:

    +
      +
    1. + __toString + - String representation of the exception
      2. +
    2. + __wakeup +
      3. +
    3. + getCode + - Gets the Exception code
      4. +
    4. + getFile + - Gets the file in which the exception occurred
      5. +
    5. + getLine + - Gets the line in which the exception occurred
      6. +
    6. + getMessage + - Gets the Exception message
      7. +
    7. + getPrevious + - Returns previous Exception
      8. +
    8. + getTrace + - Gets the stack trace
      9. +
    9. + getTraceAsString + - Gets the stack trace as a string
      10. +
    + +

    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: + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $messagestring[optional] The Exception message to throw.
    $codeint[optional] The Exception code.
    $previousThrowable | 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: + +
    +
    +
    + + + +```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/InvalidConfigurationParameterException_2.md b/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md index f59eb7e9..8799bda6 100644 --- a/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md +++ b/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / InvalidConfigurationParameterException
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / InvalidConfigurationParameterException

    - InvalidConfigurationParameterException class: + InvalidConfigurationParameterException class:

    @@ -29,13 +29,363 @@ See: +

    Initialization methods:

    +
      +
    1. + __construct + - Construct the exception. Note: The message is NOT binary safe.
      2. +
    +

    Methods:

    +
      +
    1. + __toString + - String representation of the exception
      2. +
    2. + __wakeup +
      3. +
    3. + getCode + - Gets the Exception code
      4. +
    4. + getFile + - Gets the file in which the exception occurred
      5. +
    5. + getLine + - Gets the line in which the exception occurred
      6. +
    6. + getMessage + - Gets the Exception message
      7. +
    7. + getPrevious + - Returns previous Exception
      8. +
    8. + getTrace + - Gets the stack trace
      9. +
    9. + getTraceAsString + - Gets the stack trace as a string
      10. +
    + +

    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: + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $messagestring[optional] The Exception message to throw.
    $codeint[optional] The Exception code.
    $previousThrowable | 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: + +
    +
    +
    + + + +```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/InvalidConfigurationParameterException_3.md b/docs/tech/2.parser/classes/InvalidConfigurationParameterException_3.md index a5fb98f5..8e2c5564 100644 --- a/docs/tech/2.parser/classes/InvalidConfigurationParameterException_3.md +++ b/docs/tech/2.parser/classes/InvalidConfigurationParameterException_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / InvalidConfigurationParameterException
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / InvalidConfigurationParameterException

    - InvalidConfigurationParameterException class: + InvalidConfigurationParameterException class:

    @@ -29,13 +29,363 @@ See: +

    Initialization methods:

    +
      +
    1. + __construct + - Construct the exception. Note: The message is NOT binary safe.
      2. +
    +

    Methods:

    +
      +
    1. + __toString + - String representation of the exception
      2. +
    2. + __wakeup +
      3. +
    3. + getCode + - Gets the Exception code
      4. +
    4. + getFile + - Gets the file in which the exception occurred
      5. +
    5. + getLine + - Gets the line in which the exception occurred
      6. +
    6. + getMessage + - Gets the Exception message
      7. +
    7. + getPrevious + - Returns previous Exception
      8. +
    8. + getTrace + - Gets the stack trace
      9. +
    9. + getTraceAsString + - Gets the stack trace as a string
      10. +
    + +

    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: + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $messagestring[optional] The Exception message to throw.
    $codeint[optional] The Exception code.
    $previousThrowable | 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: + +
    +
    +
    + + + +```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/IsPrivateCondition.md b/docs/tech/2.parser/classes/IsPrivateCondition.md index 35444942..ff5141f1 100644 --- a/docs/tech/2.parser/classes/IsPrivateCondition.md +++ b/docs/tech/2.parser/classes/IsPrivateCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPrivateCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPrivateCondition

    - IsPrivateCondition class: + IsPrivateCondition class:

    @@ -51,7 +51,7 @@ final class IsPrivateCondition implements \BumbleDocGen\Core\Parser\FilterCondit ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsPrivateCondition_2.md b/docs/tech/2.parser/classes/IsPrivateCondition_2.md index 933545cb..4cc8afd7 100644 --- a/docs/tech/2.parser/classes/IsPrivateCondition_2.md +++ b/docs/tech/2.parser/classes/IsPrivateCondition_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPrivateCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPrivateCondition

    - IsPrivateCondition class: + IsPrivateCondition class:

    @@ -51,7 +51,7 @@ final class IsPrivateCondition implements \BumbleDocGen\Core\Parser\FilterCondit ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsPrivateCondition_3.md b/docs/tech/2.parser/classes/IsPrivateCondition_3.md index 606ec6a7..d2439ee5 100644 --- a/docs/tech/2.parser/classes/IsPrivateCondition_3.md +++ b/docs/tech/2.parser/classes/IsPrivateCondition_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPrivateCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPrivateCondition

    - IsPrivateCondition class: + IsPrivateCondition class:

    @@ -51,7 +51,7 @@ final class IsPrivateCondition implements \BumbleDocGen\Core\Parser\FilterCondit ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsProtectedCondition.md b/docs/tech/2.parser/classes/IsProtectedCondition.md index 8a1ba2c0..4c045b51 100644 --- a/docs/tech/2.parser/classes/IsProtectedCondition.md +++ b/docs/tech/2.parser/classes/IsProtectedCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsProtectedCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsProtectedCondition

    - IsProtectedCondition class: + IsProtectedCondition class:

    @@ -51,7 +51,7 @@ final class IsProtectedCondition implements \BumbleDocGen\Core\Parser\FilterCond ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsProtectedCondition_2.md b/docs/tech/2.parser/classes/IsProtectedCondition_2.md index 370e7cd0..a76e0135 100644 --- a/docs/tech/2.parser/classes/IsProtectedCondition_2.md +++ b/docs/tech/2.parser/classes/IsProtectedCondition_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsProtectedCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsProtectedCondition

    - IsProtectedCondition class: + IsProtectedCondition class:

    @@ -51,7 +51,7 @@ final class IsProtectedCondition implements \BumbleDocGen\Core\Parser\FilterCond ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsProtectedCondition_3.md b/docs/tech/2.parser/classes/IsProtectedCondition_3.md index 079746d8..e2e2beb9 100644 --- a/docs/tech/2.parser/classes/IsProtectedCondition_3.md +++ b/docs/tech/2.parser/classes/IsProtectedCondition_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsProtectedCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsProtectedCondition

    - IsProtectedCondition class: + IsProtectedCondition class:

    @@ -51,7 +51,7 @@ final class IsProtectedCondition implements \BumbleDocGen\Core\Parser\FilterCond ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsPublicCondition.md b/docs/tech/2.parser/classes/IsPublicCondition.md index 09edab01..e2f61b40 100644 --- a/docs/tech/2.parser/classes/IsPublicCondition.md +++ b/docs/tech/2.parser/classes/IsPublicCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPublicCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPublicCondition

    - IsPublicCondition class: + IsPublicCondition class:

    @@ -51,7 +51,7 @@ final class IsPublicCondition implements \BumbleDocGen\Core\Parser\FilterConditi ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsPublicCondition_2.md b/docs/tech/2.parser/classes/IsPublicCondition_2.md index 8f5c8f53..319c2db1 100644 --- a/docs/tech/2.parser/classes/IsPublicCondition_2.md +++ b/docs/tech/2.parser/classes/IsPublicCondition_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPublicCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPublicCondition

    - IsPublicCondition class: + IsPublicCondition class:

    @@ -51,7 +51,7 @@ final class IsPublicCondition implements \BumbleDocGen\Core\Parser\FilterConditi ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/IsPublicCondition_3.md b/docs/tech/2.parser/classes/IsPublicCondition_3.md index 1407205e..f4eef9de 100644 --- a/docs/tech/2.parser/classes/IsPublicCondition_3.md +++ b/docs/tech/2.parser/classes/IsPublicCondition_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPublicCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / IsPublicCondition

    - IsPublicCondition class: + IsPublicCondition class:

    @@ -51,7 +51,7 @@ final class IsPublicCondition implements \BumbleDocGen\Core\Parser\FilterConditi ```php @@ -71,7 +71,7 @@ public function __construct(); ```php @@ -93,7 +93,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/LocatedInCondition.md b/docs/tech/2.parser/classes/LocatedInCondition.md index a0b0d378..282b2a89 100644 --- a/docs/tech/2.parser/classes/LocatedInCondition.md +++ b/docs/tech/2.parser/classes/LocatedInCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / LocatedInCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / LocatedInCondition

    - LocatedInCondition class: + LocatedInCondition class:

    @@ -51,7 +51,7 @@ final class LocatedInCondition implements \BumbleDocGen\Core\Parser\FilterCondit ```php @@ -73,12 +73,12 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf $configuration - \BumbleDocGen\Core\Configuration\Configuration + \BumbleDocGen\Core\Configuration\Configuration - $parameterBag - \BumbleDocGen\Core\Configuration\ConfigurationParameterBag + \BumbleDocGen\Core\Configuration\ConfigurationParameterBag - @@ -98,7 +98,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf ```php @@ -120,7 +120,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/MethodEntity.md b/docs/tech/2.parser/classes/MethodEntity.md index 8e5a8461..278ab715 100644 --- a/docs/tech/2.parser/classes/MethodEntity.md +++ b/docs/tech/2.parser/classes/MethodEntity.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / MethodEntity
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / MethodEntity

    - MethodEntity class: + MethodEntity class:

    @@ -33,12 +33,27 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE

    Methods:

      +
    1. + entityCacheIsOutdated +
      2. +
    2. + getAbsoluteFileName + - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
    3. getBodyCode
      4. +
    4. + getCacheKey +
      5. +
    5. + getCachedEntityDependencies +
    6. getDescription
      7. +
    7. + getDescriptionLinks + - Get parsed links from description and doc blocks `see` and `link`
    8. getDocBlock
      9. @@ -57,12 +72,24 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE
    9. getDocCommentRecursive
      10. +
    10. + getDocNote +
    11. getEndLine
      12. +
    12. + getExamples + - Get parsed examples from `examples` doc block
    13. getFileName
      14. +
    14. + getFileSourceLink +
      15. +
    15. + getFirstExample + - Get first example from @examples doc block
    16. getFirstReturnValue
      17. @@ -84,6 +111,9 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE
    17. getNamespaceName
      18. +
    18. + getObjectId + - Get entity unique ID
    19. getParameters
      20. @@ -117,18 +147,42 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE
    20. getStartLine
      21. +
    21. + getThrows + - Get parsed throws from `throws` doc block
      22. +
    22. + hasDescriptionLinks +
      23. +
    23. + hasExamples +
      24. +
    24. + hasThrows +
    25. isConstructor
      26. +
    26. + isDeprecated +
    27. isDynamic
      28. +
    28. + isEntityDataCacheOutdated +
      29. +
    29. + isEntityFileCanBeLoad +
    30. isImplementedInParentClass
    31. isInitialization
      32. +
    32. + isInternal +
    33. isPrivate
      34. @@ -144,6 +198,12 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE
    34. parseAnnotationParams
      35. +
    35. + reloadEntityDependenciesCache +
      36. +
    36. + removeNotUsedEntityDataCache +
    @@ -159,7 +219,7 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE ```php @@ -181,22 +241,22 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf $configuration - \BumbleDocGen\Core\Configuration\Configuration + \BumbleDocGen\Core\Configuration\Configuration - $classEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity - $parserHelper - \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper + \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper - $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -224,6 +284,69 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf + +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function entityCacheIsOutdated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getAbsoluteFileName(): string|null; +``` + +
    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: string | null + + +Throws: + +
    @@ -231,7 +354,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf ```php @@ -259,10 +382,63 @@ public function getBodyCode(): string;
    + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getCacheKey(): string; +``` + + + +Parameters: not specified + +Return value: string + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getCachedEntityDependencies(): array; +``` + + + +Parameters: not specified + +Return value: array + + +Throws: + + +
    +
    +
    + ```php @@ -279,10 +455,10 @@ public function getDescription(): string; Throws: +
    +
    +
    + + + +```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 + +
    @@ -557,7 +812,7 @@ public function getEndLine(): int; ```php @@ -581,6 +836,76 @@ public function getFileName(): string|null; +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getFileSourceLink(bool $withLine = true): string|null; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $withLinebool-
    + +Return value: string | null + + +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 + +
    @@ -588,7 +913,7 @@ public function getFileName(): string|null; ```php @@ -619,7 +944,7 @@ public function getFirstReturnValue(): mixed; ```php @@ -630,7 +955,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity
    @@ -640,7 +965,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser ```php @@ -661,7 +986,7 @@ public function getImplementingClassName(): string; ```php @@ -692,7 +1017,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec ```php @@ -723,7 +1048,7 @@ public function getModifiersString(): string; ```php @@ -744,7 +1069,7 @@ public function getName(): string; ```php @@ -768,6 +1093,29 @@ public function getNamespaceName(): string; +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getObjectId(): string; +``` + +
    Get entity unique ID
    + +Parameters: not specified + +Return value: string + +
    @@ -775,7 +1123,7 @@ public function getNamespaceName(): string; ```php @@ -792,13 +1140,13 @@ public function getParameters(): array; Throws:
    @@ -873,7 +1221,7 @@ public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHa ```php @@ -884,7 +1232,7 @@ public function getPrototype(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | null Throws: @@ -893,10 +1241,10 @@ public function getPrototype(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \DI\DependencyException
    • + \DI\DependencyException
  • - \DI\NotFoundException
    • + \DI\NotFoundException
  • \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
    • @@ -910,7 +1258,7 @@ public function getPrototype(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ ```php @@ -927,13 +1275,13 @@ public function getReturnType(): string; Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getThrows(): array; +``` + +
    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 hasDescriptionLinks(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function hasExamples(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function hasThrows(): bool; +``` + + + +Parameters: not specified + +Return value: bool + +
    @@ -1109,7 +1566,7 @@ public function getStartLine(): int; ```php @@ -1118,6 +1575,29 @@ public function isConstructor(): bool; +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isDeprecated(): bool; +``` + + + Parameters: not specified Return value: bool @@ -1130,7 +1610,7 @@ public function isConstructor(): bool; ```php @@ -1144,6 +1624,69 @@ public function isDynamic(): bool; Return value: bool +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait + +public function isEntityDataCacheOutdated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isEntityFileCanBeLoad(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + +
    @@ -1151,7 +1694,7 @@ public function isDynamic(): bool; ```php @@ -1172,7 +1715,7 @@ public function isImplementedInParentClass(): bool; ```php @@ -1192,16 +1735,39 @@ public function isInitialization(): bool; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \DI\DependencyException
    • + \DI\DependencyException
  • - \DI\NotFoundException
    • + \DI\NotFoundException
  • \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
    • +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isInternal(): bool; +``` + + + +Parameters: not specified + +Return value: bool + +
    @@ -1209,7 +1775,7 @@ public function isInitialization(): bool; ```php @@ -1240,7 +1806,7 @@ public function isPrivate(): bool; ```php @@ -1271,7 +1837,7 @@ public function isProtected(): bool; ```php @@ -1302,7 +1868,7 @@ public function isPublic(): bool; ```php @@ -1333,7 +1899,7 @@ public function isStatic(): bool; ```php @@ -1364,6 +1930,66 @@ public static function parseAnnotationParams(array $params): array; Return value: array +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function reloadEntityDependenciesCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait + +public function removeNotUsedEntityDataCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + +
    diff --git a/docs/tech/2.parser/classes/MethodEntityCollection.md b/docs/tech/2.parser/classes/MethodEntityCollection.md index 1205edba..f658e2c3 100644 --- a/docs/tech/2.parser/classes/MethodEntityCollection.md +++ b/docs/tech/2.parser/classes/MethodEntityCollection.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / MethodEntityCollection
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / MethodEntityCollection

    - MethodEntityCollection class: + MethodEntityCollection class:

    @@ -45,9 +45,21 @@ final class MethodEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Base
  • getInitializations
    • +
  • + getIterator + - Retrieve an external iterator
    • +
  • + has +
    • +
  • + isEmpty +
  • loadMethodEntities
    • +
  • + remove +
  • unsafeGet
    • @@ -66,7 +78,7 @@ final class MethodEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Base ```php @@ -88,17 +100,17 @@ public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Clas $classEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity - $phpHandlerSettings - \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings + \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings - $cacheablePhpEntityFactory - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory - @@ -118,7 +130,7 @@ public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Clas ```php @@ -140,7 +152,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity $methodEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityInterface + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityInterface - @@ -151,7 +163,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityCollection @@ -161,7 +173,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity ```php @@ -189,7 +201,7 @@ public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parse -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | null @@ -199,7 +211,7 @@ public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parse ```php @@ -210,7 +222,7 @@ public function getAllExceptInitializations(): \BumbleDocGen\LanguageHandler\Php Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityCollection @@ -220,7 +232,7 @@ public function getAllExceptInitializations(): \BumbleDocGen\LanguageHandler\Php ```php @@ -231,7 +243,106 @@ public function getInitializations(): \BumbleDocGen\LanguageHandler\Php\Parser\E Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityCollection + + + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function getIterator(): \Generator; +``` + +
    Retrieve an external iterator
    + +Parameters: not specified + +Return value: \Generator + + +Throws: + + + +See: + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function has(string $objectName): bool; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function isEmpty(): bool; +``` + + + +Parameters: not specified + +Return value: bool
    @@ -241,7 +352,7 @@ public function getInitializations(): \BumbleDocGen\LanguageHandler\Php\Parser\E ```php @@ -261,16 +372,56 @@ public function loadMethodEntities(): void; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \DI\DependencyException
    • + \DI\DependencyException
  • - \DI\NotFoundException
    • + \DI\NotFoundException
  • \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
    • + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function remove(string $objectName): void; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: void + +
    @@ -278,7 +429,7 @@ public function loadMethodEntities(): void; ```php @@ -306,19 +457,19 @@ public function unsafeGet(string $objectName): \BumbleDocGen\LanguageHandler\Php -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | null Throws:
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function entityCacheIsOutdated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getAbsoluteFileName(): string|null; +``` + +
    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: string | null + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getCacheKey(): string; +``` + + + +Parameters: not specified + +Return value: string + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getCachedEntityDependencies(): array; +``` + + + +Parameters: not specified + +Return value: array + + +Throws: + +
    @@ -186,7 +365,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf ```php @@ -217,7 +396,7 @@ public function getDefaultValue(): string|array|int|bool|null|float; ```php @@ -234,10 +413,10 @@ public function getDescription(): string; Throws: +
    +
    +
    + + + +```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 + +
    @@ -359,7 +650,7 @@ public function getEndLine(): int; ```php @@ -383,6 +674,76 @@ public function getFileName(): string|null; +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getFileSourceLink(bool $withLine = true): string|null; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $withLinebool-
    + +Return value: string | null + + +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 + +
    @@ -390,7 +751,7 @@ public function getFileName(): string|null; ```php @@ -401,7 +762,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity
    @@ -411,7 +772,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser ```php @@ -432,7 +793,7 @@ public function getImplementingClassName(): string; ```php @@ -463,7 +824,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec ```php @@ -483,10 +844,10 @@ public function getModifiersString(): string; \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
  • - \DI\DependencyException
    • + \DI\DependencyException
  • - \DI\NotFoundException
    • + \DI\NotFoundException
  • \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
    • @@ -500,7 +861,7 @@ public function getModifiersString(): string; ```php @@ -521,7 +882,7 @@ public function getName(): string; ```php @@ -545,6 +906,29 @@ public function getNamespaceName(): string; + +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getObjectId(): string; +``` + +
    Get entity unique ID
    + +Parameters: not specified + +Return value: string + +
    @@ -552,7 +936,7 @@ public function getNamespaceName(): string; ```php @@ -563,7 +947,7 @@ public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHa Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings +Return value: \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings
    @@ -573,7 +957,7 @@ public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHa ```php @@ -584,7 +968,7 @@ public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity @@ -594,7 +978,7 @@ public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity ```php @@ -605,7 +989,7 @@ public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Par Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection @@ -615,7 +999,7 @@ public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Par ```php @@ -636,7 +1020,7 @@ public function getShortName(): string; ```php @@ -650,6 +1034,39 @@ public function getStartLine(): int; Return value: int +Throws: + + + +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function getThrows(): array; +``` + +
    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 hasDescriptionLinks(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function hasExamples(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function hasThrows(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isDeprecated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait + +public function isEntityDataCacheOutdated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isEntityFileCanBeLoad(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +Throws: +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function isInternal(): bool; +``` + + + Parameters: not specified Return value: bool @@ -725,7 +1327,7 @@ public function isImplementedInParentClass(): bool; ```php @@ -756,7 +1358,7 @@ public function isPrivate(): bool; ```php @@ -787,7 +1389,7 @@ public function isProtected(): bool; ```php @@ -811,6 +1413,66 @@ public function isPublic(): bool; +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity + +public function reloadEntityDependenciesCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait + +public function removeNotUsedEntityDataCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + +
    diff --git a/docs/tech/2.parser/classes/PropertyEntityCollection.md b/docs/tech/2.parser/classes/PropertyEntityCollection.md index 6b9ed926..2661149c 100644 --- a/docs/tech/2.parser/classes/PropertyEntityCollection.md +++ b/docs/tech/2.parser/classes/PropertyEntityCollection.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / PropertyEntityCollection
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / PropertyEntityCollection

    - PropertyEntityCollection class: + PropertyEntityCollection class:

    @@ -39,9 +39,21 @@ final class PropertyEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Ba
  • get
    • +
  • + getIterator + - Retrieve an external iterator
    • +
  • + has +
    • +
  • + isEmpty +
  • loadPropertyEntities
    • +
  • + remove +
  • unsafeGet
    • @@ -60,7 +72,7 @@ final class PropertyEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Ba ```php @@ -82,17 +94,17 @@ public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Clas $classEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity - $phpHandlerSettings - \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings + \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings - $cacheablePhpEntityFactory - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory - @@ -107,7 +119,7 @@ public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Clas ```php @@ -129,7 +141,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEnti $propertyEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity - @@ -140,7 +152,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEnti -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntityCollection @@ -150,7 +162,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEnti ```php @@ -178,7 +190,106 @@ public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parse -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | null + + + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function getIterator(): \Generator; +``` + +
    Retrieve an external iterator
    + +Parameters: not specified + +Return value: \Generator + + +Throws: + + + +See: + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function has(string $objectName): bool; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function isEmpty(): bool; +``` + + + +Parameters: not specified + +Return value: bool
    @@ -188,7 +299,7 @@ public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parse ```php @@ -205,19 +316,59 @@ public function loadPropertyEntities(): void; Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function remove(string $objectName): void; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: void + +
    @@ -225,7 +376,7 @@ public function loadPropertyEntities(): void; ```php @@ -253,16 +404,16 @@ public function unsafeGet(string $objectName): \BumbleDocGen\LanguageHandler\Php -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | null Throws:
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator + +public function getFinder(): \Symfony\Component\Finder\Finder; +``` + + + +Parameters: not specified + +Return value: \Symfony\Component\Finder\Finder + +
    diff --git a/docs/tech/2.parser/classes/ReflectionException.md b/docs/tech/2.parser/classes/ReflectionException.md index 71f1791c..ee763a4c 100644 --- a/docs/tech/2.parser/classes/ReflectionException.md +++ b/docs/tech/2.parser/classes/ReflectionException.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / ReflectionException
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / ReflectionException

    - ReflectionException class: + ReflectionException class:

    @@ -29,13 +29,363 @@ See: +

    Initialization methods:

    +
      +
    1. + __construct + - Construct the exception. Note: The message is NOT binary safe.
      2. +
    +

    Methods:

    +
      +
    1. + __toString + - String representation of the exception
      2. +
    2. + __wakeup +
      3. +
    3. + getCode + - Gets the Exception code
      4. +
    4. + getFile + - Gets the file in which the exception occurred
      5. +
    5. + getLine + - Gets the line in which the exception occurred
      6. +
    6. + getMessage + - Gets the Exception message
      7. +
    7. + getPrevious + - Returns previous Exception
      8. +
    8. + getTrace + - Gets the stack trace
      9. +
    9. + getTraceAsString + - Gets the stack trace as a string
      10. +
    + +

    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: + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $messagestring[optional] The Exception message to throw.
    $codeint[optional] The Exception code.
    $previousThrowable | 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: + +
    +
    +
    + + + +```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/RootEntityCollection.md b/docs/tech/2.parser/classes/RootEntityCollection.md index c14807fa..6d3a402b 100644 --- a/docs/tech/2.parser/classes/RootEntityCollection.md +++ b/docs/tech/2.parser/classes/RootEntityCollection.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / RootEntityCollection
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / RootEntityCollection

    - RootEntityCollection class: + RootEntityCollection class:

    @@ -38,9 +38,21 @@ abstract class RootEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Bas
  • getEntityLinkData
    • +
  • + getIterator + - Retrieve an external iterator
  • getLoadedOrCreateNew
    • +
  • + has +
    • +
  • + isEmpty +
    • +
  • + remove +
  • updateEntitiesCache
    • @@ -59,7 +71,7 @@ abstract class RootEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Bas ```php @@ -92,7 +104,7 @@ public function findEntity(string $search, bool $useUnsafeKeys = true): \BumbleD -Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null @@ -102,7 +114,7 @@ public function findEntity(string $search, bool $useUnsafeKeys = true): \BumbleD ```php @@ -130,7 +142,7 @@ public function get(string $objectName): \BumbleDocGen\Core\Parser\Entity\RootEn -Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null @@ -140,7 +152,7 @@ public function get(string $objectName): \BumbleDocGen\Core\Parser\Entity\RootEn ```php @@ -161,7 +173,7 @@ public function getEntityCollectionName(): string; ```php @@ -207,10 +219,46 @@ public function getEntityLinkData(string $rawLink, string|null $defaultEntityNam
    + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function getIterator(): \Generator; +``` + +
    Retrieve an external iterator
    + +Parameters: not specified + +Return value: \Generator + + +Throws: + + + +See: + +
    +
    +
    + ```php @@ -243,7 +291,7 @@ public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntit -Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface @@ -256,10 +304,113 @@ public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntit
    + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function has(string $objectName): bool; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function isEmpty(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function remove(string $objectName): void; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: void + + +
    +
    +
    + ```php diff --git a/docs/tech/2.parser/classes/RootEntityInterface.md b/docs/tech/2.parser/classes/RootEntityInterface.md index 8273dea6..66a1490f 100644 --- a/docs/tech/2.parser/classes/RootEntityInterface.md +++ b/docs/tech/2.parser/classes/RootEntityInterface.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / RootEntityInterface
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / RootEntityInterface

    - RootEntityInterface class: + RootEntityInterface class:

    @@ -27,18 +27,39 @@ their entities need to correspond to the same interfaces

    Methods:

      +
    1. + entityCacheIsOutdated +
    2. entityDataCanBeLoaded - Checking if it is possible to get the entity data
      3. +
    3. + getAbsoluteFileName + - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
    4. getEntityDependencies
    5. getFileContent
      6. +
    6. + getFileName + - Returns the relative path to a file if it can be retrieved and if the file is in the project directory
    7. getFileSourceLink
      8. +
    8. + getName +
      9. +
    9. + getObjectId +
      10. +
    10. + getRootEntityCollection + - Get parent collection of entities
      11. +
    11. + getShortName +
    12. isEntityNameValid - Check if entity name is valid
      13. @@ -57,10 +78,33 @@ their entities need to correspond to the same interfaces
      + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function entityCacheIsOutdated(): bool; +``` + + + +Parameters: not specified + +Return value: bool + + +
      +
      +
      + ```php @@ -74,6 +118,29 @@ public function entityDataCanBeLoaded(): bool; Return value: bool +
      +
      +
      + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function getAbsoluteFileName(): string|null; +``` + +
      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: string | null + +
      @@ -81,7 +148,7 @@ public function entityDataCanBeLoaded(): bool; ```php @@ -102,7 +169,7 @@ public function getEntityDependencies(): array; ```php @@ -116,6 +183,29 @@ public function getFileContent(): string; Return value: string +
      +
      +
      + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function getFileName(): string|null; +``` + +
      Returns the relative path to a file if it can be retrieved and if the file is in the project directory
      + +Parameters: not specified + +Return value: string | null + +
      @@ -123,7 +213,7 @@ public function getFileContent(): string; ```php @@ -154,6 +244,98 @@ public function getFileSourceLink(bool $withLine = true): string|null; Return value: string | null +
      +
      +
      + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function getName(): string; +``` + + + +Parameters: not specified + +Return value: string + + +
      +
      +
      + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function getObjectId(): string; +``` + + + +Parameters: not specified + +Return value: string + + +
      +
      +
      + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection; +``` + +
      Get parent collection of entities
      + +Parameters: not specified + +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection + + +
      +
      +
      + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface + +public function getShortName(): string; +``` + + + +Parameters: not specified + +Return value: string + +
      @@ -161,7 +343,7 @@ public function getFileSourceLink(bool $withLine = true): string|null; ```php @@ -199,7 +381,7 @@ public static function isEntityNameValid(string $entityName): bool; ```php diff --git a/docs/tech/2.parser/classes/SingleFileSourceLocator.md b/docs/tech/2.parser/classes/SingleFileSourceLocator.md index 453f73e6..de423c67 100644 --- a/docs/tech/2.parser/classes/SingleFileSourceLocator.md +++ b/docs/tech/2.parser/classes/SingleFileSourceLocator.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Source locators / SingleFileSourceLocator
      + BumbleDocGen / Technical description of the project / Parser / Source locators / SingleFileSourceLocator

      - SingleFileSourceLocator class: + SingleFileSourceLocator class:

      @@ -30,6 +30,13 @@ final class SingleFileSourceLocator extends \BumbleDocGen\Core\Parser\SourceLoca
    +

    Methods:

    + +
      +
    1. + getFinder +
      2. +
    @@ -44,7 +51,7 @@ final class SingleFileSourceLocator extends \BumbleDocGen\Core\Parser\SourceLoca ```php @@ -74,6 +81,29 @@ public function __construct(string $filename); +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\SourceLocator\BaseSourceLocator + +public function getFinder(): \Symfony\Component\Finder\Finder; +``` + + + +Parameters: not specified + +Return value: \Symfony\Component\Finder\Finder + +
    diff --git a/docs/tech/2.parser/classes/SourceLocatorInterface.md b/docs/tech/2.parser/classes/SourceLocatorInterface.md index cffc9c14..ffd429ac 100644 --- a/docs/tech/2.parser/classes/SourceLocatorInterface.md +++ b/docs/tech/2.parser/classes/SourceLocatorInterface.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Source locators / SourceLocatorInterface
    + BumbleDocGen / Technical description of the project / Parser / Source locators / SourceLocatorInterface

    - SourceLocatorInterface class: + SourceLocatorInterface class:

    @@ -44,7 +44,7 @@ interface SourceLocatorInterface ```php diff --git a/docs/tech/2.parser/classes/TrueCondition.md b/docs/tech/2.parser/classes/TrueCondition.md index 43891f78..9151afff 100644 --- a/docs/tech/2.parser/classes/TrueCondition.md +++ b/docs/tech/2.parser/classes/TrueCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / TrueCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / TrueCondition

    - TrueCondition class: + TrueCondition class:

    @@ -44,7 +44,7 @@ final class TrueCondition implements \BumbleDocGen\Core\Parser\FilterCondition\C ```php @@ -66,7 +66,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/VisibilityCondition.md b/docs/tech/2.parser/classes/VisibilityCondition.md index 40d58ce7..2d3b88e5 100644 --- a/docs/tech/2.parser/classes/VisibilityCondition.md +++ b/docs/tech/2.parser/classes/VisibilityCondition.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / VisibilityCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / VisibilityCondition

    - VisibilityCondition class: + VisibilityCondition class:

    @@ -51,11 +51,11 @@ final class VisibilityCondition implements \BumbleDocGen\Core\Parser\FilterCondi ```php -public function __construct(string $visibilityModifiers); +public function __construct(string ...$visibilityModifiers); ``` @@ -72,7 +72,7 @@ public function __construct(string $visibilityModifiers); - $visibilityModifiers + $visibilityModifiers (variadic) string - @@ -88,7 +88,7 @@ public function __construct(string $visibilityModifiers); ```php @@ -110,7 +110,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/VisibilityCondition_2.md b/docs/tech/2.parser/classes/VisibilityCondition_2.md index 34276cd2..36c9d792 100644 --- a/docs/tech/2.parser/classes/VisibilityCondition_2.md +++ b/docs/tech/2.parser/classes/VisibilityCondition_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / VisibilityCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / VisibilityCondition

    - VisibilityCondition class: + VisibilityCondition class:

    @@ -51,11 +51,11 @@ final class VisibilityCondition implements \BumbleDocGen\Core\Parser\FilterCondi ```php -public function __construct(string $visibilityModifiers); +public function __construct(string ...$visibilityModifiers); ``` @@ -72,7 +72,7 @@ public function __construct(string $visibilityModifiers); - $visibilityModifiers + $visibilityModifiers (variadic) string - @@ -88,7 +88,7 @@ public function __construct(string $visibilityModifiers); ```php @@ -110,7 +110,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/classes/VisibilityCondition_3.md b/docs/tech/2.parser/classes/VisibilityCondition_3.md index 28f71f82..6cea98a3 100644 --- a/docs/tech/2.parser/classes/VisibilityCondition_3.md +++ b/docs/tech/2.parser/classes/VisibilityCondition_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / VisibilityCondition
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions / VisibilityCondition

    - VisibilityCondition class: + VisibilityCondition class:

    @@ -51,11 +51,11 @@ final class VisibilityCondition implements \BumbleDocGen\Core\Parser\FilterCondi ```php -public function __construct(string $visibilityModifiers); +public function __construct(string ...$visibilityModifiers); ``` @@ -72,7 +72,7 @@ public function __construct(string $visibilityModifiers); - $visibilityModifiers + $visibilityModifiers (variadic) string - @@ -88,7 +88,7 @@ public function __construct(string $visibilityModifiers); ```php @@ -110,7 +110,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf $entity - \BumbleDocGen\Core\Parser\Entity\EntityInterface + \BumbleDocGen\Core\Parser\Entity\EntityInterface - diff --git a/docs/tech/2.parser/entity.md b/docs/tech/2.parser/entity.md index 17fed7b7..5ec408c7 100644 --- a/docs/tech/2.parser/entity.md +++ b/docs/tech/2.parser/entity.md @@ -1,4 +1,4 @@ - BumbleDocGen / Technical description of the project / Parser / Entities and entities collections
    + BumbleDocGen / Technical description of the project / Parser / Entities and entities collections

    Entities and entities collections

    @@ -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 Jul 29 13:26:44 2023 +0300
    Page content update date: Thu Aug 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: Sun Sep 10 2023
    Made with     Bumble Documentation Generator
    \ No newline at end of file diff --git a/docs/tech/2.parser/entityFilterCondition.md b/docs/tech/2.parser/entityFilterCondition.md index 284462a7..93ada404 100644 --- a/docs/tech/2.parser/entityFilterCondition.md +++ b/docs/tech/2.parser/entityFilterCondition.md @@ -1,4 +1,4 @@ - BumbleDocGen / Technical description of the project / Parser / Entity filter conditions
    + BumbleDocGen / Technical description of the project / Parser / Entity filter conditions

    Entity filter conditions

    @@ -78,4 +78,4 @@ Filter condition for working with entities PHP language handler:
    -Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
    Last modified date: Sat Jul 29 13:26:44 2023 +0300
    Page content update date: Thu Aug 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: Sun Sep 10 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 6709985a..3a560725 100644 --- a/docs/tech/2.parser/readme.md +++ b/docs/tech/2.parser/readme.md @@ -1,4 +1,4 @@ - BumbleDocGen / Technical description of the project / Parser
    + BumbleDocGen / Technical description of the project / Parser

    Documentation parser

    @@ -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: Sun Jul 30 16:27:42 2023 +0300
    Page content update date: Thu Aug 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: Sun Sep 10 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 e396ceb1..93f464e9 100644 --- a/docs/tech/2.parser/sourceLocator.md +++ b/docs/tech/2.parser/sourceLocator.md @@ -1,4 +1,4 @@ - BumbleDocGen / Technical description of the project / Parser / Source locators
    + BumbleDocGen / Technical description of the project / Parser / Source locators

    Source locators

    @@ -11,8 +11,8 @@ Source locators are set in the configuration: - class: \BumbleDocGen\Core\Parser\SourceLocator\RecursiveDirectoriesSourceLocator arguments: directories: - - "%project_root%/BumbleDocGen" - - "%project_root%/SelfDoc" + - "%project_root%/src" + - "%project_root%/selfdoc" ``` @@ -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 Jul 29 13:26:44 2023 +0300
    Page content update date: Thu Aug 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:09:56 2023 +0300
    Page content update date: Sun Sep 10 2023
    Made with     Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/breadcrumbs.md b/docs/tech/3.renderer/breadcrumbs.md index aea3f1c2..2ee81fef 100644 --- a/docs/tech/3.renderer/breadcrumbs.md +++ b/docs/tech/3.renderer/breadcrumbs.md @@ -1,4 +1,4 @@ - BumbleDocGen / Technical description of the project / Renderer / Documentation structure and breadcrumbs
    + BumbleDocGen / Technical description of the project / Renderer / Documentation structure and breadcrumbs

    Documentation structure and breadcrumbs

    @@ -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: Sun Jul 30 10:46:41 2023 +0300
    Page content update date: Thu Aug 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: Sun Sep 10 2023
    Made with     Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/classes/AddIndentFromLeft.md b/docs/tech/3.renderer/classes/AddIndentFromLeft.md index db10ad55..3779d94b 100644 --- a/docs/tech/3.renderer/classes/AddIndentFromLeft.md +++ b/docs/tech/3.renderer/classes/AddIndentFromLeft.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template filters / AddIndentFromLeft
    + BumbleDocGen / Technical description of the project / Renderer / Template filters / AddIndentFromLeft

    - AddIndentFromLeft class: + AddIndentFromLeft class:

    @@ -64,7 +64,7 @@ final class AddIndentFromLeft implements \BumbleDocGen\Core\Renderer\Twig\Filter ```php @@ -112,7 +112,7 @@ public function __invoke(string $text, int $identLength = 4, bool $skipFirstIden ```php @@ -133,7 +133,7 @@ public static function getName(): string; ```php diff --git a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md b/docs/tech/3.renderer/classes/BreadcrumbsHelper.md index 2d8e68e9..ee9de81d 100644 --- a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md +++ b/docs/tech/3.renderer/classes/BreadcrumbsHelper.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Documentation structure and breadcrumbs / BreadcrumbsHelper
    + BumbleDocGen / Technical description of the project / Renderer / Documentation structure and breadcrumbs / BreadcrumbsHelper

    - BreadcrumbsHelper class: + BreadcrumbsHelper class:

    @@ -67,7 +67,7 @@ final class BreadcrumbsHelper @@ -82,7 +82,7 @@ final class BreadcrumbsHelper ```php @@ -104,17 +104,17 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf $configuration - \BumbleDocGen\Core\Configuration\Configuration + \BumbleDocGen\Core\Configuration\Configuration - $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - $breadcrumbsTwig - \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment + \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsTwigEnvironment - @@ -134,7 +134,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf ```php @@ -151,10 +151,10 @@ public function getAllPageLinks(): array; Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function getOperationsLogCollection(): \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection; +``` + + + +Parameters: not specified + +Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection + +
    @@ -599,7 +847,7 @@ public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\En ```php @@ -610,7 +858,47 @@ public function getPluginEventDispatcher(): \BumbleDocGen\Core\Plugin\PluginEven Parameters: not specified -Return value: \BumbleDocGen\Core\Plugin\PluginEventDispatcher +Return value: \BumbleDocGen\Core\Plugin\PluginEventDispatcher + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function has(string $objectName): bool; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: bool
    @@ -620,7 +908,7 @@ public function getPluginEventDispatcher(): \BumbleDocGen\Core\Plugin\PluginEven ```php @@ -655,7 +943,7 @@ public function internalFindEntity(string $search, bool $useUnsafeKeys = true): -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | null @@ -664,13 +952,13 @@ public function internalFindEntity(string $search, bool $useUnsafeKeys = true): ```php $classEntityCollection->findEntity('App'); // class name -$classEntityCollection->findEntity('SelfDoc\Console\App'); // class with namespace -$classEntityCollection->findEntity('\SelfDoc\Console\App'); // class with namespace -$classEntityCollection->findEntity('\SelfDoc\Console\App::test()'); // class with namespace and optional part +$classEntityCollection->findEntity('BumbleDocGen\Console\App'); // class with namespace +$classEntityCollection->findEntity('\BumbleDocGen\Console\App'); // class with namespace +$classEntityCollection->findEntity('\BumbleDocGen\Console\App::test()'); // class with namespace and optional part $classEntityCollection->findEntity('App.php'); // filename -$classEntityCollection->findEntity('/SelfDoc/Console/App.php'); // relative path -$classEntityCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen/SelfDoc/Console/App.php'); // absolute path -$classEntityCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/SelfDoc/Console/App.php'); // source link +$classEntityCollection->findEntity('/BumbleDocGen/Console/App.php'); // relative path +$classEntityCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen/BumbleDocGen/Console/App.php'); // absolute path +$classEntityCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/BumbleDocGen/Console/App.php'); // source link ``` @@ -680,7 +968,7 @@ $classEntityCollection->findEntity('https://github.com/bumble-tech/bumble-doc-ge ```php @@ -713,19 +1001,42 @@ public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddCl -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function isEmpty(): bool; +``` + + + +Parameters: not specified + +Return value: bool + +
    @@ -733,7 +1044,7 @@ public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddCl ```php @@ -750,10 +1061,10 @@ public function loadClassEntities(): void; Throws: +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function remove(string $objectName): void; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: void + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection + +public function updateEntitiesCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + +
    diff --git a/docs/tech/3.renderer/classes/ClassEntityCollection_2.md b/docs/tech/3.renderer/classes/ClassEntityCollection_2.md index 28388405..2e51a579 100644 --- a/docs/tech/3.renderer/classes/ClassEntityCollection_2.md +++ b/docs/tech/3.renderer/classes/ClassEntityCollection_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / How to create documentation templates? / Templates variables / ClassEntityCollection
    + BumbleDocGen / Technical description of the project / Renderer / How to create documentation templates? / Templates variables / ClassEntityCollection

    - ClassEntityCollection class: + ClassEntityCollection class:

    @@ -36,6 +36,9 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga
  • add
    • +
  • + clearOperationsLogCollection +
  • filterByInterfaces
    • @@ -48,6 +51,12 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga
  • filterByPaths
    • +
  • + findEntity +
    • +
  • + get +
  • getEntityByClassName
    • @@ -57,24 +66,45 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga
  • getEntityLinkData
    • +
  • + getIterator + - Retrieve an external iterator
    • +
  • + getLoadedOrCreateNew +
  • getOnlyInstantiable
  • getOnlyInterfaces
    • +
  • + getOperationsLogCollection +
  • getPluginEventDispatcher
    • +
  • + has +
  • internalFindEntity
  • internalGetLoadedOrCreateNew
    • +
  • + isEmpty +
  • loadClassEntities
    • +
  • + remove +
    • +
  • + updateEntitiesCache +
    • @@ -82,7 +112,7 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga @@ -97,7 +127,7 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga ```php @@ -119,42 +149,42 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf $configuration - \BumbleDocGen\Core\Configuration\Configuration + \BumbleDocGen\Core\Configuration\Configuration - $phpHandlerSettings - \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings + \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings - $parserHelper - \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper + \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper - $pluginEventDispatcher - \BumbleDocGen\Core\Plugin\PluginEventDispatcher + \BumbleDocGen\Core\Plugin\PluginEventDispatcher - $cacheablePhpEntityFactory - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory - $docRendererHelper - \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper + \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper - $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - $progressBarFactory - \BumbleDocGen\Core\Console\ProgressBarFactory + \BumbleDocGen\Core\Console\ProgressBarFactory - @@ -179,7 +209,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf ```php @@ -201,7 +231,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity - @@ -212,7 +242,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -225,6 +255,29 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function clearOperationsLogCollection(): void; +``` + + + +Parameters: not specified + +Return value: void + +
    @@ -232,7 +285,7 @@ public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity ```php @@ -260,7 +313,7 @@ public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHan -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -280,7 +333,7 @@ public function filterByInterfaces(array $interfaces): \BumbleDocGen\LanguageHan ```php @@ -308,7 +361,7 @@ public function filterByNameRegularExpression(string $regexPattern): \BumbleDocG -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -328,7 +381,7 @@ public function filterByNameRegularExpression(string $regexPattern): \BumbleDocG ```php @@ -356,7 +409,7 @@ public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -376,7 +429,7 @@ public function filterByParentClassNames(array $parentClassNames): \BumbleDocGen ```php @@ -404,7 +457,7 @@ public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\P -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -417,6 +470,91 @@ public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\P +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function findEntity(string $search, bool $useUnsafeKeys = true): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface|null; +``` + + + +Parameters: + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $searchstring-
    $useUnsafeKeysbool-
    + +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function get(string $objectName): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface|null; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface | null + +
    @@ -424,7 +562,7 @@ public function filterByPaths(array $paths): \BumbleDocGen\LanguageHandler\Php\P ```php @@ -457,7 +595,7 @@ public function getEntityByClassName(string $className, bool $createIfNotExists -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | null
    @@ -467,7 +605,7 @@ public function getEntityByClassName(string $className, bool $createIfNotExists ```php @@ -488,7 +626,7 @@ public function getEntityCollectionName(): string; ```php @@ -534,10 +672,97 @@ public function getEntityLinkData(string $rawLink, string|null $defaultEntityNam
    + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function getIterator(): \Generator; +``` + +
    Retrieve an external iterator
    + +Parameters: not specified + +Return value: \Generator + + +Throws: + + + +See: + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function getLoadedOrCreateNew(string $objectName, bool $withAddClassEntityToCollectionEvent = false): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface; +``` + + + +Parameters: + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    $withAddClassEntityToCollectionEventbool-
    + +Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface + + + +See: + +
    +
    +
    + ```php @@ -548,7 +773,7 @@ public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\ Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -568,7 +793,7 @@ public function getOnlyInstantiable(): \BumbleDocGen\LanguageHandler\Php\Parser\ ```php @@ -579,7 +804,7 @@ public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\En Parameters: not specified -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection Throws: @@ -592,6 +817,29 @@ public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\En +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\LoggableRootEntityCollection + +public function getOperationsLogCollection(): \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection; +``` + + + +Parameters: not specified + +Return value: \BumbleDocGen\Core\Parser\Entity\CollectionLogOperation\OperationsCollection + +
    @@ -599,7 +847,7 @@ public function getOnlyInterfaces(): \BumbleDocGen\LanguageHandler\Php\Parser\En ```php @@ -610,7 +858,47 @@ public function getPluginEventDispatcher(): \BumbleDocGen\Core\Plugin\PluginEven Parameters: not specified -Return value: \BumbleDocGen\Core\Plugin\PluginEventDispatcher +Return value: \BumbleDocGen\Core\Plugin\PluginEventDispatcher + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function has(string $objectName): bool; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: bool
    @@ -620,7 +908,7 @@ public function getPluginEventDispatcher(): \BumbleDocGen\Core\Plugin\PluginEven ```php @@ -655,7 +943,7 @@ public function internalFindEntity(string $search, bool $useUnsafeKeys = true): -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | null +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | null @@ -664,13 +952,13 @@ public function internalFindEntity(string $search, bool $useUnsafeKeys = true): ```php $classEntityCollection->findEntity('App'); // class name -$classEntityCollection->findEntity('SelfDoc\Console\App'); // class with namespace -$classEntityCollection->findEntity('\SelfDoc\Console\App'); // class with namespace -$classEntityCollection->findEntity('\SelfDoc\Console\App::test()'); // class with namespace and optional part +$classEntityCollection->findEntity('BumbleDocGen\Console\App'); // class with namespace +$classEntityCollection->findEntity('\BumbleDocGen\Console\App'); // class with namespace +$classEntityCollection->findEntity('\BumbleDocGen\Console\App::test()'); // class with namespace and optional part $classEntityCollection->findEntity('App.php'); // filename -$classEntityCollection->findEntity('/SelfDoc/Console/App.php'); // relative path -$classEntityCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen/SelfDoc/Console/App.php'); // absolute path -$classEntityCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/SelfDoc/Console/App.php'); // source link +$classEntityCollection->findEntity('/BumbleDocGen/Console/App.php'); // relative path +$classEntityCollection->findEntity('/Users/someuser/Desktop/projects/bumble-doc-gen/BumbleDocGen/Console/App.php'); // absolute path +$classEntityCollection->findEntity('https://github.com/bumble-tech/bumble-doc-gen/blob/master/BumbleDocGen/Console/App.php'); // source link ``` @@ -680,7 +968,7 @@ $classEntityCollection->findEntity('https://github.com/bumble-tech/bumble-doc-ge ```php @@ -713,19 +1001,42 @@ public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddCl -Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity +Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity Throws: + +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function isEmpty(): bool; +``` + + + +Parameters: not specified + +Return value: bool + +
    @@ -733,7 +1044,7 @@ public function internalGetLoadedOrCreateNew(string $objectName, bool $withAddCl ```php @@ -750,10 +1061,10 @@ public function loadClassEntities(): void; Throws: +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection + +public function remove(string $objectName): void; +``` + + + +Parameters: + + + + + + + + + + + + + + + + +
    NameTypeDescription
    $objectNamestring-
    + +Return value: void + + +
    +
    +
    + + + +```php +// Implemented in BumbleDocGen\Core\Parser\Entity\RootEntityCollection + +public function updateEntitiesCache(): void; +``` + + + +Parameters: not specified + +Return value: void + + +Throws: + +
    diff --git a/docs/tech/3.renderer/classes/CustomFunctionInterface.md b/docs/tech/3.renderer/classes/CustomFunctionInterface.md index d885846d..6d49d821 100644 --- a/docs/tech/3.renderer/classes/CustomFunctionInterface.md +++ b/docs/tech/3.renderer/classes/CustomFunctionInterface.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template functions / CustomFunctionInterface
    + BumbleDocGen / Technical description of the project / Renderer / Template functions / CustomFunctionInterface

    - CustomFunctionInterface class: + CustomFunctionInterface class:

    @@ -47,7 +47,7 @@ interface CustomFunctionInterface ```php @@ -68,7 +68,7 @@ public static function getName(): string; ```php diff --git a/docs/tech/3.renderer/classes/DocumentedEntityWrapper.md b/docs/tech/3.renderer/classes/DocumentedEntityWrapper.md index 5a12d467..a3e2f5e3 100644 --- a/docs/tech/3.renderer/classes/DocumentedEntityWrapper.md +++ b/docs/tech/3.renderer/classes/DocumentedEntityWrapper.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template functions / DocumentedEntityWrapper
    + BumbleDocGen / Technical description of the project / Renderer / Template functions / DocumentedEntityWrapper

    - DocumentedEntityWrapper class: + DocumentedEntityWrapper class:

    @@ -69,7 +69,7 @@ final class DocumentedEntityWrapper ```php @@ -91,12 +91,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor $documentTransformableEntity - \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface + \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface An entity that is allowed to be documented $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -116,7 +116,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor ```php @@ -127,7 +127,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En Parameters: not specified -Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface +Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface @@ -137,7 +137,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En ```php @@ -158,7 +158,7 @@ public function getDocUrl(): string; ```php @@ -169,7 +169,7 @@ public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Co Parameters: not specified -Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface +Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface @@ -179,7 +179,7 @@ public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Co ```php @@ -200,7 +200,7 @@ public function getEntityName(): string; ```php @@ -221,7 +221,7 @@ public function getFileName(): string; ```php @@ -242,7 +242,7 @@ public function getInitiatorFilePath(): string; ```php diff --git a/docs/tech/3.renderer/classes/DocumentedEntityWrapper_2.md b/docs/tech/3.renderer/classes/DocumentedEntityWrapper_2.md index 51e31bf4..7c9c1fcb 100644 --- a/docs/tech/3.renderer/classes/DocumentedEntityWrapper_2.md +++ b/docs/tech/3.renderer/classes/DocumentedEntityWrapper_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / How to create documentation templates? / Linking templates / DocumentedEntityWrapper
    + BumbleDocGen / Technical description of the project / Renderer / How to create documentation templates? / Linking templates / DocumentedEntityWrapper

    - DocumentedEntityWrapper class: + DocumentedEntityWrapper class:

    @@ -69,7 +69,7 @@ final class DocumentedEntityWrapper ```php @@ -91,12 +91,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor $documentTransformableEntity - \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface + \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface An entity that is allowed to be documented $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -116,7 +116,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor ```php @@ -127,7 +127,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En Parameters: not specified -Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface +Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface @@ -137,7 +137,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En ```php @@ -158,7 +158,7 @@ public function getDocUrl(): string; ```php @@ -169,7 +169,7 @@ public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Co Parameters: not specified -Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface +Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface @@ -179,7 +179,7 @@ public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Co ```php @@ -200,7 +200,7 @@ public function getEntityName(): string; ```php @@ -221,7 +221,7 @@ public function getFileName(): string; ```php @@ -242,7 +242,7 @@ public function getInitiatorFilePath(): string; ```php diff --git a/docs/tech/3.renderer/classes/DocumentedEntityWrapper_3.md b/docs/tech/3.renderer/classes/DocumentedEntityWrapper_3.md index 304f11cd..2ecafd8c 100644 --- a/docs/tech/3.renderer/classes/DocumentedEntityWrapper_3.md +++ b/docs/tech/3.renderer/classes/DocumentedEntityWrapper_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template filters / DocumentedEntityWrapper
    + BumbleDocGen / Technical description of the project / Renderer / Template filters / DocumentedEntityWrapper

    - DocumentedEntityWrapper class: + DocumentedEntityWrapper class:

    @@ -69,7 +69,7 @@ final class DocumentedEntityWrapper ```php @@ -91,12 +91,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor $documentTransformableEntity - \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface + \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface An entity that is allowed to be documented $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -116,7 +116,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransfor ```php @@ -127,7 +127,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En Parameters: not specified -Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface +Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface @@ -137,7 +137,7 @@ public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\En ```php @@ -158,7 +158,7 @@ public function getDocUrl(): string; ```php @@ -169,7 +169,7 @@ public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Co Parameters: not specified -Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface +Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface @@ -179,7 +179,7 @@ public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Co ```php @@ -200,7 +200,7 @@ public function getEntityName(): string; ```php @@ -221,7 +221,7 @@ public function getFileName(): string; ```php @@ -242,7 +242,7 @@ public function getInitiatorFilePath(): string; ```php diff --git a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection.md b/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection.md index 644e1d76..591ffc8a 100644 --- a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection.md +++ b/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template functions / DocumentedEntityWrappersCollection
    + BumbleDocGen / Technical description of the project / Renderer / Template functions / DocumentedEntityWrappersCollection

    - DocumentedEntityWrappersCollection class: + DocumentedEntityWrappersCollection class:

    @@ -60,7 +60,7 @@ final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \T ```php @@ -82,12 +82,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext - \BumbleDocGen\Core\Renderer\Context\RendererContext + \BumbleDocGen\Core\Renderer\Context\RendererContext - $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -102,7 +102,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext ```php @@ -129,7 +129,7 @@ public function count(): int; ```php @@ -151,13 +151,13 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En $rootEntity - \BumbleDocGen\Core\Parser\Entity\RootEntityInterface + \BumbleDocGen\Core\Parser\Entity\RootEntityInterface - -Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper +Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper @@ -167,7 +167,7 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En ```php @@ -188,7 +188,7 @@ public function getDocumentedEntitiesRelations(): array; ```php diff --git a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_2.md b/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_2.md index bf0ad7c7..e872394e 100644 --- a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_2.md +++ b/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_2.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / How to create documentation templates? / Linking templates / DocumentedEntityWrappersCollection
    + BumbleDocGen / Technical description of the project / Renderer / How to create documentation templates? / Linking templates / DocumentedEntityWrappersCollection

    - DocumentedEntityWrappersCollection class: + DocumentedEntityWrappersCollection class:

    @@ -60,7 +60,7 @@ final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \T ```php @@ -82,12 +82,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext - \BumbleDocGen\Core\Renderer\Context\RendererContext + \BumbleDocGen\Core\Renderer\Context\RendererContext - $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -102,7 +102,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext ```php @@ -129,7 +129,7 @@ public function count(): int; ```php @@ -151,13 +151,13 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En $rootEntity - \BumbleDocGen\Core\Parser\Entity\RootEntityInterface + \BumbleDocGen\Core\Parser\Entity\RootEntityInterface - -Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper +Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper @@ -167,7 +167,7 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En ```php @@ -188,7 +188,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 index e389bb21..75560dd1 100644 --- a/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_3.md +++ b/docs/tech/3.renderer/classes/DocumentedEntityWrappersCollection_3.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template filters / DocumentedEntityWrappersCollection
    + BumbleDocGen / Technical description of the project / Renderer / Template filters / DocumentedEntityWrappersCollection

    - DocumentedEntityWrappersCollection class: + DocumentedEntityWrappersCollection class:

    @@ -60,7 +60,7 @@ final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \T ```php @@ -82,12 +82,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext - \BumbleDocGen\Core\Renderer\Context\RendererContext + \BumbleDocGen\Core\Renderer\Context\RendererContext - $localObjectCache - \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache + \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache - @@ -102,7 +102,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext ```php @@ -129,7 +129,7 @@ public function count(): int; ```php @@ -151,13 +151,13 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En $rootEntity - \BumbleDocGen\Core\Parser\Entity\RootEntityInterface + \BumbleDocGen\Core\Parser\Entity\RootEntityInterface - -Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper +Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper @@ -167,7 +167,7 @@ public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\En ```php @@ -188,7 +188,7 @@ public function getDocumentedEntitiesRelations(): array; ```php diff --git a/docs/tech/3.renderer/classes/DrawClassMap.md b/docs/tech/3.renderer/classes/DrawClassMap.md index dc552a16..c99a59b7 100644 --- a/docs/tech/3.renderer/classes/DrawClassMap.md +++ b/docs/tech/3.renderer/classes/DrawClassMap.md @@ -1,8 +1,8 @@ - BumbleDocGen / Technical description of the project / Renderer / Template functions / DrawClassMap
    + BumbleDocGen / Technical description of the project / Renderer / Template functions / DrawClassMap

    - DrawClassMap class: + DrawClassMap class:

    @@ -21,7 +21,7 @@ final class DrawClassMap implements \BumbleDocGen\Core\Renderer\Twig\Function\Cu Examples of using: ```php -{{ drawClassMap(classEntityCollection.filterByPaths(['/BumbleDocGen/Renderer'])) }} +{{ drawClassMap(classEntityCollection.filterByPaths(['/src/Renderer'])) }} ``` @@ -86,7 +86,7 @@ final class DrawClassMap implements \BumbleDocGen\Core\Renderer\Twig\Function\Cu ```php @@ -108,12 +108,12 @@ public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumen $getDocumentedEntityUrlFunction - \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl + \BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl - $rootEntityCollectionsGroup - \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup + \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup - @@ -128,7 +128,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumen ```php @@ -150,7 +150,7 @@ public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEn $classEntityCollections - \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection + \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection The collection of entities for which the class map will be generated @@ -162,13 +162,13 @@ public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEn Throws: