PropertyEntity.md

BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / PropertyEntity

---

PropertyEntity class:

namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;

class PropertyEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface

Class property entity

Initialization methods:

1. __construct

Methods:

1. entityCacheIsOutdated
2. getAbsoluteFileName - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
3. getCacheKey
4. getCachedEntityDependencies
5. getDefaultValue
6. getDescription
7. getDescriptionLinks - Get parsed links from description and doc blocks `see` and `link`
8. getDocBlock
9. getDocComment - Get the doc comment of an entity
10. getDocCommentEntity
11. getDocNote
12. getEndLine
13. getExamples - Get parsed examples from `examples` doc block
14. getFileName
15. getFileSourceLink
16. getFirstExample - Get first example from @examples doc block
17. getImplementingClass
18. getImplementingClassName
19. getImplementingReflectionClass
20. getModifiersString
21. getName
22. getNamespaceName
23. getObjectId - Get entity unique ID
24. getPhpHandlerSettings
25. getRootEntity
26. getRootEntityCollection - Get parent collection of entities
27. getShortName
28. getStartLine
29. getThrows - Get parsed throws from `throws` doc block
30. getType
31. hasDescriptionLinks
32. hasExamples
33. hasThrows
34. isDeprecated
35. isEntityDataCacheOutdated
36. isEntityFileCanBeLoad
37. isImplementedInParentClass
38. isInternal
39. isPrivate
40. isProtected
41. isPublic
42. reloadEntityDependenciesCache
43. removeEntityValueFromCache
44. removeNotUsedEntityDataCache

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \Psr\Log\LoggerInterface $logger, string $propertyName, string $declaringClassName, string $implementingClassName);

Parameters:

Name	Type	Description
$configuration	\BumbleDocGen\Core\Configuration\Configuration	-
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$parserHelper	\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper	-
$localObjectCache	\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache	-
$logger	\Psr\Log\LoggerInterface	-
$propertyName	string	-
$declaringClassName	string	-
$implementingClassName	string	-

---

• # entityCacheIsOutdated | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function entityCacheIsOutdated(): bool;

Parameters: not specified

Return value: bool

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \Psr\Cache\InvalidArgumentException

---

• # getAbsoluteFileName | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getAbsoluteFileName(): string|null;

Returns the absolute path to a file if it can be retrieved and if the file is in the project directory

Parameters: not specified

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getCacheKey | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait

public function getCacheKey(): string;

Parameters: not specified

Return value: string

---

• # getCachedEntityDependencies | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getCachedEntityDependencies(): array;

Parameters: not specified

Return value: array

Throws:

• \Psr\Cache\InvalidArgumentException

---

• # getDefaultValue | source code

public function getDefaultValue(): string|array|int|bool|null|float;

Parameters: not specified

Return value: string | array | int | bool | null | float

Throws:

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

---

• # getDescription | source code

public function getDescription(): string;

Parameters: not specified

Return value: string

Throws:

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

---

• # getDescriptionLinks | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getDescriptionLinks(): array;

Get parsed links from description and doc blocks `see` and `link`

Parameters: not specified

Return value: array

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \Exception

---

• # getDocBlock | source code

public function getDocBlock(): \phpDocumentor\Reflection\DocBlock;

Parameters: not specified

Return value: \phpDocumentor\Reflection\DocBlock

Throws:

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

---

• # getDocComment | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getDocComment(): string;

Get the doc comment of an entity

Parameters: not specified

Return value: string

Throws:

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

---

• # getDocCommentEntity | source code

public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity;

Parameters: not specified

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

Throws:

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

---

• # getDocNote | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getDocNote(): string;

Parameters: not specified

Return value: string

---

• # getEndLine | source code

public function getEndLine(): int;

Parameters: not specified

Return value: int

Throws:

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

---

• # getExamples | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getExamples(): array;

Get parsed examples from `examples` doc block

Parameters: not specified

Return value: array

---

• # getFileName | source code

public function getFileName(): string|null;

Parameters: not specified

Return value: string | null

Throws:

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

---

• # getFileSourceLink | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getFileSourceLink(bool $withLine = true): string|null;

Parameters:

Name	Type	Description
$withLine	bool	-

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getFirstExample | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getFirstExample(): string;

Get first example from @examples doc block

Parameters: not specified

Return value: string

---

• # getImplementingClass | source code

public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters: not specified

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

---

• # getImplementingClassName | source code

public function getImplementingClassName(): string;

Parameters: not specified

Return value: string

---

• # getImplementingReflectionClass | source code

public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflection\ReflectionClass;

Parameters: not specified

Return value: \Roave\BetterReflection\Reflection\ReflectionClass

Throws:

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

---

• # getModifiersString | source code

public function getModifiersString(): string;

Parameters: not specified

Return value: string

Throws:

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

---

• # getName | source code

public function getName(): string;

Parameters: not specified

Return value: string

---

• # getNamespaceName | source code

public function getNamespaceName(): string;

Parameters: not specified

Return value: string

Throws:

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

---

• # getObjectId | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getObjectId(): string;

Get entity unique ID

Parameters: not specified

Return value: string

---

• # getPhpHandlerSettings | source code

public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings;

Parameters: not specified

Return value: \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings

---

• # getRootEntity | source code

public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters: not specified

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

---

• # getRootEntityCollection | source code

public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection;

Get parent collection of entities

Parameters: not specified

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

---

• # getShortName | source code

public function getShortName(): string;

Parameters: not specified

Return value: string

---

• # getStartLine | source code

public function getStartLine(): int;

Parameters: not specified

Return value: int

Throws:

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

---

• # getThrows | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function getThrows(): array;

Get parsed throws from `throws` doc block

Parameters: not specified

Return value: array

Throws:

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

---

• # getType | source code

public function getType(): string;

Parameters: not specified

Return value: string

Throws:

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

---

• # hasDescriptionLinks | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function hasDescriptionLinks(): bool;

Parameters: not specified

Return value: bool

Throws:

• \Exception

---

• # hasExamples | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function hasExamples(): bool;

Parameters: not specified

Return value: bool

---

• # hasThrows | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function hasThrows(): bool;

Parameters: not specified

Return value: bool

---

• # isDeprecated | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function isDeprecated(): bool;

Parameters: not specified

Return value: bool

---

• # isEntityDataCacheOutdated | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait

public function isEntityDataCacheOutdated(): bool;

Parameters: not specified

Return value: bool

Throws:

• \Psr\Cache\InvalidArgumentException

---

• # isEntityFileCanBeLoad | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function isEntityFileCanBeLoad(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # isImplementedInParentClass | source code

public function isImplementedInParentClass(): bool;

Parameters: not specified

Return value: bool

---

• # isInternal | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function isInternal(): bool;

Parameters: not specified

Return value: bool

---

• # isPrivate | source code

public function isPrivate(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # isProtected | source code

public function isProtected(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # isPublic | source code

public function isPublic(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # reloadEntityDependenciesCache | source code

// Implemented in BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseEntity

public function reloadEntityDependenciesCache(): array;

Parameters: not specified

Return value: array

Throws:

• \Psr\Cache\InvalidArgumentException

---

• # removeEntityValueFromCache | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait

public function removeEntityValueFromCache(string $key): void;

Parameters:

Name	Type	Description
$key	string	-

Return value: void

---

• # removeNotUsedEntityDataCache | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait

public function removeNotUsedEntityDataCache(): void;

Parameters: not specified

Return value: void

Throws:

• \Psr\Cache\InvalidArgumentException

---