EntityDocUnifiedPlacePlugin.md

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

---

EntityDocUnifiedPlacePlugin class:

namespace BumbleDocGen\LanguageHandler\Php\Plugin\CorePlugin\EntityDocUnifiedPlace;

final class EntityDocUnifiedPlacePlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface

This plugin changes the algorithm for saving entity documents. The standard system stores each file in a directory next to the file where it was requested. This behavior changes and all documents are saved in a separate directory structure, so they are not duplicated.

Methods:

1. getSubscribedEvents - Returns an array of event names this subscriber wants to listen to.
2. onCreateDocumentedEntityWrapper
3. onGetProjectTemplatesDirs
4. onGetTemplatePathByRelativeDocPath

Constants:

• # ENTITY_DOC_STRUCTURE_DIR_NAME | source code

Method details:

• # getSubscribedEvents | source code

public static function getSubscribedEvents(): array;

Returns an array of event names this subscriber wants to listen to.

Parameters: not specified

Return value: array

---

• # onCreateDocumentedEntityWrapper | source code

public function onCreateDocumentedEntityWrapper(\BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper $event): void;

Parameters:

Name	Type	Description
$event	\BumbleDocGen\Core\Plugin\Event\Renderer\OnCreateDocumentedEntityWrapper	-

Return value: void

---

• # onGetProjectTemplatesDirs | source code

public function onGetProjectTemplatesDirs(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetProjectTemplatesDirs $event): void;

Parameters:

Name	Type	Description
$event	\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetProjectTemplatesDirs	-

Return value: void

---

• # onGetTemplatePathByRelativeDocPath | source code

public function onGetTemplatePathByRelativeDocPath(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath $event): void;

Parameters:

Name	Type	Description
$event	\BumbleDocGen\Core\Plugin\Event\Renderer\OnGetTemplatePathByRelativeDocPath	-

Return value: void

---