DocumentPreParsedEvent
extends AbstractEvent
in package
Event dispatched when the document is about to be parsed
Table of Contents
- $document : Document
- $markdown : MarkdownInputInterface
- $propagationStopped : bool
- __construct() : mixed
- getDocument() : Document
- getMarkdown() : MarkdownInputInterface
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- replaceMarkdown() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$document
private
Document
$document
$markdown
private
MarkdownInputInterface
$markdown
$propagationStopped
private
bool
$propagationStopped
= false
Methods
__construct()
public
__construct(Document $document, MarkdownInputInterface $markdown) : mixed
Parameters
- $document : Document
- $markdown : MarkdownInputInterface
Return values
mixed —getDocument()
public
getDocument() : Document
Return values
Document —getMarkdown()
public
getMarkdown() : MarkdownInputInterface
Return values
MarkdownInputInterface —isPropagationStopped()
Returns whether further event listeners should be triggered.
public
final isPropagationStopped() : bool
Return values
bool —replaceMarkdown()
public
replaceMarkdown(MarkdownInputInterface $markdownInput) : void
Parameters
- $markdownInput : MarkdownInputInterface
Return values
void —stopPropagation()
Stops the propagation of the event to further event listeners.
public
final stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().