PhpHandlerSettings.md

BumbleDocGen / Technical description of the project / Class map / PhpHandlerSettings

---

PhpHandlerSettings class:

namespace BumbleDocGen\LanguageHandler\Php;

final class PhpHandlerSettings

Initialization methods:

1. __construct

Methods:

1. asyncSourceLoadingEnabled
2. getClassConstantEntityFilter
3. getClassEntityFilter
4. getCustomTwigFilters
5. getCustomTwigFunctions
6. getEntityDocRenderersCollection
7. getFileSourceBaseUrl
8. getMethodEntityFilter
9. getPropertyEntityFilter

Constants:

• # DEFAULT_SETTINGS_FILE | source code
• # SETTINGS_PREFIX | source code

Method details:

• # __construct | source code

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

Parameters:

Name	Type	Description
$parameterBag	\BumbleDocGen\Core\Configuration\ConfigurationParameterBag	-
$localObjectCache	\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache	-

---

• # asyncSourceLoadingEnabled | source code

public function asyncSourceLoadingEnabled(): bool;

Parameters: not specified

Return value: bool

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getClassConstantEntityFilter | source code

public function getClassConstantEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface

Throws:

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

---

• # getClassEntityFilter | source code

public function getClassEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface

Throws:

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

---

• # getCustomTwigFilters | source code

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

Parameters: not specified

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

Throws:

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

---

• # getCustomTwigFunctions | source code

public function getCustomTwigFunctions(): \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

---

• # getEntityDocRenderersCollection | source code

public function getEntityDocRenderersCollection(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection;

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRenderersCollection

Throws:

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

---

• # getFileSourceBaseUrl | source code

public function getFileSourceBaseUrl(): string|null;

Parameters: not specified

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getMethodEntityFilter | source code

public function getMethodEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface

Throws:

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

---

• # getPropertyEntityFilter | source code

public function getPropertyEntityFilter(): \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\FilterCondition\ConditionInterface

Throws:

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

---