Class Whups_Query

Description

Located in /lib/Query.php (line 71)


	
			
Variable Summary
 integer $id
 string $name
 array $parameters
 array $query
 string $slug
Method Summary
 static void pathToString ( &$path)
 static void stringToPath ( $pathstring)
 static array textOperators ()
 Whups_Query Whups_Query ( &$qManager, [ $qDetails = array()])
 boolean|PEAR_Error delete ()
 void deleteNode ( $pathstring)
 void getTabs ( $vars)
 boolean hasPermission (string $userid, integer $permission, [string $creator = null])
 void hoist ( $pathstring)
 void insertBranch ( $pathstring,  $type)
 void insertCriterion ( $pathstring,  $criterion,  $cvalue,  $operator,  $value)
 void pathToForm ( &$vars)
 void reduce ( &$obj,  $method,  &$vars)
 boolean|PEAR_Error save ()
 void walk ( &$obj,  $method)
Variables
integer $id (line 83)

Query id.

string $name (line 90)

The full name of the query.

array $parameters = array() (line 108)
array $query = array('type' => QUERY_TYPE_AND,
'children' => array())
(line 102)
string $slug (line 97)

The query slug (short name).

Whups_QueryManager $_qManager (line 76)
Methods
static pathToString (line 136)
static void pathToString ( &$path)
  • &$path
static stringToPath (line 144)
static void stringToPath ( $pathstring)
  • $pathstring
static textOperators (line 160)

Returns human readable descriptions of all operator types.

  • return: Hash with operator types and descriptions.
static array textOperators ()
Constructor Whups_Query (line 113)

Constructor

Whups_Query Whups_Query ( &$qManager, [ $qDetails = array()])
  • &$qManager
  • $qDetails
delete (line 200)

Delete this object from the backend permanently.

  • return: PEAR_Error on failure.
boolean|PEAR_Error delete ()
deleteNode (line 671)
void deleteNode ( $pathstring)
  • $pathstring
getTabs (line 208)

Tab operations for this query.

void getTabs ( $vars)
  • $vars
hasPermission (line 179)

Checks to see if a user has a given permission.

  • return: Whether or not $userid has $permission.
boolean hasPermission (string $userid, integer $permission, [string $creator = null])
  • string $userid: The userid of the user.
  • integer $permission: A PERMS_* constant to test for.
  • string $creator: The creator of the event.
hoist (line 695)
void hoist ( $pathstring)
  • $pathstring
insertBranch (line 717)
void insertBranch ( $pathstring,  $type)
  • $pathstring
  • $type
insertCriterion (line 743)
void insertCriterion ( $pathstring,  $criterion,  $cvalue,  $operator,  $value)
  • $pathstring
  • $criterion
  • $cvalue
  • $operator
  • $value
pathToForm (line 247)

Operations.

void pathToForm ( &$vars)
  • &$vars
reduce (line 812)

Bottom up traversal.

void reduce ( &$obj,  $method,  &$vars)
  • &$obj
  • $method
  • &$vars
save (line 190)

Saves any changes to this object to the backend permanently. New objects are added instead.

  • return: PEAR_Error on failure.
boolean|PEAR_Error save ()
walk (line 777)

Top down traversal.

void walk ( &$obj,  $method)
  • &$obj
  • $method

Documentation generated on Sun, 30 Jan 2011 05:41:42 +0000 by phpDocumentor 1.4.3