Skip to content

Latest commit

 

History

History
160 lines (101 loc) · 4.06 KB

OnCreateDocumentedEntityWrapper.md

File metadata and controls

160 lines (101 loc) · 4.06 KB

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


namespace BumbleDocGen\Core\Plugin\Event\Renderer;

final class OnCreateDocumentedEntityWrapper extends \Symfony\Contracts\EventDispatcher\Event
The event occurs when an entity is added to the list for documentation

Initialization methods:

  1. __construct

Methods:

  1. getDocumentedEntityWrapper
  2. isPropagationStopped - Is propagation stopped?
  3. stopPropagation - Stops the propagation of the event to further event listeners.

Method details:

public function __construct(\BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper $documentedEntityWrapper);

Parameters:

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

public function getDocumentedEntityWrapper(): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;

Parameters: not specified

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


// Implemented in Symfony\Contracts\EventDispatcher\Event

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

Parameters: not specified

Return value: bool


// 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