Wikibase\Lib\Store\ItemOrderProvider Interface Reference

Interface that contains method for the ItemOrderProvider. More...

Inheritance diagram for Wikibase\Lib\Store\ItemOrderProvider:

Public Member Functions
	getItemOrder ()
	Get order of items in the form [ $ItemIdSerialization => $ordinalNumber ]. More...

Detailed Description

Interface that contains method for the ItemOrderProvider.

Copyright

GPL-2.0-or-later

Author

Noa Rave

Member Function Documentation

getItemOrder()

Wikibase\Lib\Store\ItemOrderProvider::getItemOrder

(

)

Get order of items in the form [ $ItemIdSerialization => $ordinalNumber ].

Returns

null|int[] An associative array mapping Item ID strings to ordinal numbers. The order of items is represented by the ordinal numbers associated with them. The array is not guaranteed to be sorted. Null if no information exists.

Exceptions

ItemOrderProviderException

Implemented in Wikibase\Lib\Store\WikiPageItemOrderProvider, and Wikibase\Lib\Store\CachingItemOrderProvider.

---

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

• lib/includes/Store/ItemOrderProvider.php