BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
SMW\RequestOptions Class Reference

Public Member Functions

 addStringCondition ($string, $condition, $asDisjunctiveCondition=false)
 
 getStringConditions ()
 
 getHash ()
 

Public Attributes

 $limit = -1
 
 $offset = 0
 
 $sort = false
 
 $ascending = true
 
 $boundary = null
 
 $include_boundary = true
 

Detailed Description

Container object for various options that can be used when retrieving data from the store. These options are mostly relevant for simple, direct requests – inline queries may require more complex options due to their more complex structure. Options that should not be used or where default values should be used can be left as initialised.

GNU GPL v2+

Since
1.0
Author
Markus Krötzsch

Member Function Documentation

SMW\RequestOptions::addStringCondition (   $string,
  $condition,
  $asDisjunctiveCondition = false 
)
Since
1.0
Parameters
string$stringto match
integer$conditionone of STRCOND_PRE, STRCOND_POST, STRCOND_MID
boolean$asDisjunctiveCondition
SMW\RequestOptions::getHash ( )
Since
2.4
Returns
string
SMW\RequestOptions::getStringConditions ( )

Return the specified array of SMWStringCondition objects.

Since
1.0
Returns
array

Member Data Documentation

SMW\RequestOptions::$ascending = true

If SMWRequestOptions->$sort is true, this parameter defines whether the results are ordered in ascending or descending order.

SMW\RequestOptions::$boundary = null

Specifies a lower or upper bound for the values returned by the query. Whether it is lower or upper is specified by the parameter "ascending" (true->lower, false->upper).

SMW\RequestOptions::$include_boundary = true

Specifies whether or not the requested boundary should be returned as a result.

SMW\RequestOptions::$limit = -1

The maximum number of results that should be returned.

SMW\RequestOptions::$offset = 0

A numerical offset. The first $offset results are skipped. Note that this does not imply a defined order of results (see SMWRequestOptions->$sort below).

SMW\RequestOptions::$sort = false

Should the result be ordered? The employed order is defined by the type of result that are requested: wiki pages and strings are ordered alphabetically, whereas other data is ordered numerically. Usually, the order should be fairly "natural".


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