RendererContext.md

BumbleDocGen / Technical description of the project / Renderer / RendererContext

---

RendererContext class:

namespace BumbleDocGen\Core\Renderer\Context;

final class RendererContext

Document rendering context

Methods:

1. addDependency
2. clearDependencies
3. getCurrentDocumentedEntityWrapper
4. getCurrentTemplateFilePatch - Getting the path to the template file that is currently being worked on
5. getDependencies
6. setCurrentDocumentedEntityWrapper
7. setCurrentTemplateFilePatch - Saving the path to the template file that is currently being worked on in the context

Method details:

• # addDependency | source code

public function addDependency(\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface $dependency): void;

Parameters:

Name	Type	Description
$dependency	\BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyInterface	-

Return value: void

---

• # clearDependencies | source code

public function clearDependencies(): void;

Parameters: not specified

Return value: void

---

• # getCurrentDocumentedEntityWrapper | source code

public function getCurrentDocumentedEntityWrapper(): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper|null;

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper | null

---

• # getCurrentTemplateFilePatch | source code

public function getCurrentTemplateFilePatch(): string;

Getting the path to the template file that is currently being worked on

Parameters: not specified

Return value: string

---

• # getDependencies | source code

public function getDependencies(): array;

Parameters: not specified

Return value: array

---

• # setCurrentDocumentedEntityWrapper | source code

public function setCurrentDocumentedEntityWrapper(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $currentDocumentedEntityWrapper): void;

Parameters:

Name	Type	Description
$currentDocumentedEntityWrapper	\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper	-

Return value: void

---

• # setCurrentTemplateFilePatch | source code

public function setCurrentTemplateFilePatch(string $currentTemplateFilePath): void;

Saving the path to the template file that is currently being worked on in the context

Parameters:

Name	Type	Description
$currentTemplateFilePath	string	-

Return value: void

---