Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer Class Reference

MediaWiki-compatible italic/bold handling as a token stream transformation. More...

Inheritance diagram for Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer:

Collaboration diagram for Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer:

Public Member Functions
	__construct (TokenTransformManager $manager, array $options)
	onTag (Token $token)
	Handles mw-quote tokens and td/th tokens This handler is called for tokens that are not EOFTk or NLTk tokens.The handler may choose to process only specific kinds of tokens. For example, a list handler may only process 'listitem' TagTk tokens. Parameters Token $token Token to be processed Returns TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged. .
	onNewline (NlTk $token)
	On encountering a NlTk, processes quotes on the current line This handler is called for newline tokens only. Parameters NlTk $token Newline token to be processed Returns TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged. .
	onEnd (EOFTk $token)
	On encountering an EOFTk, processes quotes on the current line This handler is called for EOF tokens only. Parameters EOFTk $token EOF token to be processed Returns TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged. .
	onAny ( $token)
	This handler is called for all tokens in the token stream except if (a) The more specific handlers above modified the token (b) the more specific handlers (onTag, onEnd, onNewline) have set the skip flag in their return values.(c) this handlers 'active' flag is set to false (can be set by any of the handlers). Parameters Token | string $token Token to be processed Returns TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged.
Public Member Functions inherited from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler
	setPipelineId (int $id)
	resetState (array $options)
	Resets any internal state for this token handler.
	isDisabled ()
	Is this transformer disabled?
	process ( $tokens)
	Push an input array of tokens through the transformer and return the transformed tokens.

Additional Inherited Members
Protected Attributes inherited from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler
	$env
	$manager
	$pipelineId
	$options
bool	$disabled = false
	This is set if the token handler is disabled for the entire pipeline.
bool	$onAnyEnabled = true
	This is set/reset by the token handlers at various points in the token stream based on what is encountered.
	$atTopLevel = false

Detailed Description

MediaWiki-compatible italic/bold handling as a token stream transformation.

Constructor & Destructor Documentation

__construct()

Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer::__construct	(	TokenTransformManager	$manager,
		array	$options )

Parameters

TokenTransformManager	$manager	manager environment
array	$options	options

Reimplemented from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler.

Member Function Documentation

onAny()

Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer::onAny

(

$token

)

This handler is called for all tokens in the token stream except if (a) The more specific handlers above modified the token (b) the more specific handlers (onTag, onEnd, onNewline) have set the skip flag in their return values.(c) this handlers 'active' flag is set to false (can be set by any of the handlers).

Parameters

Token | string

$token

Token to be processed

Returns

TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged.

Reimplemented from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler.

onEnd()

Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer::onEnd

(

EOFTk

$token

)

On encountering an EOFTk, processes quotes on the current line This handler is called for EOF tokens only.

Parameters

EOFTk

$token

EOF token to be processed

Returns

TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged.

.

Reimplemented from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler.

onNewline()

Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer::onNewline

(

NlTk

$token

)

On encountering a NlTk, processes quotes on the current line This handler is called for newline tokens only.

Parameters

NlTk

$token

Newline token to be processed

Returns

TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged.

.

Reimplemented from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler.

onTag()

Wikimedia\Parsoid\Wt2Html\TT\QuoteTransformer::onTag

(

Token

$token

)

Handles mw-quote tokens and td/th tokens This handler is called for tokens that are not EOFTk or NLTk tokens.The handler may choose to process only specific kinds of tokens. For example, a list handler may only process 'listitem' TagTk tokens.

Parameters

Token

$token

Token to be processed

Returns

TokenHandlerResult|null A TokenHandlerResult, or null to efficiently indicate that the input token is unchanged.

.

Reimplemented from Wikimedia\Parsoid\Wt2Html\TT\TokenHandler.

---

The documentation for this class was generated from the following file:

• src/Wt2Html/TT/QuoteTransformer.php