EntityInterface.md

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

---

EntityInterface class:

namespace BumbleDocGen\Core\Parser\Entity;

interface 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. getFileName - Returns the relative path to a file if it can be retrieved and if the file is in the project directory
4. getName
5. getObjectId
6. getRootEntityCollection - Get parent collection of entities
7. getShortName

Method details:

• # entityCacheIsOutdated | source code

public function entityCacheIsOutdated(): bool;

Parameters: not specified

Return value: bool

---

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

---

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

---

• # getName | source code

public function getName(): string;

Parameters: not specified

Return value: string

---

• # getObjectId | source code

public function getObjectId(): string;

Parameters: not specified

Return value: string

---

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

---