Wikibase\Lib\Store\PropertyOrderProvider Interface Reference

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

Inheritance diagram for Wikibase\Lib\Store\PropertyOrderProvider:

Public Member Functions
	getPropertyOrder ()
	Get order of properties in the form [ $propertyIdSerialization => $ordinalNumber ].

Detailed Description

Interface that contains method for the PropertyOrderProvider.

Copyright

GPL-2.0-or-later

Author

Lucie-Aimée Kaffee

Member Function Documentation

getPropertyOrder()

Wikibase\Lib\Store\PropertyOrderProvider::getPropertyOrder

(

)

Get order of properties in the form [ $propertyIdSerialization => $ordinalNumber ].

Returns

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

Exceptions

PropertyOrderProviderException

Implemented in Wikibase\Lib\Store\CachingPropertyOrderProvider, Wikibase\Lib\Store\FallbackPropertyOrderProvider, and Wikibase\Lib\Store\WikiTextPropertyOrderProvider.

---

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

• lib/includes/Store/PropertyOrderProvider.php