\Horde_Kolab_Storage_QuerySet_Uncached

Adds a set of uncached queries to the list handlers.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
addDataQuerySet()
No public properties found
BASIC
HORDE
_getDataQueryParameters()
$_class_map
N/A
_addDataQuery()
_createDataQuery()
_createQuery()
$_factory
$_list_queries
$_data_queries
$_data_query_sets
N/A

Constants

BASIC

BASIC

Query set identifiers

HORDE

HORDE

Properties

$_class_map

$_class_map : array

The query class map.

Type

array

$_list_queries

$_list_queries : array

The list of query types to add to lists.

Type

array

$_data_queries

$_data_queries : array

The list of query types to add to data handlers.

Type

array

$_data_query_sets

$_data_query_sets : array

Predefined query sets.

Type

array

Methods

__construct()

__construct(\Horde_Kolab_Storage_Factory  $factory, array  $params = array()) 

Constructor.

Parameters

\Horde_Kolab_Storage_Factory $factory

The factory.

array $params

Optional parameters.

- list: Array of list query settings
  - queryset [string]: One of the predefined query set
                       ("basic" or "horde")
  - myset    [string]: A list of query types that should be selected.
  - classmap [array] : An array of "type" => "class" mappings.

addDataQuerySet()

addDataQuerySet(\Horde_Kolab_Storage_Data  $data, array  $params = array()) : NULL

Add the set of data queries.

Parameters

\Horde_Kolab_Storage_Data $data

The data.

array $params

Additional query parameters.

Returns

NULL

_getDataQueryParameters()

_getDataQueryParameters(\Horde_Kolab_Storage_Data  $data) : array

Fetch any additional parameters required when creating data queries.

Parameters

\Horde_Kolab_Storage_Data $data

The data.

Returns

array —

The parameters for data queries.

_addDataQuery()

_addDataQuery(\Horde_Kolab_Storage_Data  $data, string  $type, array  $params = array()) : NULL

Add a data query.

Parameters

\Horde_Kolab_Storage_Data $data

The data.

string $type

The query type.

array $params

Additional query parameters.

Returns

NULL

_createDataQuery()

_createDataQuery(string  $name, \Horde_Kolab_Storage_Data  $data, array  $params = array()) : \Horde_Kolab_Storage_Query

Create the specified data query type.

Parameters

string $name

The query name.

\Horde_Kolab_Storage_Data $data

The data that should be queried.

array $params

Additional parameters provided to the query constructor.

Throws

\Horde_Kolab_Storage_Exception

In case the requested query is not supported.

Returns

\Horde_Kolab_Storage_Query

A query handler.

_createQuery()

_createQuery(string  $name, mixed  $data, array  $params = array()) : \Horde_Kolab_Storage_Query

Create the specified query type.

Parameters

string $name

The query name.

mixed $data

The data that should be queried.

array $params

Additional parameters provided to the query constructor.

Throws

\Horde_Kolab_Storage_Exception

In case the requested query is not supported.

Returns

\Horde_Kolab_Storage_Query

A query handler.