Wikimedia\Parsoid\Config\Api\PageConfig Class Reference

PageConfig via MediaWiki's Action API. More...

Inheritance diagram for Wikimedia\Parsoid\Config\Api\PageConfig:

Collaboration diagram for Wikimedia\Parsoid\Config\Api\PageConfig:

Public Member Functions
	__construct (?ApiHelper $api, array $opts)
	getContentModel ()
	Get content model. Returns string
	hasLintableContentModel ()
	Whether the page has a lintable content model.
	getTitle ()
	The page's title, as a string. Returns string With namespace, spaces not underscores
	getNs ()
	The page's namespace ID. Returns int
	getPageId ()
	The page's ID, if any. Returns int 0 if the page doesn't exist
	getPageLanguageBcp47 ()
	The page's language code. Returns Bcp47Code a BCP-47 language code
	getPageLanguageDir ()
	The page's language direction. Returns string 'ltr' or 'rtl'
	getRevisionId ()
	The revision's ID, if any. Returns int|null
	getParentRevisionId ()
	The revision's parent ID, if any. Returns int|null
	getRevisionTimestamp ()
	The revision's timestamp, if any. Returns string|null "YYYYMMDDHHIISS" format
	getRevisionUser ()
	The revision's author's user name, if any. Returns string|null
	getRevisionUserId ()
	The revision's author's user ID, if any. Returns int|null 0 if the user is not registered
	getRevisionSha1 ()
	The revision's SHA1 checksum, if any. Returns string|null Hex encoded
	getRevisionSize ()
	The revision's length, if known. Returns int|null Bytes
	getRevisionContent ()
	The revision's content. Returns PageContent|null
Public Member Functions inherited from Wikimedia\Parsoid\Config\PageConfig
	__construct ()
	Base constructor.
	getPageLanguage ()
	The page's language code.
	getVariant ()
	Get the page's language variant This is a mediawiki-internal language code, not a BCP-47 code.
	getVariantBcp47 ()
	Get the page's language variant.
	setVariant ( $htmlVariant)
	Set 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.

Static Public Member Functions
static	fromSettings (array $parsoidSettings, array $opts)

Detailed Description

PageConfig via MediaWiki's Action API.

Note this is intended for testing, not performance.

Constructor & Destructor Documentation

__construct()

Wikimedia\Parsoid\Config\Api\PageConfig::__construct	(	?ApiHelper	$api,
		array	$opts )

Parameters

?ApiHelper	$api	(only needed if $opts doesn't provide page info)
array	$opts

Member Function Documentation

fromSettings()

static Wikimedia\Parsoid\Config\Api\PageConfig::fromSettings ( array $parsoidSettings, array $opts )

static

Parameters

array	$parsoidSettings
array	$opts

Returns

PageConfig

getContentModel()

Wikimedia\Parsoid\Config\Api\PageConfig::getContentModel

(

)

Get content model.

Returns

string

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getNs()

Wikimedia\Parsoid\Config\Api\PageConfig::getNs

(

)

The page's namespace ID.

Returns

int

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getPageId()

Wikimedia\Parsoid\Config\Api\PageConfig::getPageId

(

)

The page's ID, if any.

Returns

int 0 if the page doesn't exist

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getPageLanguageBcp47()

Wikimedia\Parsoid\Config\Api\PageConfig::getPageLanguageBcp47

(

)

The page's language code.

Returns

Bcp47Code a BCP-47 language code

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getPageLanguageDir()

Wikimedia\Parsoid\Config\Api\PageConfig::getPageLanguageDir

(

)

The page's language direction.

Returns

string 'ltr' or 'rtl'

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getParentRevisionId()

Wikimedia\Parsoid\Config\Api\PageConfig::getParentRevisionId

(

)

The revision's parent ID, if any.

Returns

int|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionContent()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionContent

(

)

The revision's content.

Returns

PageContent|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionId()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionId

(

)

The revision's ID, if any.

Returns

int|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionSha1()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionSha1

(

)

The revision's SHA1 checksum, if any.

Returns

string|null Hex encoded

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionSize()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionSize

(

)

The revision's length, if known.

Returns

int|null Bytes

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionTimestamp()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionTimestamp

(

)

The revision's timestamp, if any.

Returns

string|null "YYYYMMDDHHIISS" format

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionUser()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionUser

(

)

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

Returns

string|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getRevisionUserId()

Wikimedia\Parsoid\Config\Api\PageConfig::getRevisionUserId

(

)

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

Returns

int|null 0 if the user is not registered

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

getTitle()

Wikimedia\Parsoid\Config\Api\PageConfig::getTitle

(

)

The page's title, as a string.

Returns

string With namespace, spaces not underscores

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

hasLintableContentModel()

Wikimedia\Parsoid\Config\Api\PageConfig::hasLintableContentModel

(

)

Whether the page has a lintable content model.

Returns

bool

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

---

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

• src/Config/Api/PageConfig.php