DrawClassMap.md

BumbleDocGen / Technical description of the project / Renderer / Template functions / DrawClassMap

---

DrawClassMap class:

namespace BumbleDocGen\LanguageHandler\Php\Renderer\Twig\Function;

final class DrawClassMap implements \BumbleDocGen\Core\Renderer\Twig\Function\CustomFunctionInterface

Generate class map in HTML format

Examples of using:

{{ drawClassMap(classEntityCollection.filterByPaths(['/src/Renderer'])) }}

{{ drawClassMap(classEntityCollection) }}

Settings:

Function name:

drawClassMap

Initialization methods:

1. __construct

Methods:

1. __invoke
2. convertDirectoryStructureToFormattedString
3. getDirectoryStructure
4. getName
5. getOptions

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl $getDocumentedEntityUrlFunction, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup);

Parameters:

Name	Type	Description
$getDocumentedEntityUrlFunction	\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumentedEntityUrl	-
$rootEntityCollectionsGroup	\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup	-

---

• # __invoke | source code

public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection ...$classEntityCollections): string;

Parameters:

Name	Type	Description
$classEntityCollections (variadic)	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	The collection of entities for which the class map will be generated

Return value: string

Throws:

• \DI\NotFoundException
• \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # convertDirectoryStructureToFormattedString | source code

public function convertDirectoryStructureToFormattedString(array $structure, string $prefix = '│', string $path = '/'): string;

Parameters:

Name	Type	Description
$structure	array	-
$prefix	string	-
$path	string	-

Return value: string

---

• # getDirectoryStructure | source code

public function getDirectoryStructure(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection ...$classEntityCollections): array;

Parameters:

Name	Type	Description
$classEntityCollections (variadic)	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	-

Return value: array

Throws:

• \DI\NotFoundException
• \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getName | source code

public static function getName(): string;

Parameters: not specified

Return value: string

---

• # getOptions | source code

public static function getOptions(): array;

Parameters: not specified

Return value: array

---