BumbleDocGen / Technical description of the project / Class map / MethodEntityInterface
MethodEntityInterface class:
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
interface MethodEntityInterface extends \\BumbleDocGen\Core\Parser\Entity\EntityInterface implements \BumbleDocGen\Core\Parser\Entity\EntityInterface- entityCacheIsOutdated
- getAbsoluteFileName - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
- getBodyCode
- getDescription
- getEndLine
- getFileName - Returns the relative path to a file if it can be retrieved and if the file is in the project directory
- getFirstReturnValue
- getImplementingClass
- getImplementingClassName
- getModifiersString
- getName
- getObjectId
- getParameters
- getParametersString
- getReturnType
- getRootEntityCollection - Get parent collection of entities
- getShortName
- getStartColumn
- getStartLine
- isDynamic
- isInitialization
- isPrivate
- isProtected
- isPublic
- # entityCacheIsOutdated | source code
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function entityCacheIsOutdated(): bool;Parameters: not specified
Return value: bool
- # getAbsoluteFileName | source code
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
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
- # getBodyCode | source code
public function getBodyCode(): string;Parameters: not specified
Return value: string
- # 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
- # 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
- # 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
- # 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
- # getObjectId | source code
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
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
- # getRootEntityCollection | source code
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
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
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
public function getShortName(): string;Parameters: not specified
Return value: string
- # getStartColumn | source code
public function getStartColumn(): int;Parameters: not specified
Return value: int
- # getStartLine | source code
public function getStartLine(): int;Parameters: not specified
Return value: int
- # 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
- # 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