Skip to content

Latest commit

 

History

History
230 lines (154 loc) · 5.42 KB

BeforeCreatingDocFile.md

File metadata and controls

230 lines (154 loc) · 5.42 KB

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


namespace BumbleDocGen\Core\Plugin\Event\Renderer;

final class BeforeCreatingDocFile extends \Symfony\Contracts\EventDispatcher\Event
Called before the content of the documentation document is saved to a file

Initialization methods:

  1. __construct

Methods:

  1. getContent
  2. getContext
  3. isPropagationStopped - Is propagation stopped?
  4. setContent
  5. stopPropagation - Stops the propagation of the event to further event listeners.

Method details:

public function __construct(string $content, \BumbleDocGen\Core\Renderer\Context\RendererContext $context);

Parameters:

Name Type Description
$content string -
$context \BumbleDocGen\Core\Renderer\Context\RendererContext -

public function getContent(): string;

Parameters: not specified

Return value: string


public function getContext(): \BumbleDocGen\Core\Renderer\Context\RendererContext;

Parameters: not specified

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


// Implemented in Symfony\Contracts\EventDispatcher\Event

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

Parameters: not specified

Return value: bool


public function setContent(string $content): void;

Parameters:

Name Type Description
$content string -

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