BumbleDocGen / Technical description of the project / Plugin system / BeforeCreatingDocFile
BeforeCreatingDocFile class:
namespace BumbleDocGen\Core\Plugin\Event\Renderer;
final class BeforeCreatingDocFile extends \Symfony\Contracts\EventDispatcher\EventCalled before the content of the documentation document is saved to a file
- getContent
- getContext
- isPropagationStopped - Is propagation stopped?
- setContent
- stopPropagation - Stops the propagation of the event to further event listeners.
- # __construct | source code
public function __construct(string $content, \BumbleDocGen\Core\Renderer\Context\RendererContext $context);Parameters:
| Name | Type | Description |
|---|---|---|
| $content | string | - |
| $context | \BumbleDocGen\Core\Renderer\Context\RendererContext | - |
- # getContent | source code
public function getContent(): string;Parameters: not specified
Return value: string
- # getContext | source code
public function getContext(): \BumbleDocGen\Core\Renderer\Context\RendererContext;Parameters: not specified
Return value: \BumbleDocGen\Core\Renderer\Context\RendererContext
- # isPropagationStopped | source code
// Implemented in Symfony\Contracts\EventDispatcher\Event
public function isPropagationStopped(): bool;Is propagation stopped?
Parameters: not specified
Return value: bool
- # setContent | source code
public function setContent(string $content): void;Parameters:
| Name | Type | Description |
|---|---|---|
| $content | string | - |
Return value: void
- # stopPropagation | source code
// 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