API Documentation
\

\Whups_Query

Summary

Methods
Properties
Constants
__construct()
pathToString()
stringToPath()
textOperators()
hasPermission()
save()
delete()
feedLink()
getTabs()
pathToForm()
deleteNode()
hoist()
insertBranch()
insertCriterion()
walk()
reduce()
$id
$name
$slug
$query
$parameters
TYPE_AND
TYPE_OR
TYPE_NOT
TYPE_CRITERION
CRITERION_ID
CRITERION_QUEUE
CRITERION_TYPE
CRITERION_STATE
CRITERION_PRIORITY
CRITERION_OWNERS
CRITERION_REQUESTER
CRITERION_GROUPS
CRITERION_ADDED_COMMENT
CRITERION_COMMENT
CRITERION_SUMMARY
CRITERION_ATTRIBUTE
CRITERION_VERSION
CRITERION_TIMESTAMP
CRITERION_UPDATED
CRITERION_RESOLVED
CRITERION_ASSIGNED
CRITERION_DUE
OPERATOR_GREATER
OPERATOR_LESS
OPERATOR_EQUAL
OPERATOR_CI_SUBSTRING
OPERATOR_CS_SUBSTRING
OPERATOR_WORD
OPERATOR_PATTERN
_walk()
_reduce()
_getParameterName()
$_qManager
N/A
No private methods found
No private properties found
N/A

Constants

TYPE_AND

TYPE_AND

Mode types.

TYPE_OR

TYPE_OR

TYPE_NOT

TYPE_NOT

TYPE_CRITERION

TYPE_CRITERION

CRITERION_ID

CRITERION_ID

Criterion types.

CRITERION_QUEUE

CRITERION_QUEUE

CRITERION_TYPE

CRITERION_TYPE

CRITERION_STATE

CRITERION_STATE

CRITERION_PRIORITY

CRITERION_PRIORITY

CRITERION_OWNERS

CRITERION_OWNERS

CRITERION_REQUESTER

CRITERION_REQUESTER

CRITERION_GROUPS

CRITERION_GROUPS

CRITERION_ADDED_COMMENT

CRITERION_ADDED_COMMENT

CRITERION_COMMENT

CRITERION_COMMENT

CRITERION_SUMMARY

CRITERION_SUMMARY

CRITERION_ATTRIBUTE

CRITERION_ATTRIBUTE

CRITERION_VERSION

CRITERION_VERSION

CRITERION_TIMESTAMP

CRITERION_TIMESTAMP

CRITERION_UPDATED

CRITERION_UPDATED

CRITERION_RESOLVED

CRITERION_RESOLVED

CRITERION_ASSIGNED

CRITERION_ASSIGNED

CRITERION_DUE

CRITERION_DUE

OPERATOR_GREATER

OPERATOR_GREATER

Operators for integer fields.

OPERATOR_LESS

OPERATOR_LESS

OPERATOR_EQUAL

OPERATOR_EQUAL

OPERATOR_CI_SUBSTRING

OPERATOR_CI_SUBSTRING

Operators for text fields.

OPERATOR_CS_SUBSTRING

OPERATOR_CS_SUBSTRING

OPERATOR_WORD

OPERATOR_WORD

OPERATOR_PATTERN

OPERATOR_PATTERN

Properties

$id

$id : integer

Query id.

Type

integer

$name

$name : string

The full name of the query.

Type

string

$slug

$slug : string

The query slug (short name).

Type

string

$query

$query : array

Type

array

$parameters

$parameters : array

Type

array

Methods

__construct()

__construct(\Whups_Query_Manager  $qManager, array  $qDetails = array())

Constructor

Parameters

\Whups_Query_Manager $qManager
array $qDetails

pathToString()

pathToString(  $path)

Parameters

$path

stringToPath()

stringToPath(  $pathstring)

Parameters

$pathstring

textOperators()

textOperators() : array

Returns human readable descriptions of all operator types.

Returns

array —

Hash with operator types and descriptions.

hasPermission()

hasPermission(string  $userid, integer  $permission, string  $creator = null) : boolean

Checks to see if a user has a given permission.

Parameters

string $userid

The userid of the user.
integer $permission

A Horde_Perms::* constant to test for.
string $creator

The creator of the event.

Returns

boolean —

Whether or not $userid has $permission.

save()

save()

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

delete()

delete()

Delete this object from the backend permanently.

feedLink()

feedLink() : array

Returns <link> data for this query's feed.

Returns

array —

Link data.

getTabs()

getTabs(\Horde_Variables  $vars)

Tab operations for this query.

Parameters

\Horde_Variables $vars

pathToForm()

pathToForm(\Horde_Variables  $vars) : string

Path to form

Parameters

\Horde_Variables $vars

Throws

\Whups_Exception

Returns

string

deleteNode()

deleteNode(  $pathstring)

Parameters

$pathstring

hoist()

hoist(  $pathstring)

Parameters

$pathstring

insertBranch()

insertBranch(  $pathstring,   $type)

Parameters

$pathstring
$type

insertCriterion()

insertCriterion(  $pathstring,   $criterion,   $cvalue,   $operator,   $value)

Parameters

$pathstring
$criterion
$cvalue
$operator
$value

walk()

walk(  $obj,   $method)

Top down traversal.

Parameters

$obj
$method

reduce()

reduce(  $method,   $vars)

Bottom up traversal.

Parameters

$method
$vars

_walk()

_walk(  $node,   $more,   $path,   $obj,   $method)

Parameters

$node
$more
$path
$obj
$method

_reduce()

_reduce(  $node,   $method,   $vars)

Parameters

$node
$method
$vars

_getParameterName()

_getParameterName(  $value)

Parameters

$value