OnLoadEntityDocPluginContent.md

BumbleDocGen / Technical description of the project / Plugin system / OnLoadEntityDocPluginContent

---

OnLoadEntityDocPluginContent class:

namespace BumbleDocGen\Core\Plugin\Event\Renderer;

final class OnLoadEntityDocPluginContent extends \Symfony\Contracts\EventDispatcher\Event

Called when entity documentation is generated (plugin content loading)

See:

• \BumbleDocGen\Core\Renderer\Twig\Function\LoadPluginsContent

Initialization methods:

1. __construct

Methods:

1. addBlockContentPluginResult
2. getBlockContent
3. getBlockContentPluginResults
4. getBlockType
5. getEntity
6. isPropagationStopped - Is propagation stopped?
7. stopPropagation - Stops the propagation of the event to further event listeners.

Method details:

• # __construct | source code

public function __construct(string $blockContent, \BumbleDocGen\Core\Parser\Entity\RootEntityInterface $entity, string $blockType);

Parameters:

Name	Type	Description
$blockContent	string	-
$entity	\BumbleDocGen\Core\Parser\Entity\RootEntityInterface	-
$blockType	string	-

---

• # addBlockContentPluginResult | source code

public function addBlockContentPluginResult(string $pluginResult): void;

Parameters:

Name	Type	Description
$pluginResult	string	-

Return value: void

---

• # getBlockContent | source code

public function getBlockContent(): string;

Parameters: not specified

Return value: string

---

• # getBlockContentPluginResults | source code

public function getBlockContentPluginResults(): array;

Parameters: not specified

Return value: array

---

• # getBlockType | source code

public function getBlockType(): string;

Parameters: not specified

Return value: string

---

• # getEntity | source code

public function getEntity(): \BumbleDocGen\Core\Parser\Entity\RootEntityInterface;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityInterface

---

• # isPropagationStopped | source code

// Implemented in Symfony\Contracts\EventDispatcher\Event

public function isPropagationStopped(): bool;

Is propagation stopped?

Parameters: not specified

Return value: bool

---

• # stopPropagation | source code

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

---