DynamicMethodEntity.md

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

---

DynamicMethodEntity class:

namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;

class DynamicMethodEntity implements \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntityInterface, \BumbleDocGen\Core\Parser\Entity\EntityInterface

Method obtained by parsing the "method" annotation

Initialization methods:

1. __construct

Methods:

1. entityCacheIsOutdated
2. getAbsoluteFileName
3. getBodyCode
4. getCallMethod
5. getDescription
6. getEndLine
7. getFileName
8. getFirstReturnValue
9. getImplementingClass
10. getImplementingClassName
11. getImplementingReflectionClass
12. getModifiersString
13. getName
14. getNamespaceName
15. getObjectId
16. getParameters
17. getParametersString
18. getReturnType
19. getRootEntity
20. getRootEntityCollection - Get parent collection of entities
21. getShortName
22. getStartColumn
23. getStartLine
24. isDynamic
25. isInitialization
26. isPrivate
27. isProtected
28. isPublic
29. isStatic

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, \phpDocumentor\Reflection\DocBlock\Tags\Method $annotationMethod);

Parameters:

Name	Type	Description
$configuration	\BumbleDocGen\Core\Configuration\Configuration	-
$parserHelper	\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper	-
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$annotationMethod	\phpDocumentor\Reflection\DocBlock\Tags\Method	-

---

• # entityCacheIsOutdated | source code

public function entityCacheIsOutdated(): bool;

Parameters: not specified

Return value: bool

---

• # getAbsoluteFileName | source code

public function getAbsoluteFileName(): string|null;

Parameters: not specified

Return value: string | null

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getBodyCode | source code

public function getBodyCode(): string;

Parameters: not specified

Return value: string

---

• # getCallMethod | source code

public function getCallMethod(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\MethodEntity;

Parameters: not specified

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

Throws:

• \Exception

---

• # getDescription | source code

public function getDescription(): string;

Parameters: not specified

Return value: string

---

• # getEndLine | source code

public function getEndLine(): int;

Parameters: not specified

Return value: int

Throws:

• \Exception

---

• # getFileName | source code

public function getFileName(): string|null;

Parameters: not specified

Return value: string | null

Throws:

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

---

• # getFirstReturnValue | source code

public function getFirstReturnValue(): mixed;

Parameters: not specified

Return value: mixed

---

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

Throws:

• \Exception

---

• # getImplementingReflectionClass | source code

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

Parameters: not specified

Return value: \Roave\BetterReflection\Reflection\ReflectionClass

Throws:

• \Exception

---

• # getModifiersString | source code

public function getModifiersString(): string;

Parameters: not specified

Return value: string

---

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

public function getObjectId(): string;

Parameters: not specified

Return value: string

---

• # getParameters | source code

public function getParameters(): array;

Parameters: not specified

Return value: array

---

• # getParametersString | source code

public function getParametersString(): string;

Parameters: not specified

Return value: string

---

• # getReturnType | source code

public function getReturnType(): string;

Parameters: not specified

Return value: string

Throws:

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

---

• # 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\Core\Parser\Entity\RootEntityCollection;

Get parent collection of entities

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection

---

• # getShortName | source code

public function getShortName(): string;

Parameters: not specified

Return value: string

---

• # getStartColumn | source code

public function getStartColumn(): int;

Parameters: not specified

Return value: int

Throws:

• \Exception

---

• # getStartLine | source code

public function getStartLine(): int;

Parameters: not specified

Return value: int

Throws:

• \Exception

---

• # isDynamic | source code

public function isDynamic(): bool;

Parameters: not specified

Return value: bool

---

• # isInitialization | source code

public function isInitialization(): bool;

Parameters: not specified

Return value: bool

Throws:

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

---

• # isPrivate | source code

public function isPrivate(): bool;

Parameters: not specified

Return value: bool

---

• # isProtected | source code

public function isProtected(): bool;

Parameters: not specified

Return value: bool

---

• # isPublic | source code

public function isPublic(): bool;

Parameters: not specified

Return value: bool

---

• # isStatic | source code

public function isStatic(): bool;

Parameters: not specified

Return value: bool

---