This represents the abstract interface for a wt2html parsing pipeline stage Currently there are 4 known pipeline stages:
More...
|
| __construct (Env $env, ?PipelineStage $prevStage=null) |
|
| setPipelineId (int $id) |
|
| getPipelineId () |
|
| getEnv () |
|
| addTransformer (TokenHandler $t) |
| Register a token transformer.
|
|
| resetState (array $options) |
| Resets any internal state for this pipeline stage.
|
|
| setFrame (Frame $frame) |
| Set frame on this pipeline stage.
|
|
| setSourceOffsets (SourceRange $so) |
| Set the source offsets for the content being processing by this pipeline This matters for when a substring of the top-level page is being processed in its own pipeline.
|
|
| process ( $input, ?array $options=null) |
| Process wikitext, an array of tokens, or a DOM document depending on what pipeline stage this is.
|
|
| processChunkily ( $input, ?array $options) |
| Process wikitext, an array of tokens, or a DOM document depending on what pipeline stage this is.
|
|
This represents the abstract interface for a wt2html parsing pipeline stage Currently there are 4 known pipeline stages:
- PEG Tokenizer
- Token Transform Manager
- HTML5 Tree Builder
- DOM Post Processor
The Token Transform Manager could eventually go away and be directly replaced by the very many token transformers that are represented by the abstract TokenHandler class.
Wikimedia\Parsoid\Wt2Html\PipelineStage::processChunkily |
( |
| $input, |
|
|
?array | $options ) |
|
abstract |
Process wikitext, an array of tokens, or a DOM document depending on what pipeline stage this is.
This method will either directly or indirectly implement a generator that parses the input in chunks and yields output in chunks as well.
Implementations that don't consume tokens (ex: Tokenizer, DOMPostProcessor) will provide specialized implementations that handle their input type.
- Parameters
-
string | array | Document | $input | |
?array | $options |
- atTopLevel: (bool) Whether we are processing the top-level document
- sol: (bool) Whether input should be processed in start-of-line context
|
- Returns
- Generator
Reimplemented in Wikimedia\Parsoid\Wt2Html\DOMPostProcessor, and Wikimedia\Parsoid\Wt2Html\PegTokenizer.