Skip to content

DocumentedEntityWrapper.md

Latest commit

 

History

History
303 lines (207 loc) · 8.02 KB

DocumentedEntityWrapper.md

File metadata and controls

303 lines (207 loc) · 8.02 KB

BumbleDocGen / Technical description of the project / Renderer / DocumentedEntityWrapper

DocumentedEntityWrapper class: 

namespace BumbleDocGen\Core\Renderer\Context;

final class DocumentedEntityWrapper
Wrapper for the entity that was requested for documentation

Initialization methods:

  1. __construct

Methods:

  1. getDocRender
  2. getDocUrl - Get the relative path to the document to be generated
  3. getDocumentTransformableEntity - Get entity that is allowed to be documented
  4. getEntityName
  5. getFileName - The name of the file to be generated
  6. getKey - Get document key
  7. getParentDocFilePath
  8. setParentDocFilePath

Method details:

public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface $documentTransformableEntity, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, string $parentDocFilePath);

Parameters:

Name Type Description
$documentTransformableEntity \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface An entity that is allowed to be documented
$localObjectCache \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache -
$parentDocFilePath string The file in which the documentation of the entity was requested 
public function getDocRender(): \BumbleDocGen\Core\Renderer\EntityDocRenderer\EntityDocRendererInterface;

Parameters: not specified

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

public function getDocUrl(): string;
Get the relative path to the document to be generated

Parameters: not specified

Return value: string

public function getDocumentTransformableEntity(): \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface;
Get entity that is allowed to be documented

Parameters: not specified

Return value: \BumbleDocGen\Core\Renderer\Context\DocumentTransformableEntityInterface

public function getEntityName(): string;

Parameters: not specified

Return value: string

public function getFileName(): string;
The name of the file to be generated

Parameters: not specified

Return value: string

public function getKey(): string;
Get document key

Parameters: not specified

Return value: string

public function getParentDocFilePath(): string;

Parameters: not specified

Return value: string

public function setParentDocFilePath(string $parentDocFilePath): void;

Parameters:

Name Type Description
$parentDocFilePath string -

Return value: void