Parsoid
A bidirectional parser between wikitext and HTML5
Loading...
Searching...
No Matches
Wikimedia\Parsoid\Mocks\MockPageConfig Class Reference
+ Inheritance diagram for Wikimedia\Parsoid\Mocks\MockPageConfig:
+ Collaboration diagram for Wikimedia\Parsoid\Mocks\MockPageConfig:

Public Member Functions

 __construct (SiteConfig $siteConfig, array $opts, ?PageContent $content)
 Construct a mock environment object for use in tests.
 
 getContentModel ()
 Get content model.
Returns
string

 
 getLinkTarget ()
 The page's title, as a LinkTarget.
Returns
LinkTarget

 
 getPageId ()
 The page's ID, if any.
Returns
int 0 if the page doesn't (yet?) 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

 
 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.
 
 getSuppressTOC ()
 Whether to suppress the Table of Contents for this page (a function of content model).
 
 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.
 

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Parsoid\Mocks\MockPageConfig::__construct ( SiteConfig $siteConfig,
array $opts,
?PageContent $content )

Construct a mock environment object for use in tests.

Parameters
SiteConfig$siteConfig
array$opts
?PageContent$content

Member Function Documentation

◆ getContentModel()

Wikimedia\Parsoid\Mocks\MockPageConfig::getContentModel ( )

Get content model.

Returns
string

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getLinkTarget()

Wikimedia\Parsoid\Mocks\MockPageConfig::getLinkTarget ( )

The page's title, as a LinkTarget.

Returns
LinkTarget

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getPageId()

Wikimedia\Parsoid\Mocks\MockPageConfig::getPageId ( )

The page's ID, if any.

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

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getPageLanguageBcp47()

Wikimedia\Parsoid\Mocks\MockPageConfig::getPageLanguageBcp47 ( )

The page's language code.

Returns
Bcp47Code a BCP-47 language code

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getPageLanguageDir()

Wikimedia\Parsoid\Mocks\MockPageConfig::getPageLanguageDir ( )

The page's language direction.

Returns
string 'ltr' or 'rtl'

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getParentRevisionId()

Wikimedia\Parsoid\Mocks\MockPageConfig::getParentRevisionId ( )

The revision's parent ID, if any.

Returns
int|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getRevisionContent()

Wikimedia\Parsoid\Mocks\MockPageConfig::getRevisionContent ( )

The revision's content.

Returns
PageContent|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getRevisionId()

Wikimedia\Parsoid\Mocks\MockPageConfig::getRevisionId ( )

The revision's ID, if any.

Returns
int|null

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getRevisionSha1()

Wikimedia\Parsoid\Mocks\MockPageConfig::getRevisionSha1 ( )

The revision's SHA1 checksum, if any.

Returns
string|null Hex encoded

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getRevisionSize()

Wikimedia\Parsoid\Mocks\MockPageConfig::getRevisionSize ( )

The revision's length, if known.

Returns
int|null Bytes

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.

◆ getRevisionTimestamp()

Wikimedia\Parsoid\Mocks\MockPageConfig::getRevisionTimestamp ( )

The revision's timestamp, if any.

Returns
string|null "YYYYMMDDHHIISS" format

Reimplemented from Wikimedia\Parsoid\Config\PageConfig.


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