StubberPlugin.md

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

---

StubberPlugin class:

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

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

The plugin allows you to automatically provide links to github repositories for documented classes from libraries included in composer

Initialization methods:

1. __construct

Methods:

1. getSubscribedEvents - Returns an array of event names this subscriber wants to listen to.
2. onCheckIsClassEntityCanBeLoad
3. onGettingResourceLink

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\ComposerParser $composerParser);

Parameters:

Name	Type	Description
$composerParser	\BumbleDocGen\LanguageHandler\Php\Parser\ComposerParser	-

---

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

---

• # onCheckIsClassEntityCanBeLoad | source code

public function onCheckIsClassEntityCanBeLoad(\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsClassEntityCanBeLoad $event): void;

Parameters:

Name	Type	Description
$event	\BumbleDocGen\LanguageHandler\Php\Plugin\Event\Entity\OnCheckIsClassEntityCanBeLoad	-

Return value: void

Throws:

• \Exception

---

• # onGettingResourceLink | source code

public function onGettingResourceLink(\BumbleDocGen\Core\Plugin\Event\Renderer\OnGettingResourceLink $event): void;

Parameters:

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

Return value: void

Throws:

• \Exception

---