/usr/share/php/Horde/Kolab/Storage/QuerySet/Base.php is in php-horde-kolab-storage 2.2.1-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | <?php
/**
* Adds a set of uncached queries to the list handlers.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
/**
* Adds a set of uncached queries to the list handlers.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
abstract class Horde_Kolab_Storage_QuerySet_Base
implements Horde_Kolab_Storage_QuerySet
{
/** Query set identifiers */
const BASIC = 'basic';
const HORDE = 'horde';
/**
* The factory for generating additional resources.
*
* @var Horde_Kolab_Storage_Factory
*/
private $_factory;
/**
* The list of query types to add to lists.
*
* @var array
*/
private $_list_queries = array();
/**
* The list of query types to add to data handlers.
*
* @var array
*/
private $_data_queries = array();
/**
* The query class map. Override in extending classes.
*
* @var array
*/
protected $_class_map = array();
/**
* Predefined query sets.
*
* @var array
*/
private $_data_query_sets = array(
self::HORDE => array(
Horde_Kolab_Storage_Data::QUERY_PREFS => 'h-prefs',
Horde_Kolab_Storage_Data::QUERY_HISTORY => true,
)
);
/**
* Constructor.
*
* @param Horde_Kolab_Storage_Factory $factory The factory.
* @param array $params Optional parameters.
* <pre>
* - 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.
* </pre>
*/
public function __construct(Horde_Kolab_Storage_Factory $factory,
array $params = array())
{
$this->_factory = $factory;
if (isset($params['data']['queryset'])) {
if (isset($this->_data_query_sets[$params['data']['queryset']])) {
$this->_data_queries = $this->_data_query_sets[$params['data']['queryset']];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf(
'Data query set %s not supported!',
$params['data']['queryset']
)
);
}
}
if (isset($params['data']['myset'])) {
$this->_data_queries = array_merge($this->_data_queries, $params['data']['myset']);
}
}
/**
* Add the set of data queries.
*
* @param Horde_Kolab_Storage_Data $data The data.
* @param array $params Additional query parameters.
*
* @return NULL
*/
public function addDataQuerySet(Horde_Kolab_Storage_Data $data, $params = array())
{
foreach ($this->_data_queries as $query => $type) {
if ($type === true || $type == $data->getType()) {
$this->_addDataQuery($data, $query, $params);
}
}
}
/**
* Add a data query.
*
* @param Horde_Kolab_Storage_Data $data The data.
* @param string $type The query type.
* @param array $params Additional query parameters.
*
* @return NULL
*/
private function _addDataQuery(Horde_Kolab_Storage_Data $data, $type, $params = array())
{
if (isset($this->_class_map[$type])) {
$params = array_merge(
$this->_getDataQueryParameters($data),
$params
);
$data->registerQuery(
$type,
$this->_createDataQuery(
$this->_class_map[$type], $data, $params
)
);
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Query type %s not supported!', $type)
);
}
}
/**
* Fetch any additional parameters required when creating data queries.
*
* @param Horde_Kolab_Storage_Data $data The data.
*
* @return array The parameters for data queries.
*/
abstract protected function _getDataQueryParameters(
Horde_Kolab_Storage_Data $data
);
/**
* Create the specified data query type.
*
* @param string $name The query name.
* @param Horde_Kolab_Storage_Data $data The data that should be queried.
* @param array $params Additional parameters provided
* to the query constructor.
*
* @return Horde_Kolab_Storage_Query A query handler.
*
* @throws Horde_Kolab_Storage_Exception In case the requested query is not supported.
*/
private function _createDataQuery($name, Horde_Kolab_Storage_Data $data, $params = array())
{
return $this->_createQuery($name, $data, $params);
}
/**
* Create the specified query type.
*
* @param string $name The query name.
* @param mixed $data The data that should be queried.
* @param array $params Additional parameters provided
* to the query constructor.
*
* @return Horde_Kolab_Storage_Query A query handler.
*
* @throws Horde_Kolab_Storage_Exception In case the requested query is not supported.
*/
private function _createQuery($name, $data, $params = array())
{
if (class_exists($name)) {
$constructor_params = array_merge(
array('factory' => $this->_factory), $params
);
$query = new $name($data, $constructor_params);
} else {
throw new Horde_Kolab_Storage_Exception(sprintf('No such query "%s"!', $name));
}
return $query;
}
}
|