BaseEntity.md

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

---

BaseEntity class:

namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;

abstract class BaseEntity implements \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface

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. getDescription
6. getDescriptionLinks - Get parsed links from description and doc blocks `see` and `link`
7. getDocBlock
8. getDocComment - Get the doc comment of an entity
9. getDocCommentEntity
10. getDocNote
11. getExamples - Get parsed examples from `examples` doc block
12. getFileName - Returns the relative path to a file if it can be retrieved and if the file is in the project directory
13. getFileSourceLink
14. getFirstExample - Get first example from @examples doc block
15. getImplementingReflectionClass
16. getName
17. getObjectId - Get entity unique ID
18. getPhpHandlerSettings
19. getRootEntityCollection - Get parent collection of entities
20. getShortName
21. getStartLine
22. getThrows - Get parsed throws from `throws` doc block
23. hasDescriptionLinks
24. hasExamples
25. hasThrows
26. isDeprecated
27. isEntityDataCacheOutdated
28. isEntityFileCanBeLoad
29. isInternal
30. reloadEntityDependenciesCache
31. removeEntityValueFromCache
32. removeNotUsedEntityDataCache

Traits:

• \BumbleDocGen\Core\Parser\Entity\Cache\CacheableEntityTrait

Method details:

• # entityCacheIsOutdated | source code

public function entityCacheIsOutdated(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # getAbsoluteFileName | source code

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

public function getCachedEntityDependencies(): array;

Parameters: not specified

Return value: array

Throws:

• \Psr\Cache\InvalidArgumentException

---

• # getDescription | source code

public function getDescription(): string;

Parameters: not specified

Return value: string

---

• # getDescriptionLinks | source code

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

---

• # getDocComment | source code

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\ClassEntity|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity|\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity;

Parameters: not specified

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity | \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity | \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity

---

• # getDocNote | source code

public function getDocNote(): string;

Parameters: not specified

Return value: string

---

• # getExamples | source code

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;

Returns the relative 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

---

• # getFileSourceLink | source code

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

public function getFirstExample(): string;

Get first example from @examples doc block

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

---

• # getName | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface

public function getName(): string;

Parameters: not specified

Return value: string

---

• # getObjectId | source code

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

---

• # 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

// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface

public function getShortName(): string;

Parameters: not specified

Return value: string

---

• # getStartLine | source code

public function getStartLine(): int;

Parameters: not specified

Return value: int

---

• # getThrows | source code

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

---

• # hasDescriptionLinks | source code

public function hasDescriptionLinks(): bool;

Parameters: not specified

Return value: bool

Throws:

• \Exception

---

• # hasExamples | source code

public function hasExamples(): bool;

Parameters: not specified

Return value: bool

---

• # hasThrows | source code

public function hasThrows(): bool;

Parameters: not specified

Return value: bool

---

• # isDeprecated | source code

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

public function isEntityFileCanBeLoad(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # isInternal | source code

public function isInternal(): bool;

Parameters: not specified

Return value: bool

---

• # reloadEntityDependenciesCache | source code

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

---