PHP Class Whups_Query, horde

Show file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$id integer Query id.
$name string The full name of the query.
$parameters array
$query array
$slug string The query slug (short name).

Protected Properties

Property Type Description
$_qManager Whups_Query_Manager

Public Methods

Method Description
__construct ( Whups_Query_Manager &$qManager, array $qDetails = [] ) Constructor
delete ( ) Delete this object from the backend permanently.
deleteNode ( $pathstring )
feedLink ( ) : array Returns data for this query's feed.
getTabs ( Horde_Variables $vars ) Tab operations for this query.
hasPermission ( string $userid, integer $permission, string $creator = null ) : boolean Checks to see if a user has a given permission.
hoist ( $pathstring )
insertBranch ( $pathstring, $type )
insertCriterion ( $pathstring, $criterion, $cvalue, $operator, $value )
pathToForm ( Horde_Variables &$vars ) : string Path to form
pathToString ( &$path )
reduce ( $method, &$vars ) Bottom up traversal.
save ( ) Saves any changes to this object to the backend permanently. New objects are added instead.
stringToPath ( $pathstring )
textOperators ( ) : array Returns human readable descriptions of all operator types.
walk ( &$obj, $method ) Top down traversal.

Protected Methods

Method Description
_getParameterName ( $value )
_reduce ( &$node, $method, &$vars )
_walk ( &$node, &$more, &$path, &$obj, $method )

Method Details

__construct() public method

Constructor
public __construct ( Whups_Query_Manager &$qManager, array $qDetails = [] )
$qManager Whups_Query_Manager
$qDetails array

_getParameterName() protected method

protected _getParameterName ( $value )

_reduce() protected method

protected _reduce ( &$node, $method, &$vars )

_walk() protected method

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

delete() public method

Delete this object from the backend permanently.
public delete ( )

deleteNode() public method

public deleteNode ( $pathstring )

getTabs() public method

Tab operations for this query.
public getTabs ( Horde_Variables $vars )
$vars Horde_Variables

hasPermission() public method

Checks to see if a user has a given permission.
public hasPermission ( string $userid, integer $permission, string $creator = null ) : boolean
$userid string The userid of the user.
$permission integer A Horde_Perms::* constant to test for.
$creator string The creator of the event.
return boolean Whether or not $userid has $permission.

hoist() public method

public hoist ( $pathstring )

insertBranch() public method

public insertBranch ( $pathstring, $type )

insertCriterion() public method

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

pathToForm() public method

Path to form
public pathToForm ( Horde_Variables &$vars ) : string
$vars Horde_Variables
return string

pathToString() public static method

public static pathToString ( &$path )

reduce() public method

Bottom up traversal.
public reduce ( $method, &$vars )

save() public method

Saves any changes to this object to the backend permanently. New objects are added instead.
public save ( )

stringToPath() public static method

public static stringToPath ( $pathstring )

textOperators() public static method

Returns human readable descriptions of all operator types.
public static textOperators ( ) : array
return array Hash with operator types and descriptions.

walk() public method

Top down traversal.
public walk ( &$obj, $method )

Property Details

$_qManager protected property

protected Whups_Query_Manager $_qManager
return Whups_Query_Manager

$id public property

Query id.
public int $id
return integer

$name public property

The full name of the query.
public string $name
return string

$parameters public property

public array $parameters
return array

$query public property

public array $query
return array

$slug public property

The query slug (short name).
public string $slug
return string