ConfigurationParameterBag.md

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

---

ConfigurationParameterBag class:

namespace BumbleDocGen\Core\Configuration;

final class ConfigurationParameterBag

Wrapper for getting raw configuration file data

Initialization methods:

1. __construct

Methods:

1. addValueFromFileIfNotExists
2. addValueIfNotExists
3. get
4. getAll
5. getConfigValues
6. getConfigVersion
7. getSubConfigurationParameterBag
8. has
9. loadFromArray
10. loadFromFiles
11. resolveValue
12. set
13. validateAndGetBooleanValue
14. validateAndGetClassListValue
15. validateAndGetClassValue
16. validateAndGetDirectoryPathValue
17. validateAndGetFilePathValue
18. validateAndGetStringValue

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Configuration\ValueTransformer\ValueToClassTransformer $valueToClassTransformer, array $resolvers);

Parameters:

Name	Type	Description
$valueToClassTransformer	\BumbleDocGen\Core\Configuration\ValueTransformer\ValueToClassTransformer	-
$resolvers	array	-

---

• # addValueFromFileIfNotExists | source code

public function addValueFromFileIfNotExists(string $name, string ...$fileNames): void;

Parameters:

Name	Type	Description
$name	string	-
$fileNames (variadic)	string	-

Return value: void

---

• # addValueIfNotExists | source code

public function addValueIfNotExists(string $name, mixed $value): void;

Parameters:

Name	Type	Description
$name	string	-
$value	mixed	-

Return value: void

---

• # get | source code

public function get(string $name, bool $useResolvers = true): mixed;

Parameters:

Name	Type	Description
$name	string	-
$useResolvers	bool	-

Return value: mixed

Throws:

• \InvalidArgumentException

---

• # getAll | source code

public function getAll(bool $useResolvers = true): array;

Parameters:

Name	Type	Description
$useResolvers	bool	-

Return value: array

---

• # getConfigValues | source code

public function getConfigValues(string ...$configurationFiles): array;

Parameters:

Name	Type	Description
$configurationFiles (variadic)	string	-

Return value: array

---

• # getConfigVersion | source code

public function getConfigVersion(): string;

Parameters: not specified

Return value: string

---

• # getSubConfigurationParameterBag | source code

public function getSubConfigurationParameterBag(string $parentKey): \BumbleDocGen\Core\Configuration\ConfigurationParameterBag;

Parameters:

Name	Type	Description
$parentKey	string	-

Return value: \BumbleDocGen\Core\Configuration\ConfigurationParameterBag

---

• # has | source code

public function has(mixed $name): bool;

Parameters:

Name	Type	Description
$name	mixed	-

Return value: bool

---

• # loadFromArray | source code

public function loadFromArray(array $parameters): void;

Parameters:

Name	Type	Description
$parameters	array	-

Return value: void

---

• # loadFromFiles | source code

public function loadFromFiles(string ...$fileNames): void;

Parameters:

Name	Type	Description
$fileNames (variadic)	string	-

Return value: void

---

• # resolveValue | source code

public function resolveValue(mixed $value): mixed;

Parameters:

Name	Type	Description
$value	mixed	-

Return value: mixed

---

• # set | source code

public function set(string $name, mixed $value): void;

Parameters:

Name	Type	Description
$name	string	-
$value	mixed	-

Return value: void

---

• # validateAndGetBooleanValue | source code

public function validateAndGetBooleanValue(string $parameterName): bool;

Parameters:

Name	Type	Description
$parameterName	string	-

Return value: bool

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # validateAndGetClassListValue | source code

public function validateAndGetClassListValue(string $parameterName, string $classInterfaceName, bool $nullable = true): array;

Parameters:

Name	Type	Description
$parameterName	string	-
$classInterfaceName	string	-
$nullable	bool	-

Return value: array

Throws:

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

---

• # validateAndGetClassValue | source code

public function validateAndGetClassValue(string $parameterName, string $classInterfaceName): object;

Parameters:

Name	Type	Description
$parameterName	string	-
$classInterfaceName	string	-

Return value: object

Throws:

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

---

• # validateAndGetDirectoryPathValue | source code

public function validateAndGetDirectoryPathValue(string $parameterName, bool $nullable = true): string|null;

Parameters:

Name	Type	Description
$parameterName	string	-
$nullable	bool	-

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # validateAndGetFilePathValue | source code

public function validateAndGetFilePathValue(string $parameterName, array $fileExtensions, bool $nullable = true): string|null;

Parameters:

Name	Type	Description
$parameterName	string	-
$fileExtensions	string[]	-
$nullable	bool	-

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # validateAndGetStringValue | source code

public function validateAndGetStringValue(string $parameterName, bool $nullable = true): string|null;

Parameters:

Name	Type	Description
$parameterName	string	-
$nullable	bool	-

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---