Skip to content

Latest commit

 

History

History
425 lines (286 loc) · 11.2 KB

RootEntityInterface.md

File metadata and controls

425 lines (286 loc) · 11.2 KB

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

RootEntityInterface class: 

namespace BumbleDocGen\Core\Parser\Entity;

interface RootEntityInterface extends \\BumbleDocGen\Core\Parser\Entity\EntityInterface implements \BumbleDocGen\Core\Parser\Entity\EntityInterface
Since the documentation generator supports several programming languages, their entities need to correspond to the same interfaces

Methods:

  1. entityCacheIsOutdated
  2. entityDataCanBeLoaded - Checking if it is possible to get the entity data
  3. getAbsoluteFileName - Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
  4. getEntityDependencies
  5. getFileContent
  6. getFileName - Returns the relative path to a file if it can be retrieved and if the file is in the project directory
  7. getFileSourceLink
  8. getName
  9. getObjectId
  10. getRootEntityCollection - Get parent collection of entities
  11. getShortName
  12. isEntityNameValid - Check if entity name is valid
  13. isExternalLibraryEntity - The entity is loaded from a third party library and should not be treated the same as a standard one
  14. isInGit - The entity file is in the git repository

Method details:

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

public function entityCacheIsOutdated(): bool;

Parameters: not specified

Return value: bool

public function entityDataCanBeLoaded(): bool;
Checking if it is possible to get the entity data

Parameters: not specified

Return value: bool

// 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

Return value: string | null

public function getEntityDependencies(): array;

Parameters: not specified

Return value: array

public function getFileContent(): string;

Parameters: not specified

Return value: string

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

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

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

Parameters:

Name Type Description
$withLine bool -

Return value: string | null

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

public function getName(): string;

Parameters: not specified

Return value: string

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

public function getObjectId(): string;

Parameters: not specified

Return value: string

// 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

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

public function getShortName(): string;

Parameters: not specified

Return value: string

public static function isEntityNameValid(string $entityName): bool;
Check if entity name is valid

Parameters:

Name Type Description
$entityName string -

Return value: bool

public function isExternalLibraryEntity(): bool;
The entity is loaded from a third party library and should not be treated the same as a standard one

Parameters: not specified

Return value: bool

public function isInGit(): bool;
The entity file is in the git repository

Parameters: not specified

Return value: bool