CacheablePhpEntityFactory.md

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

---

CacheablePhpEntityFactory class:

namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache;

final class CacheablePhpEntityFactory

Initialization methods:

1. __construct

Methods:

1. createClassEntity
2. createClassEntityByReflection
3. createConstantEntity
4. createDynamicMethodEntity
5. createMethodEntity
6. createPropertyEntity
7. createSubClassEntity
8. createSubClassEntityByReflection

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityWrapperFactory $cacheableEntityWrapperFactory, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Reflection\ReflectorWrapper $reflector, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \DI\Container $diContainer);

Parameters:

Name	Type	Description
$cacheableEntityWrapperFactory	\BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityWrapperFactory	-
$reflector	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Reflection\ReflectorWrapper	-
$configuration	\BumbleDocGen\Core\Configuration\Configuration	-
$localObjectCache	\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache	-
$diContainer	\DI\Container	-

---

• # createClassEntity | source code

public function createClassEntity(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection $classEntityCollection, string $className, string|null $relativeFileName = null): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters:

Name	Type	Description
$classEntityCollection	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	-
$className	string	-
$relativeFileName	string | null	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity

Throws:

• \DI\DependencyException
• \DI\NotFoundException

---

• # createClassEntityByReflection | source code

public function createClassEntityByReflection(\Roave\BetterReflection\Reflection\ReflectionClass $reflectionClass, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection $classEntityCollection): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters:

Name	Type	Description
$reflectionClass	\Roave\BetterReflection\Reflection\ReflectionClass	-
$classEntityCollection	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity

Throws:

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

---

• # createConstantEntity | source code

public function createConstantEntity(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, string $constantName, string $declaringClassName, string $implementingClassName, bool $reloadCache = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity;

Parameters:

Name	Type	Description
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$constantName	string	-
$declaringClassName	string	-
$implementingClassName	string	-
$reloadCache	bool	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity

Throws:

• \DI\DependencyException
• \DI\NotFoundException

---

• # createDynamicMethodEntity | source code

public function createDynamicMethodEntity(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, \phpDocumentor\Reflection\DocBlock\Tags\Method $annotationMethod): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\DynamicMethodEntity;

Parameters:

Name	Type	Description
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$annotationMethod	\phpDocumentor\Reflection\DocBlock\Tags\Method	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\DynamicMethodEntity

Throws:

• \DI\DependencyException
• \DI\NotFoundException

---

• # createMethodEntity | source code

public function createMethodEntity(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, string $methodName, string $declaringClassName, string $implementingClassName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity;

Parameters:

Name	Type	Description
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$methodName	string	-
$declaringClassName	string	-
$implementingClassName	string	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity

Throws:

• \DI\DependencyException
• \DI\NotFoundException

---

• # createPropertyEntity | source code

public function createPropertyEntity(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, string $propertyName, string $declaringClassName, string $implementingClassName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity;

Parameters:

Name	Type	Description
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$propertyName	string	-
$declaringClassName	string	-
$implementingClassName	string	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity

Throws:

• \DI\DependencyException
• \DI\NotFoundException

---

• # createSubClassEntity | source code

public function createSubClassEntity(string $subClassEntity, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection $classEntityCollection, string $className, string|null $relativeFileName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters:

Name	Type	Description
$subClassEntity	string	-
$classEntityCollection	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	-
$className	string	-
$relativeFileName	string | null	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity

Throws:

• \DI\DependencyException
• \DI\NotFoundException

---

• # createSubClassEntityByReflection | source code

public function createSubClassEntityByReflection(string $subClassEntity, \Roave\BetterReflection\Reflection\ReflectionClass $reflectionClass, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection $classEntityCollection): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters:

Name	Type	Description
$subClassEntity	string	-
$reflectionClass	\Roave\BetterReflection\Reflection\ReflectionClass	-
$classEntityCollection	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity

Throws:

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

---