OnAddClassEntityToCollection.md

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

---

OnAddClassEntityToCollection class:

namespace BumbleDocGen\LanguageHandler\Php\Plugin\Event\Parser;

final class OnAddClassEntityToCollection extends \Symfony\Contracts\EventDispatcher\Event implements \BumbleDocGen\Core\Plugin\OnlySingleExecutionEvent

Called when each class entity is added to the entity collection

Initialization methods:

1. __construct

Methods:

1. getClassEntityCollection
2. getRootEntity
3. getUniqueExecutionId
4. isPropagationStopped - Is propagation stopped?
5. stopPropagation - Stops the propagation of the event to further event listeners.

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection $classEntityCollection);

Parameters:

Name	Type	Description
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$classEntityCollection	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection	-

---

• # getClassEntityCollection | source code

public function getClassEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection;

Parameters: not specified

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection

---

• # getRootEntity | source code

public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity;

Parameters: not specified

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity

---

• # getUniqueExecutionId | source code

public function getUniqueExecutionId(): string;

Parameters: not specified

Return value: string

---

• # 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

---