Documentation

Horde_Kolab_Storage_QuerySet_Uncached extends Horde_Kolab_Storage_QuerySet_Base
in package

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.

Tags
category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

BASIC  = 'basic'
Query set identifiers
HORDE  = 'horde'
$_class_map  : array<string|int, mixed>
The query class map.
$_data_queries  : array<string|int, mixed>
The list of query types to add to data handlers.
$_data_query_sets  : array<string|int, mixed>
Predefined query sets.
$_factory  : Horde_Kolab_Storage_Factory
The factory for generating additional resources.
$_list_queries  : array<string|int, mixed>
The list of query types to add to lists.
__construct()  : mixed
Constructor.
addDataQuerySet()  : null
Add the set of data queries.
_getDataQueryParameters()  : array<string|int, mixed>
Fetch any additional parameters required when creating data queries.
_addDataQuery()  : null
Add a data query.
_createDataQuery()  : Horde_Kolab_Storage_Query
Create the specified data query type.
_createQuery()  : Horde_Kolab_Storage_Query
Create the specified query type.

Constants

BASIC

Query set identifiers

public mixed BASIC = 'basic'

HORDE

public mixed HORDE = 'horde'

Properties

$_class_map

The query class map.

protected array<string|int, mixed> $_class_map = array(\Horde_Kolab_Storage_Data::QUERY_PREFS => 'Horde_Kolab_Storage_Data_Query_Preferences_Base', \Horde_Kolab_Storage_Data::QUERY_HISTORY => 'Horde_Kolab_Storage_Data_Query_History_Base')

$_data_queries

The list of query types to add to data handlers.

private array<string|int, mixed> $_data_queries = array()

$_data_query_sets

Predefined query sets.

private array<string|int, mixed> $_data_query_sets = array(self::HORDE => array(\Horde_Kolab_Storage_Data::QUERY_PREFS => 'h-prefs', \Horde_Kolab_Storage_Data::QUERY_HISTORY => \true))

$_list_queries

The list of query types to add to lists.

private array<string|int, mixed> $_list_queries = array()

Methods

__construct()

Constructor.

public __construct(Horde_Kolab_Storage_Factory $factory[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$factory : Horde_Kolab_Storage_Factory

The factory.

$params : array<string|int, mixed> = array()

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.
Return values
mixed —

addDataQuerySet()

Add the set of data queries.

public addDataQuerySet(Horde_Kolab_Storage_Data $data[, array<string|int, mixed> $params = array() ]) : null
Parameters
$data : Horde_Kolab_Storage_Data

The data.

$params : array<string|int, mixed> = array()

Additional query parameters.

Return values
null —

_getDataQueryParameters()

Fetch any additional parameters required when creating data queries.

protected _getDataQueryParameters(Horde_Kolab_Storage_Data $data) : array<string|int, mixed>
Parameters
$data : Horde_Kolab_Storage_Data

The data.

Return values
array<string|int, mixed> —

The parameters for data queries.

_addDataQuery()

Add a data query.

private _addDataQuery(Horde_Kolab_Storage_Data $data, string $type[, array<string|int, mixed> $params = array() ]) : null
Parameters
$data : Horde_Kolab_Storage_Data

The data.

$type : string

The query type.

$params : array<string|int, mixed> = array()

Additional query parameters.

Return values
null —

_createDataQuery()

Create the specified data query type.

private _createDataQuery(string $name, Horde_Kolab_Storage_Data $data[, array<string|int, mixed> $params = array() ]) : Horde_Kolab_Storage_Query
Parameters
$name : string

The query name.

$data : Horde_Kolab_Storage_Data

The data that should be queried.

$params : array<string|int, mixed> = array()

Additional parameters provided to the query constructor.

Tags
throws
Horde_Kolab_Storage_Exception

In case the requested query is not supported.

Return values
Horde_Kolab_Storage_Query —

A query handler.

_createQuery()

Create the specified query type.

private _createQuery(string $name, mixed $data[, array<string|int, mixed> $params = array() ]) : Horde_Kolab_Storage_Query
Parameters
$name : string

The query name.

$data : mixed

The data that should be queried.

$params : array<string|int, mixed> = array()

Additional parameters provided to the query constructor.

Tags
throws
Horde_Kolab_Storage_Exception

In case the requested query is not supported.

Return values
Horde_Kolab_Storage_Query —

A query handler.

Search results