Skip to content

PhpDocumentorStubberPlugin.md

Latest commit

 

History

History
146 lines (96 loc) · 4.04 KB

PhpDocumentorStubberPlugin.md

File metadata and controls

146 lines (96 loc) · 4.04 KB

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

PhpDocumentorStubberPlugin class: 

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

final class PhpDocumentorStubberPlugin implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
Adding links to the documentation of PHP classes in the \phpDocumentor namespace

Methods:

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

Method details:

public static function getSubscribedEvents(): array;
Returns an array of event names this subscriber wants to listen to.

Parameters: not specified

Return value: array

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

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