Wikimedia\Parsoid\Config\PageConfig Class Reference

Page-level configuration interface for Parsoid. More...

Inheritance diagram for Wikimedia\Parsoid\Config\PageConfig:

Public Member Functions
	__construct ()
	Base constructor.
	getContentModel ()
	Get content model.
	getSuppressTOC ()
	Whether to suppress the Table of Contents for this page (a function of content model).
	getLinkTarget ()
	The page's title, as a LinkTarget.
	getNs ()
	The page's namespace ID.
	getPageId ()
	The page's ID, if any.
	getPageLanguageBcp47 ()
	The page's language code.
	getPageLanguageDir ()
	The page's language direction.
	getRevisionId ()
	The revision's ID, if any.
	getParentRevisionId ()
	The revision's parent ID, if any.
	getRevisionTimestamp ()
	The revision's timestamp, if any.
	getRevisionUser ()
	The revision's author's user name, if any.
	getRevisionUserId ()
	The revision's author's user ID, if any.
	getRevisionSha1 ()
	The revision's SHA1 checksum, if any.
	getRevisionSize ()
	The revision's length, if known.
	getRevisionContent ()
	The revision's content.
	getVariantBcp47 ()
	Get the page's language variant.
	setVariantBcp47 (Bcp47Code $htmlVariant)
	Set the page's language variant.
	getPageMainContent ()
	FIXME: Once we remove the hardcoded slot name here, the name of this method could be updated, if necessary.

Detailed Description

Page-level configuration interface for Parsoid.

Constructor & Destructor Documentation

__construct()

Wikimedia\Parsoid\Config\PageConfig::__construct

(

)

Base constructor.

This constructor is public because it is used to create mock objects in our test suite.

Member Function Documentation

getContentModel()

Wikimedia\Parsoid\Config\PageConfig::getContentModel ( )

abstract

Get content model.

Returns

string

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getLinkTarget()

Wikimedia\Parsoid\Config\PageConfig::getLinkTarget ( )

abstract

The page's title, as a LinkTarget.

Returns

LinkTarget

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getNs()

Wikimedia\Parsoid\Config\PageConfig::getNs

(

)

The page's namespace ID.

Returns

int

Deprecated

Use ::getLinkTarget()->getNamespace() instead

getPageId()

Wikimedia\Parsoid\Config\PageConfig::getPageId ( )

abstract

The page's ID, if any.

Returns

int 0 if the page doesn't (yet?) exist

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getPageLanguageBcp47()

Wikimedia\Parsoid\Config\PageConfig::getPageLanguageBcp47 ( )

abstract

The page's language code.

Returns

Bcp47Code a BCP-47 language code

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getPageLanguageDir()

Wikimedia\Parsoid\Config\PageConfig::getPageLanguageDir ( )

abstract

The page's language direction.

Returns

string 'ltr' or 'rtl'

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getPageMainContent()

Wikimedia\Parsoid\Config\PageConfig::getPageMainContent

(

)

FIXME: Once we remove the hardcoded slot name here, the name of this method could be updated, if necessary.

Shortcut method to get page source

Deprecated

Use $this->topFrame->getSrcText()

Returns

string

getParentRevisionId()

Wikimedia\Parsoid\Config\PageConfig::getParentRevisionId ( )

abstract

The revision's parent ID, if any.

Returns

int|null

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionContent()

Wikimedia\Parsoid\Config\PageConfig::getRevisionContent ( )

abstract

The revision's content.

Returns

PageContent|null

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionId()

Wikimedia\Parsoid\Config\PageConfig::getRevisionId ( )

abstract

The revision's ID, if any.

Returns

int|null

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionSha1()

Wikimedia\Parsoid\Config\PageConfig::getRevisionSha1 ( )

abstract

The revision's SHA1 checksum, if any.

Returns

string|null Hex encoded

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionSize()

Wikimedia\Parsoid\Config\PageConfig::getRevisionSize ( )

abstract

The revision's length, if known.

Returns

int|null Bytes

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionTimestamp()

Wikimedia\Parsoid\Config\PageConfig::getRevisionTimestamp ( )

abstract

The revision's timestamp, if any.

Returns

string|null "YYYYMMDDHHIISS" format

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionUser()

Wikimedia\Parsoid\Config\PageConfig::getRevisionUser ( )

abstract

The revision's author's user name, if any.

Returns

string|null

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getRevisionUserId()

Wikimedia\Parsoid\Config\PageConfig::getRevisionUserId ( )

abstract

The revision's author's user ID, if any.

Returns

int|null 0 if the user is not registered

Reimplemented in Wikimedia\Parsoid\Config\Api\PageConfig, and Wikimedia\Parsoid\Mocks\MockPageConfig.

getSuppressTOC()

Wikimedia\Parsoid\Config\PageConfig::getSuppressTOC

(

)

Whether to suppress the Table of Contents for this page (a function of content model).

Returns

bool

getVariantBcp47()

Wikimedia\Parsoid\Config\PageConfig::getVariantBcp47

(

)

Get the page's language variant.

Returns

?Bcp47Code a BCP-47 language code

setVariantBcp47()

Wikimedia\Parsoid\Config\PageConfig::setVariantBcp47

(

Bcp47Code

$htmlVariant

)

Set the page's language variant.

(Records the fact that conversion has been done in the parser pipeline.)

Parameters

Bcp47Code

$htmlVariant

a BCP-47 language code

---

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

• src/Config/PageConfig.php