Wikibase\Lib\Store\WikiPageItemOrderProvider Class Reference

Base class for ItemOrderProviders, that parse the item order from a wikitext page. More...

Inheritance diagram for Wikibase\Lib\Store\WikiPageItemOrderProvider:

Collaboration diagram for Wikibase\Lib\Store\WikiPageItemOrderProvider:

Public Member Functions
	__construct (WikiPageFactory $wikiPageFactory, Title $pageTitle)
	getItemOrder ()

Protected Member Functions
	getItemOrderWikitext ()
	Get Content of the wiki page.

Private Member Functions
	parseList (string $pageContent)

Private Attributes
	$wikiPageFactory
	$pageTitle

Detailed Description

Base class for ItemOrderProviders, that parse the item order from a wikitext page.

Copyright

GPL-2.0-or-later

Author

Noa Rave

Constructor & Destructor Documentation

__construct()

Wikibase\Lib\Store\WikiPageItemOrderProvider::__construct	(	WikiPageFactory	$wikiPageFactory,
		Title	$pageTitle )

Parameters

WikiPageFactory	$wikiPageFactory
Title	$pageTitle	page name the ordered item list is on

Member Function Documentation

getItemOrder()

Wikibase\Lib\Store\WikiPageItemOrderProvider::getItemOrder

(

)

See also

parent::getItemOrder()

Returns

null|int[] null if page doesn't exist

Exceptions

ItemOrderProviderException

Implements Wikibase\Lib\Store\ItemOrderProvider.

getItemOrderWikitext()

Wikibase\Lib\Store\WikiPageItemOrderProvider::getItemOrderWikitext ( )

protected

Get Content of the wiki page.

Returns

string|null

Exceptions

ItemOrderProviderException

parseList()

Wikibase\Lib\Store\WikiPageItemOrderProvider::parseList ( string $pageContent )

private

Parameters

string

$pageContent

Returns

string[]

Member Data Documentation

$pageTitle

Wikibase\Lib\Store\WikiPageItemOrderProvider::$pageTitle

private

$wikiPageFactory

Wikibase\Lib\Store\WikiPageItemOrderProvider::$wikiPageFactory

private

---

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

• lib/includes/Store/WikiPageItemOrderProvider.php