Skip to content

LastPageCommitter.md

Latest commit

 

History

History
154 lines (103 loc) · 4.02 KB

LastPageCommitter.md

File metadata and controls

154 lines (103 loc) · 4.02 KB

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

LastPageCommitter class: 

namespace BumbleDocGen\Core\Plugin\CorePlugin\LastPageCommitter;

final class LastPageCommitter implements \BumbleDocGen\Core\Plugin\PluginInterface, \Symfony\Component\EventDispatcher\EventSubscriberInterface
Plugin for adding a block with information about the last commit and date of page update to the generated document

Initialization methods:

  1. __construct

Methods:

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

Method details:

public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $context, \BumbleDocGen\Core\Configuration\Configuration $configuration);

Parameters:

Name Type Description
$context \BumbleDocGen\Core\Renderer\Context\RendererContext -
$configuration \BumbleDocGen\Core\Configuration\Configuration - 
public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\BeforeCreatingDocFile $event): void;

Parameters:

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

Return value: void

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

Parameters: not specified

Return value: array