DocGeneratorFactory.md

BumbleDocGen / DocGeneratorFactory

---

DocGeneratorFactory class:

namespace BumbleDocGen;

final class DocGeneratorFactory

Initialization methods:

1. __construct

Methods:

1. create
2. createByConfigArray
3. createConfiguration
4. setCustomConfigurationParameters
5. setCustomDiDefinitions

Method details:

• # __construct | source code

public function __construct(string $diConfig = __DIR__ . '/di-config.php');

Parameters:

Name	Type	Description
$diConfig	string	-

---

• # create | source code

public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGenerator;

Parameters:

Name	Type	Description
$configurationFiles (variadic)	string | null	-

Return value: \BumbleDocGen\DocGenerator

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \Exception

---

• # createByConfigArray | source code

public function createByConfigArray(array $config): \BumbleDocGen\DocGenerator;

Parameters:

Name	Type	Description
$config	array	-

Return value: \BumbleDocGen\DocGenerator

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \Exception

---

• # createConfiguration | source code

public function createConfiguration(string ...$configurationFiles): \BumbleDocGen\Core\Configuration\Configuration;

Parameters:

Name	Type	Description
$configurationFiles (variadic)	string	-

Return value: \BumbleDocGen\Core\Configuration\Configuration

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \Exception

---

• # setCustomConfigurationParameters | source code

public function setCustomConfigurationParameters(array $customConfigurationParameters): void;

Parameters:

Name	Type	Description
$customConfigurationParameters	array	-

Return value: void

---

• # setCustomDiDefinitions | source code

public function setCustomDiDefinitions(array $definitions): void;

Parameters:

Name	Type	Description
$definitions	array	-

Return value: void

---