Semantic MediaWiki and related extensions
Public Member Functions | Protected Attributes | List of all members
SMW\QueryPage Class Reference
Collaboration diagram for SMW\QueryPage:
Collaboration graph
[legend]

Public Member Functions

 getResults ($requestoptions)
 
 recache ($limit, $ignoreErrors=true)
 
 isExpensive ()
 
 isSyndicated ()
 
 linkParameters ()
 
 getMessageFormatter ()
 
 getLinker ()
 
 getSearchForm ($property= '', $cacheDate= '', $propertySearch=true)
 
 doQuery ($offset=false, $limit=false, $property=false)
 

Protected Attributes

 $msgFormatter
 
 $linker = null
 
 $selectOptions = array()
 
 $useSerchForm = false
 

Detailed Description

An abstract query page base class that supports array-based data retrieval instead of the SQL-based access used by MW.

GNU GPL v2+

Since
??
Author
Markus Krötzsch Abstract base class for SMW's variant of the MW QueryPage. Subclasses must implement getResults() and formatResult(), as well as some other standard functions of QueryPage.

Member Function Documentation

SMW\QueryPage::doQuery (   $offset = false,
  $limit = false,
  $property = false 
)

This is the actual workhorse. It does everything needed to make a real, honest-to-gosh query page. Alas, we need to overwrite the whole beast since we do not assume an SQL-based storage backend.

Parameters
$offsetdatabase query offset
$limitdatabase query limit
$propertydatabase string query
SMW\QueryPage::getLinker ( )

Returns a Linker object

Since
1.9
Returns
Linker
SMW\QueryPage::getMessageFormatter ( )

Returns a MessageFormatter object

Since
1.9
Returns
MessageFormatter
SMW\QueryPage::getResults (   $requestoptions)
abstract

Implemented by subclasses to provide concrete functions.

SMW\QueryPage::getSearchForm (   $property = '',
  $cacheDate = '',
  $propertySearch = true 
)

Generates a search form

Since
1.9
Parameters
string$property
Returns
string
SMW\QueryPage::isExpensive ( )
SMW\QueryPage::isSyndicated ( )
SMW\QueryPage::linkParameters ( )
See also
QueryPage::linkParameters
Since
1.9
Returns
array
SMW\QueryPage::recache (   $limit,
  $ignoreErrors = true 
)

Clear the cache and save new results

Todo:
Implement caching for SMW query pages

TODO

Member Data Documentation

SMW\QueryPage::$linker = null
protected
SMW\QueryPage::$msgFormatter
protected
SMW\QueryPage::$selectOptions = array()
protected
SMW\QueryPage::$useSerchForm = false
protected

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