Skip to content

Latest commit

 

History

History
225 lines (149 loc) · 5.48 KB

OnGetTemplatePathByRelativeDocPath.md

File metadata and controls

225 lines (149 loc) · 5.48 KB

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


namespace BumbleDocGen\Core\Plugin\Event\Renderer;

final class OnGetTemplatePathByRelativeDocPath extends \Symfony\Contracts\EventDispatcher\Event
The event occurs when the path to the template file is obtained relative to the path to the document

Initialization methods:

  1. __construct

Methods:

  1. getCustomTemplateFilePath
  2. getTemplateName
  3. isPropagationStopped - Is propagation stopped?
  4. setCustomTemplateFilePath
  5. stopPropagation - Stops the propagation of the event to further event listeners.

Method details:

public function __construct(string $templateName);

Parameters:

Name Type Description
$templateName string -

public function getCustomTemplateFilePath(): string|null;

Parameters: not specified

Return value: string | null


public function getTemplateName(): string;

Parameters: not specified

Return value: string


// Implemented in Symfony\Contracts\EventDispatcher\Event

public function isPropagationStopped(): bool;
Is propagation stopped?

Parameters: not specified

Return value: bool


public function setCustomTemplateFilePath(string|null $customTemplateFilePath): void;

Parameters:

Name Type Description
$customTemplateFilePath string | null -

Return value: void


// Implemented in Symfony\Contracts\EventDispatcher\Event

public function stopPropagation(): void;
Stops the propagation of the event to further event listeners.

Parameters: not specified

Return value: void