Configuration.md

BumbleDocGen / Technical description of the project / Configuration files / Configuration

---

Configuration class:

namespace BumbleDocGen\Core\Configuration;

final class Configuration

Configuration project documentation

Initialization methods:

1. __construct

Methods:

1. getAdditionalConsoleCommands
2. getCacheDir
3. getConfigurationVersion
4. getDocGenLibDir
5. getGitClientPath
6. getIfExists
7. getLanguageHandlersCollection
8. getOutputDir
9. getOutputDirBaseUrl
10. getPageLinkProcessor
11. getPlugins
12. getProjectRoot
13. getSourceLocators
14. getTemplatesDir
15. getTwigFilters
16. getTwigFunctions
17. getWorkingDir
18. isCheckFileInGitBeforeCreatingDocEnabled
19. useSharedCache

Constants:

• # DEFAULT_SETTINGS_FILE | source code

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger);

Parameters:

Name	Type	Description
$parameterBag	\BumbleDocGen\Core\Configuration\ConfigurationParameterBag	-
$localObjectCache	\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache	-
$logger	\Psr\Log\LoggerInterface	-

---

• # getAdditionalConsoleCommands | source code

public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;

Parameters: not specified

Return value: \BumbleDocGen\Console\Command\AdditionalCommandCollection

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getCacheDir | source code

public function getCacheDir(): string|null;

Parameters: not specified

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getConfigurationVersion | source code

public function getConfigurationVersion(): string;

Parameters: not specified

Return value: string

---

• # getDocGenLibDir | source code

public function getDocGenLibDir(): string;

Parameters: not specified

Return value: string

---

• # getGitClientPath | source code

public function getGitClientPath(): string;

Parameters: not specified

Return value: string

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getIfExists | source code

public function getIfExists(mixed $key): string|null;

Parameters:

Name	Type	Description
$key	mixed	-

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getLanguageHandlersCollection | source code

public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\LanguageHandlersCollection;

Parameters: not specified

Return value: \BumbleDocGen\LanguageHandler\LanguageHandlersCollection

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getOutputDir | source code

public function getOutputDir(): string;

Parameters: not specified

Return value: string

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getOutputDirBaseUrl | source code

public function getOutputDirBaseUrl(): string;

Parameters: not specified

Return value: string

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getPageLinkProcessor | source code

public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\PageLinkProcessor\PageLinkProcessorInterface

Throws:

• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \DI\NotFoundException

---

• # getPlugins | source code

public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;

Parameters: not specified

Return value: \BumbleDocGen\Core\Plugin\PluginsCollection

Throws:

• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \DI\NotFoundException

---

• # getProjectRoot | source code

public function getProjectRoot(): string;

Parameters: not specified

Return value: string

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getSourceLocators | source code

public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection

Throws:

• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \DI\NotFoundException

---

• # getTemplatesDir | source code

public function getTemplatesDir(): string;

Parameters: not specified

Return value: string

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getTwigFilters | source code

public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection;

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\Twig\Filter\CustomFiltersCollection

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getTwigFunctions | source code

public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection;

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionsCollection

Throws:

• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \DI\NotFoundException

---

• # getWorkingDir | source code

public function getWorkingDir(): string;

Parameters: not specified

Return value: string

Throws:

• \Exception

---

• # isCheckFileInGitBeforeCreatingDocEnabled | source code

public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;

Parameters: not specified

Return value: bool

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # useSharedCache | source code

public function useSharedCache(): bool;

Parameters: not specified

Return value: bool

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---