SMWRequestOptions Class Reference
[SMWStore]

Container object for various options that can be used when retrieving data from the store. More...

List of all members.

Public Member Functions
	addStringCondition ($string, $condition)
	Set a new string condition applied to labels of results (if available).
	getStringConditions ()
	Return the specified array of SMWStringCondition objects.
Public Attributes
	$limit = -1
	The maximum number of results that should be returned.
	$offset = 0
	A numerical offset.
	$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.
	$ascending = true
	If SMWRequestOptions->$sort is true, this parameter defines whether the results are ordered in ascending or descending order.
	$boundary = null
	Specifies a lower or upper bound for the values returned by the query.
	$include_boundary = true
	Specifies whether or not the requested boundary should be returned as a result.
Private Attributes
	$stringcond = array()
	An array of string conditions that are applied if the result has a string label that can be subject to those patterns.

---

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.

Author:

Markus Krötzsch

Definition at line 64 of file SMW_Store.php.

---

Member Function Documentation

SMWRequestOptions::addStringCondition	(	$	string,
		$	condition
	)

Set a new string condition applied to labels of results (if available).

Parameters:

	$string	string to match
	$condition	integer type of condition, one of STRCOND_PRE, STRCOND_POST, STRCOND_MID

Definition at line 117 of file SMW_Store.php.

SMWRequestOptions::getStringConditions

(

)

Return the specified array of SMWStringCondition objects.

Definition at line 124 of file SMW_Store.php.

---

Member Data Documentation

SMWRequestOptions::$limit = -1

The maximum number of results that should be returned.

Definition at line 69 of file SMW_Store.php.

SMWRequestOptions::$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).

Definition at line 76 of file SMW_Store.php.

SMWRequestOptions::$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".

Definition at line 84 of file SMW_Store.php.

SMWRequestOptions::$ascending = true

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

Definition at line 90 of file SMW_Store.php.

SMWRequestOptions::$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).

Definition at line 97 of file SMW_Store.php.

SMWRequestOptions::$include_boundary = true

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

Definition at line 103 of file SMW_Store.php.

SMWRequestOptions::$stringcond = array() [private]

An array of string conditions that are applied if the result has a string label that can be subject to those patterns.

Definition at line 109 of file SMW_Store.php.

---

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

• SemanticMediaWiki/includes/storage/SMW_Store.php