SMW\PropertiesQueryPage Class Reference

Inheritance diagram for SMW\PropertiesQueryPage:

Collaboration diagram for SMW\PropertiesQueryPage:

Public Member Functions
	__construct (Store $store, Settings $settings)
	getCacheInfo ()
	getPageHeader ()
	getName ()
	formatResult ( $skin, $result)
	getResults ( $requestOptions)
Public Member Functions inherited from SMW\QueryPage
	getResults ( $requestoptions)
	recache ( $limit, $ignoreErrors=true)
	isExpensive ()
	isSyndicated ()
	linkParameters ()
	getMessageFormatter ()
	getLinker ()
	getSearchForm ( $property='', $cacheDate='', $propertySearch=true, $filter='')
	doQuery ( $offset=false, $limit=false, $property=false)

Protected Member Functions
	formatPropertyItem (DIProperty $property, $useCount)

Protected Attributes
	$store
	$settings
Protected Attributes inherited from SMW\QueryPage
	$msgFormatter
	$linker = null
	$selectOptions = []
	$useSerchForm = false

Detailed Description

Query class that provides content for the Special:Properties page

GNU GPL v2+

Since

1.9

Author

Markus Krötzsch

mwjames

Constructor & Destructor Documentation

__construct()

SMW\PropertiesQueryPage::__construct	(	Store	$store,
		Settings	$settings
	)

Since

1.9

Parameters

Store	$store
Settings	$settings

Member Function Documentation

formatPropertyItem()

SMW\PropertiesQueryPage::formatPropertyItem ( DIProperty  $property,   $useCount  )

protected

Produce a formatted string representation for showing a property and its usage count in the list of used properties.

Since

1.8

Parameters

DIProperty	$property
integer	$useCount

Returns

string

formatResult()

SMW\PropertiesQueryPage::formatResult	(		$skin,
			$result
	)

Format a result in the list of results as a string. We expect the result to be an array with one object of type SMWDIProperty (normally) or maybe SMWDIError (if something went wrong), followed by a number (how often the property is used).

Parameters

Skin	$skin	provided by MediaWiki, not needed here
mixed	$result

Returns

String

Exceptions

PropertyNotFoundException

if the result was not of a supported type

getCacheInfo()

SMW\PropertiesQueryPage::getCacheInfo

(

)

Returns available cache information (takes into account user preferences)

Since

1.9

Returns

string

getName()

SMW\PropertiesQueryPage::getName

(

)

Returns

string

getPageHeader()

SMW\PropertiesQueryPage::getPageHeader

(

)

Returns

string

getResults()

SMW\PropertiesQueryPage::getResults

(

$requestOptions

)

Get the list of results.

Parameters

SMWRequestOptions

$requestOptions

Returns

array of array( SMWDIProperty|SMWDIError, integer )

---

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

• PropertiesQueryPage.php