Skip to content

Latest commit

 

History

History
225 lines (149 loc) · 5.21 KB

File metadata and controls

225 lines (149 loc) · 5.21 KB

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


namespace BumbleDocGen\Core\Plugin\Event\Renderer;

final class OnGettingResourceLink extends \Symfony\Contracts\EventDispatcher\Event
Event occurs when a reference to an entity (resource) is received

Initialization methods:

  1. __construct

Methods:

  1. getResourceName
  2. getResourceUrl
  3. isPropagationStopped - Is propagation stopped?
  4. setResourceUrl
  5. stopPropagation - Stops the propagation of the event to further event listeners.

Method details:

public function __construct(string $resourceName);

Parameters:

Name Type Description
$resourceName string -

public function getResourceName(): string;

Parameters: not specified

Return value: string


public function getResourceUrl(): string|null;

Parameters: not specified

Return value: string | null


// Implemented in Symfony\Contracts\EventDispatcher\Event

public function isPropagationStopped(): bool;
Is propagation stopped?

Parameters: not specified

Return value: bool


public function setResourceUrl(string|null $resourceUrl): void;

Parameters:

Name Type Description
$resourceUrl string | null -

Return value: void


// 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