-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 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: Wed Sep 27 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
diff --git a/docs/tech/classes/BaseCommand.md b/docs/tech/classes/BaseCommand.md
new file mode 100644
index 00000000..ad854abb
--- /dev/null
+++ b/docs/tech/classes/BaseCommand.md
@@ -0,0 +1,1382 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Console\Command;
+
+abstract class BaseCommand extends \Symfony\Component\Console\Command\Command
+```
+
+
Base class for all commands.
+
+
+
+
+
+
+
Initialization methods:
+
+
+-
+ __construct
+
+
+
+
Methods:
+
+
+-
+ addArgument
+ - Adds an argument.
+-
+ addOption
+ - Adds an option.
+-
+ addUsage
+ - Add a command usage example, it'll be prefixed with the command name.
+-
+ complete
+ - Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+-
+ getAliases
+ - Returns the aliases for the command.
+-
+ getApplication
+ - Gets the application instance for this command.
+-
+ getDefaultDescription
+
+-
+ getDefaultName
+
+-
+ getDefinition
+ - Gets the InputDefinition attached to this Command.
+-
+ getDescription
+ - Returns the description for the command.
+-
+ getHelp
+ - Returns the help for the command.
+-
+ getHelper
+ - Gets a helper instance by name.
+-
+ getHelperSet
+ - Gets the helper set.
+-
+ getName
+ - Returns the command name.
+-
+ getNativeDefinition
+ - Gets the InputDefinition to be used to create representations of this Command.
+-
+ getProcessedHelp
+ - Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
+-
+ getSynopsis
+ - Returns the synopsis for the command.
+-
+ getUsages
+ - Returns alternative usages of the command.
+-
+ ignoreValidationErrors
+ - Ignores validation errors.
+-
+ isEnabled
+ - Checks whether the command is enabled or not in the current environment.
+-
+ isHidden
+
+-
+ mergeApplicationDefinition
+ - Merges the application definition with the command definition.
+-
+ run
+ - Runs the command.
+-
+ setAliases
+ - Sets the aliases for the command.
+-
+ setApplication
+
+-
+ setCode
+ - Sets the code to execute when running this command.
+-
+ setDefinition
+ - Sets an array of argument and option instances.
+-
+ setDescription
+ - Sets the description for the command.
+-
+ setHelp
+ - Sets the help for the command.
+-
+ setHelperSet
+
+-
+ setHidden
+
+-
+ setName
+ - Sets the name of the command.
+-
+ setProcessTitle
+ - Sets the process title of the command.
+
+
+
+
Constants:
+
+
+
+
+
+
+
Method details:
+
+
+
+
+
+```php
+public function __construct(string|null $name = NULL);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string | null |
+ The name of the command; passing null means it must be set in configure() |
+
+
+
+
+
+
+
Throws:
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addArgument(string $name, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an argument.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $mode |
+ int | null |
+ The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (for InputArgument::OPTIONAL mode only) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addOption(string $name, string|array|null $shortcut = NULL, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an option.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $shortcut |
+ string | array | null |
+ The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts |
+
+
+ | $mode |
+ int | null |
+ The option mode: One of the InputOption::VALUE_* constants |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (must be null for InputOption::VALUE_NONE) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addUsage(string $usage): static;
+```
+
+
Add a command usage example, it'll be prefixed with the command name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $usage |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function complete(\Symfony\Component\Console\Completion\CompletionInput $input, \Symfony\Component\Console\Completion\CompletionSuggestions $suggestions): void;
+```
+
+
Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+
+
Parameters:
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getAliases(): array;
+```
+
+
Returns the aliases for the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getApplication(): \Symfony\Component\Console\Application|null;
+```
+
+
Gets the application instance for this command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Application |
null
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultDescription(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultName(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition attached to this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDescription(): string;
+```
+
+
Returns the description for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelp(): string;
+```
+
+
Returns the help for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelper(string $name): mixed;
+```
+
+
Gets a helper instance by name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: mixed
+
+
+
Throws:
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelperSet(): \Symfony\Component\Console\Helper\HelperSet|null;
+```
+
+
Gets the helper set.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Helper\HelperSet |
null
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getName(): string|null;
+```
+
+
Returns the command name.
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getNativeDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition to be used to create representations of this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getProcessedHelp(): string;
+```
+
+
Returns the processed help for the command replacing the %command.name% and
+%command.full_name% patterns with the real values dynamically.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getSynopsis(bool $short = false): string;
+```
+
+
Returns the synopsis for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $short |
+ bool |
+ Whether to show the short version of the synopsis (with options folded) or not |
+
+
+
+
+
Return value: string
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getUsages(): array;
+```
+
+
Returns alternative usages of the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function ignoreValidationErrors(): mixed;
+```
+
+
Ignores validation errors.
+
+
Parameters: not specified
+
+
Return value: mixed
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isEnabled(): bool;
+```
+
+
Checks whether the command is enabled or not in the current environment.
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isHidden(): bool;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+- #
+ mergeApplicationDefinition
+ :warning: Is internal | source code
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function mergeApplicationDefinition(bool $mergeArgs = true): mixed;
+```
+
+
Merges the application definition with the command definition.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $mergeArgs |
+ bool |
+ Whether to merge or not the Application definition arguments to Command definition arguments |
+
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): int;
+```
+
+
Runs the command.
+
+
Parameters:
+
+
+
+
Return value: int
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setAliases(iterable $aliases): static;
+```
+
+
Sets the aliases for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $aliases |
+ iterable |
+ An array of aliases for the command |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setApplication(\Symfony\Component\Console\Application|null $application = NULL): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setCode(callable $code): static;
+```
+
+
Sets the code to execute when running this command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $code |
+ callable |
+ A callable(InputInterface $input, OutputInterface $output) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDefinition(array|\Symfony\Component\Console\Input\InputDefinition $definition): static;
+```
+
+
Sets an array of argument and option instances.
+
+
Parameters:
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDescription(string $description): static;
+```
+
+
Sets the description for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $description |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelp(string $help): static;
+```
+
+
Sets the help for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $help |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHidden(bool $hidden = true): static;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $hidden |
+ bool |
+ Whether or not the command should be hidden from the list of commands |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setName(string $name): static;
+```
+
+
Sets the name of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setProcessTitle(string $title): static;
+```
+
+
Sets the process title of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $title |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/ClassEntityCollection.md b/docs/tech/classes/ClassEntityCollection.md
index 10f912b6..4595b21b 100644
--- a/docs/tech/classes/ClassEntityCollection.md
+++ b/docs/tech/classes/ClassEntityCollection.md
@@ -131,7 +131,7 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga
```php
-public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Console\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Psr\Log\LoggerInterface $logger);
```
@@ -184,7 +184,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf