DocumentTransformableEntityInterface.md

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

---

DocumentTransformableEntityInterface class:

namespace BumbleDocGen\Core\Renderer\Context;

interface DocumentTransformableEntityInterface

Interface for entities that can be generated into documents

Methods:

1. cursorToDocAttributeLinkFragment
2. documentCreationAllowed
3. entityCacheIsOutdated
4. getDocRender
5. getName
6. getRootEntityCollection
7. getShortName

Method details:

• # cursorToDocAttributeLinkFragment | source code

public function cursorToDocAttributeLinkFragment(string $cursor, bool $isForDocument = true): string;

Parameters:

Name	Type	Description
$cursor	string	-
$isForDocument	bool	-

Return value: string

---

• # documentCreationAllowed | source code

public function documentCreationAllowed(): bool;

Parameters: not specified

Return value: bool

---

• # entityCacheIsOutdated | source code

public function entityCacheIsOutdated(): bool;

Parameters: not specified

Return value: bool

---

• # getDocRender | source code

public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface

---

• # getName | source code

public function getName(): string;

Parameters: not specified

Return value: string

---

• # getRootEntityCollection | source code

public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection;

Parameters: not specified

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

---

• # getShortName | source code

public function getShortName(): string;

Parameters: not specified

Return value: string

---