Minimal implementation of a ContentMetadataCollector which just records all metadata in an array. More...

Inheritance diagram for Wikimedia\Parsoid\Config\StubMetadataCollector:

Collaboration diagram for Wikimedia\Parsoid\Config\StubMetadataCollector:

Public Member Functions

__construct (?LoggerInterface $logger=null)

addCategory ( $c, $sort='')

Add a category, with the given sort key.

Note: Note that titles frequently get stored as array keys, and when that happens in PHP, array_keys() will recover strings like '0' as integers (instead of strings). To avoid corner case bugs, we allow both integers and strings as titles (and sort keys).; In the future, we might consider accepting a LinkTarget (or similar proxy) for $c instead of a string.

Parameters

string \| int	$c	Category name
string \| int	$sort	Sort key (pass the empty string to use the default)

addWarningMsg (string $msg,... $args)

Add a warning to the output for this page.

Parameters

string	$msg	The localization message key for the warning
	mixed	...$args Optional arguments for the message

addExternalLink (string $url)

Parameters

string $url External link URL

setOutputFlag (string $name, bool $value=true)

Provides a uniform interface to various boolean flags stored in the content metadata.Flags internal to MediaWiki core should have names which are constants in ParserOutputFlags. Extensions should use setExtensionData() rather than creating new flags with setOutputFlag() in order to prevent namespace conflicts.

Parameters

string	$name	A flag name
bool	$val

setPageProperty (string $name, $value)

Set a property to be stored in the page_props database table.page_props is a key value store indexed by the page ID. This allows the parser to set a property on a page which can then be quickly retrieved given the page ID or via a DB join when given the page title.page_props is also indexed by numeric value, to allow for efficient "top k" queries of pages wrt a given property.setPageProperty() is thus used to propagate properties from the parsed page to request contexts other than a page view of the currently parsed article.Some applications examples:

To implement hidden categories, hiding pages from category listings by storing a property.

setExtensionData (string $key, $value)

Attaches arbitrary data to this content.This can be used to store some information for later use during page output. The data will be cached along with the parsed page, but unlike data set using setPageProperty(), it is not recorded in the database.To use setExtensionData() to pass extension information from a hook inside the parser to a hook in the page output, use this in the parser hook:

Example:: $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );

And then later, in OutputPageParserOutput or similar:

Example:: $output->getExtensionData( 'my_ext_foo' );

Note: Only scalar values, e.g. numbers, strings, arrays or MediaWiki\Json\JsonUnserializable instances are supported as a value. Attempt to set other class instance as a extension data will break ParserCache for the page.; As with setJsConfigVar(), setting a page property to multiple conflicting values during the parse is not supported.

Parameters

string	$key	The key for accessing the data. Extensions should take care to avoid conflicts in naming keys. It is suggested to use the extension's name as a prefix. Keys beginning with `mw-` are reserved for use by mediawiki core.
mixed	$value	The value to set. Setting a value to null is equivalent to removing the value.

setJsConfigVar (string $key, $value)

Add a variable to be set in mw.config in JavaScript.In order to ensure the result is independent of the parse order, the values set here must be unique – that is, you can pass the same $key multiple times but ONLY if the $value is identical each time. If you want to collect multiple pieces of data under a single key, use appendJsConfigVar().

Parameters

string	$key	Key to use under mw.config
mixed \| null	$value	Value of the configuration variable.

appendExtensionData (string $key, $value, string $strategy=self::MERGE_STRATEGY_UNION)

Appends arbitrary data to this ParserObject.This can be used to store some information in the ParserOutput object for later use during page output. The data will be cached along with the ParserOutput object, but unlike data set using setPageProperty(), it is not recorded in the database.See setExtensionData() for more details on rationale and use.In order to provide for out-of-order/asynchronous/incremental parsing, this method appends values to a set. See setExtensionData() for the flag-like version of this method.

Note: Only values which can be array keys are currently supported as values. Be aware that array keys which 'look like' numbers are converted to ints by PHP, and so if you put in "0" as a value you will get [0=>true] out.

Parameters

string	$key	The key for accessing the data. Extensions should take care to avoid conflicts in naming keys. It is suggested to use the extension's name as a prefix.
int \| string	$value	The value to append to the list.
string	$strategy	Merge strategy: only MW_MERGE_STRATEGY_UNION is currently supported and external callers should treat this parameter as

appendJsConfigVar (string $key, string $value, string $strategy=self::MERGE_STRATEGY_UNION)

Append a value to a variable to be set in mw.config in JavaScript.In order to ensure the result is independent of the parse order, the value of this key will be an associative array, mapping all of the values set under that key to true. (The array is implicitly ordered in PHP, but you should treat it as unordered.) If you want a non-array type for the key, and can ensure that only a single value will be set, you should use setJsConfigVar() instead.

Note: Only values which can be array keys are currently supported as values. Be aware that array keys which 'look like' numbers are converted to ints by PHP, and so if you put in "0" as a value you will get [0=>true] out.

Parameters

string	$key	Key to use under mw.config
string	$value	Value to append to the configuration variable.
string	$strategy	Merge strategy: only MW_MERGE_STRATEGY_UNION is currently supported and external callers should treat this parameter as

addModules (array $modules)

See also: OutputPage::addModules

Parameters

string[] $modules

addModuleStyles (array $moduleStyles)

See also: OutputPage::addModuleStyles

Parameters

string[] $modules

setLimitReportData (string $key, $value)

Sets parser limit report data for a key.The key is used as the prefix for various messages used for formatting:

$key: The label for the field in the limit report
$key-value-text: Message used to format the value in the "NewPP limit report" HTML comment. If missing, uses $key-format.
$key-value-html: Message used to format the value in the preview limit report table. If missing, uses $key-format.
$key-value: Message used to format the value. If missing, uses "$1".

Note that all values are interpreted as wikitext, and so should be encoded with htmlspecialchars() as necessary, but should avoid complex HTML for sanity of display in the "NewPP limit report" comment.

Parameters

string	$key	Message key
mixed	$value	Appropriate for Message::params()

setTOCData (TOCData $tocData)

Sets Table of Contents data for this page.Note that merging of TOCData is not supported; exactly one fragment should set TOCData.

Parameters

TOCData $tocData

getModules ()

getModuleStyles ()

getJsConfigVars ()

getCategories ()

getPageProperty (string $name)

getExtensionData (string $key)

Return the collected extension data under the given key.

getOutputFlags ()

Return the active output flags.

getTOCData ()

Return the collected TOC data, or null if no TOC data was collected.

Additional Inherited Members
Public Attributes inherited from Wikimedia\Parsoid\Core\ContentMetadataCollector
const	MERGE_STRATEGY_UNION = 'union'
	Merge strategy to use for ContentMetadataCollector accumulators: "union" means that values are strings, stored as a set, and exposed as a PHP associative array mapping from values to `true`.

Detailed Description

Minimal implementation of a ContentMetadataCollector which just records all metadata in an array.

Used for testing or operation in API mode.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Parsoid\Config\StubMetadataCollector::__construct ( ?LoggerInterface $logger = null )

Parameters

?LoggerInterface $logger Optional logger to log warnings for unsafe metadata updates

Member Function Documentation

◆ addCategory()

Wikimedia\Parsoid\Config\StubMetadataCollector::addCategory	(		$c,
			$sort = '' )

Add a category, with the given sort key.

Note: Note that titles frequently get stored as array keys, and when that happens in PHP, array_keys() will recover strings like '0' as integers (instead of strings). To avoid corner case bugs, we allow both integers and strings as titles (and sort keys).; In the future, we might consider accepting a LinkTarget (or similar proxy) for $c instead of a string.

Parameters

string \| int	$c	Category name
string \| int	$sort	Sort key (pass the empty string to use the default)

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ addExternalLink()

Wikimedia\Parsoid\Config\StubMetadataCollector::addExternalLink ( string $url )

Parameters

string $url External link URL

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ addModules()

Wikimedia\Parsoid\Config\StubMetadataCollector::addModules ( array $modules )

See also: OutputPage::addModules

Parameters

string[] $modules

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ addModuleStyles()

Wikimedia\Parsoid\Config\StubMetadataCollector::addModuleStyles ( array $moduleStyles )

See also: OutputPage::addModuleStyles

Parameters

string[] $modules

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ addWarningMsg()

Wikimedia\Parsoid\Config\StubMetadataCollector::addWarningMsg	(	string	$msg,
			$args )

Add a warning to the output for this page.

Parameters

string	$msg	The localization message key for the warning
	mixed	...$args Optional arguments for the message

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ appendExtensionData()

Wikimedia\Parsoid\Config\StubMetadataCollector::appendExtensionData	(	string	$key,
			$value,
		string	$strategy = self::MERGE_STRATEGY_UNION )

Appends arbitrary data to this ParserObject.This can be used to store some information in the ParserOutput object for later use during page output. The data will be cached along with the ParserOutput object, but unlike data set using setPageProperty(), it is not recorded in the database.See setExtensionData() for more details on rationale and use.In order to provide for out-of-order/asynchronous/incremental parsing, this method appends values to a set. See setExtensionData() for the flag-like version of this method.

Note: Only values which can be array keys are currently supported as values. Be aware that array keys which 'look like' numbers are converted to ints by PHP, and so if you put in "0" as a value you will get [0=>true] out.

Parameters

string	$key	The key for accessing the data. Extensions should take care to avoid conflicts in naming keys. It is suggested to use the extension's name as a prefix.
int \| string	$value	The value to append to the list.
string	$strategy	Merge strategy: only MW_MERGE_STRATEGY_UNION is currently supported and external callers should treat this parameter as

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ appendJsConfigVar()

Wikimedia\Parsoid\Config\StubMetadataCollector::appendJsConfigVar	(	string	$key,
		string	$value,
		string	$strategy = self::MERGE_STRATEGY_UNION )

Append a value to a variable to be set in mw.config in JavaScript.In order to ensure the result is independent of the parse order, the value of this key will be an associative array, mapping all of the values set under that key to true. (The array is implicitly ordered in PHP, but you should treat it as unordered.) If you want a non-array type for the key, and can ensure that only a single value will be set, you should use setJsConfigVar() instead.

Note: Only values which can be array keys are currently supported as values. Be aware that array keys which 'look like' numbers are converted to ints by PHP, and so if you put in "0" as a value you will get [0=>true] out.

Parameters

string	$key	Key to use under mw.config
string	$value	Value to append to the configuration variable.
string	$strategy	Merge strategy: only MW_MERGE_STRATEGY_UNION is currently supported and external callers should treat this parameter as

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ getCategories()

Wikimedia\Parsoid\Config\StubMetadataCollector::getCategories ( )

Returns: array<string,string>

◆ getExtensionData()

Wikimedia\Parsoid\Config\StubMetadataCollector::getExtensionData ( string $key )

Return the collected extension data under the given key.

Parameters

string $key

Returns: mixed|null

◆ getJsConfigVars()

Wikimedia\Parsoid\Config\StubMetadataCollector::getJsConfigVars ( )

Returns: string[]

◆ getModules()

Wikimedia\Parsoid\Config\StubMetadataCollector::getModules ( )

Returns: string[]

◆ getModuleStyles()

Wikimedia\Parsoid\Config\StubMetadataCollector::getModuleStyles ( )

Returns: string[]

◆ getOutputFlags()

Wikimedia\Parsoid\Config\StubMetadataCollector::getOutputFlags ( )

Return the active output flags.

Returns: string[]

◆ getPageProperty()

Wikimedia\Parsoid\Config\StubMetadataCollector::getPageProperty ( string $name )

Parameters

string $name

Returns: ?string

◆ getTOCData()

Wikimedia\Parsoid\Config\StubMetadataCollector::getTOCData ( )

Return the collected TOC data, or null if no TOC data was collected.

Returns: ?TOCData

◆ setExtensionData()

Wikimedia\Parsoid\Config\StubMetadataCollector::setExtensionData	(	string	$key,
			$value )

Attaches arbitrary data to this content.This can be used to store some information for later use during page output. The data will be cached along with the parsed page, but unlike data set using setPageProperty(), it is not recorded in the database.To use setExtensionData() to pass extension information from a hook inside the parser to a hook in the page output, use this in the parser hook:

Example:: $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );

And then later, in OutputPageParserOutput or similar:

Example:: $output->getExtensionData( 'my_ext_foo' );

Note: Only scalar values, e.g. numbers, strings, arrays or MediaWiki\Json\JsonUnserializable instances are supported as a value. Attempt to set other class instance as a extension data will break ParserCache for the page.; As with setJsConfigVar(), setting a page property to multiple conflicting values during the parse is not supported.

Parameters

string	$key	The key for accessing the data. Extensions should take care to avoid conflicts in naming keys. It is suggested to use the extension's name as a prefix. Keys beginning with `mw-` are reserved for use by mediawiki core.
mixed	$value	The value to set. Setting a value to null is equivalent to removing the value.

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ setJsConfigVar()

Wikimedia\Parsoid\Config\StubMetadataCollector::setJsConfigVar	(	string	$key,
			$value )

Add a variable to be set in mw.config in JavaScript.In order to ensure the result is independent of the parse order, the values set here must be unique – that is, you can pass the same $key multiple times but ONLY if the $value is identical each time. If you want to collect multiple pieces of data under a single key, use appendJsConfigVar().

Parameters

string	$key	Key to use under mw.config
mixed \| null	$value	Value of the configuration variable.

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ setLimitReportData()

Wikimedia\Parsoid\Config\StubMetadataCollector::setLimitReportData	(	string	$key,
			$value )

Sets parser limit report data for a key.The key is used as the prefix for various messages used for formatting:

$key: The label for the field in the limit report
$key-value-text: Message used to format the value in the "NewPP limit report" HTML comment. If missing, uses $key-format.
$key-value-html: Message used to format the value in the preview limit report table. If missing, uses $key-format.
$key-value: Message used to format the value. If missing, uses "$1".

Note that all values are interpreted as wikitext, and so should be encoded with htmlspecialchars() as necessary, but should avoid complex HTML for sanity of display in the "NewPP limit report" comment.

Parameters

string	$key	Message key
mixed	$value	Appropriate for Message::params()

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ setOutputFlag()

Wikimedia\Parsoid\Config\StubMetadataCollector::setOutputFlag	(	string	$name,
		bool	$value = true )

Provides a uniform interface to various boolean flags stored in the content metadata.Flags internal to MediaWiki core should have names which are constants in ParserOutputFlags. Extensions should use setExtensionData() rather than creating new flags with setOutputFlag() in order to prevent namespace conflicts.

Parameters

string	$name	A flag name
bool	$val

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ setPageProperty()

Wikimedia\Parsoid\Config\StubMetadataCollector::setPageProperty	(	string	$name,
			$value )

Set a property to be stored in the page_props database table.page_props is a key value store indexed by the page ID. This allows the parser to set a property on a page which can then be quickly retrieved given the page ID or via a DB join when given the page title.page_props is also indexed by numeric value, to allow for efficient "top k" queries of pages wrt a given property.setPageProperty() is thus used to propagate properties from the parsed page to request contexts other than a page view of the currently parsed article.Some applications examples:

To implement hidden categories, hiding pages from category listings by storing a property.

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

◆ setTOCData()

Wikimedia\Parsoid\Config\StubMetadataCollector::setTOCData ( TOCData $tocData )

Sets Table of Contents data for this page.Note that merging of TOCData is not supported; exactly one fragment should set TOCData.

Parameters

TOCData $tocData

Implements Wikimedia\Parsoid\Core\ContentMetadataCollector.

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

src/Config/StubMetadataCollector.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCategory()

◆ addExternalLink()

◆ addModules()

◆ addModuleStyles()

◆ addWarningMsg()

◆ appendExtensionData()

◆ appendJsConfigVar()

◆ getCategories()

◆ getExtensionData()

◆ getJsConfigVars()

◆ getModules()

◆ getModuleStyles()

◆ getOutputFlags()

◆ getPageProperty()

◆ getTOCData()

◆ setExtensionData()

◆ setJsConfigVar()

◆ setLimitReportData()

◆ setOutputFlag()

◆ setPageProperty()

◆ setTOCData()