/usr/share/php/Horde/Rdo/Query.php is in php-horde-rdo 2.0.2-2.
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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 | <?php
/**
* Represent a single query or a tree of many query elements uniformly to
* clients.
*
* @category Horde
* @package Rdo
*/
/**
* @category Horde
* @package Rdo
*/
class Horde_Rdo_Query
{
/**
* @var Horde_Rdo_Mapper
*/
public $mapper;
/**
* @var string
*/
public $conjunction = 'AND';
/**
* @var array
*/
public $fields = array('*');
/**
* @var boolean
*/
public $distinct = false;
/**
* @var array
*/
public $tests = array();
/**
* @var array
*/
public $relationships = array();
/**
* @var integer
*/
public $limit;
/**
* @var integer
*/
public $limitOffset = null;
/**
* @var array
*/
protected $_sortby = array();
/**
* @var integer
*/
protected $_aliasCount = 0;
/**
* @var array
*/
protected $_aliases = array();
/**
* Turn any of the acceptable query shorthands into a full
* Horde_Rdo_Query object. If you pass an existing Horde_Rdo_Query
* object in, it will be cloned before it's returned so that it
* can be safely modified.
*
* @param mixed $query The query to convert to an object.
* @param Horde_Rdo_Mapper $mapper The Mapper object governing this query.
*
* @return Horde_Rdo_Query The full Horde_Rdo_Query object.
*/
public static function create($query, $mapper = null)
{
if ($query instanceof Horde_Rdo_Query ||
$query instanceof Horde_Rdo_Query_Literal) {
$query = clone $query;
if (!is_null($mapper)) {
$query->setMapper($mapper);
}
return $query;
}
$q = new Horde_Rdo_Query($mapper);
if (is_scalar($query)) {
$q->addTest($mapper->tableDefinition->getPrimaryKey(), '=', $query);
} elseif ($query) {
$q->combineWith('AND');
foreach ($query as $key => $value) {
$q->addTest($key, '=', $value);
}
}
return $q;
}
/**
* @param Horde_Rdo_Mapper $mapper Rdo mapper base class
*/
public function __construct($mapper = null)
{
$this->setMapper($mapper);
}
/**
* @param Horde_Rdo_Mapper $mapper Rdo mapper base class
*
* @return Horde_Rdo_Query Return the query object for fluent chaining.
*/
public function setMapper($mapper)
{
if ($mapper === $this->mapper) {
return $this;
}
$this->mapper = $mapper;
// Fetch all non-lazy-loaded fields for the mapper.
$this->setFields($mapper->fields, $mapper->table . '.');
// Add all non-lazy relationships.
foreach ($mapper->relationships as $relationship => $rel) {
if (isset($rel['mapper'])) {
// @TODO - should be getting this instance from somewhere
// else external, and not passing the adapter along
// automatically.
$m = new $rel['mapper']($this->mapper->adapter);
} else {
$m = $this->mapper->tableToMapper($relationship);
if (is_null($m)) {
throw new Horde_Rdo_Exception('Unable to find a Mapper class for eager-loading relationship ' . $relationship);
}
}
// Add the fields for this relationship to the query.
$m->tableAlias = $this->_alias($m->table);
$this->addFields($m->fields, $m->tableAlias . '.@');
switch ($rel['type']) {
case Horde_Rdo::ONE_TO_ONE:
case Horde_Rdo::MANY_TO_ONE:
if (isset($rel['query'])) {
$query = $this->_fillJoinPlaceholders($m, $mapper, $rel['query']);
} else {
$query = array($mapper->table . '.' . $rel['foreignKey'] => new Horde_Rdo_Query_Literal($m->table . '.' . $m->tableDefinition->getPrimaryKey()));
}
$this->addRelationship($relationship, array('mapper' => $m,
'type' => $rel['type'],
'query' => $query));
break;
case Horde_Rdo::ONE_TO_MANY:
case Horde_Rdo::MANY_TO_MANY:
//@TODO
}
}
return $this;
}
/**
* Makes the query return only distinct (different) values.
*
* @param boolean $distinct Whether to enable a distinct query.
*
* @return Horde_Rdo_Query Returns self for fluent method chaining.
*/
public function distinct($distinct)
{
$this->distinct = $distinct;
return $this;
}
/**
* @param array $fields The fields to load with this query.
*
* @return Horde_Rdo_Query Returns self for fluent method chaining.
*/
public function setFields($fields, $fieldPrefix = null)
{
if (!is_array($fields)) {
$fields = array($fields);
}
if (!is_null($fieldPrefix)) {
array_walk($fields, array($this, '_prefix'), $fieldPrefix);
}
$this->fields = $fields;
return $this;
}
/**
* @param array $fields Additional Fields to load with this query.
*
* @return Horde_Rdo_Query Returns self for fluent method chaining.
*/
public function addFields($fields, $fieldPrefix = null)
{
if (!is_null($fieldPrefix)) {
array_walk($fields, array($this, '_prefix'), $fieldPrefix);
}
$this->fields = array_merge($this->fields, $fields);
}
/**
* @param string $conjunction SQL conjunction such as "AND", "OR".
*/
public function combineWith($conjunction)
{
$this->conjunction = $conjunction;
return $this;
}
/**
*/
public function addTest($field, $test, $value)
{
$this->tests[] = array('field' => $field,
'test' => $test,
'value' => $value);
return $this;
}
/**
* Adds a relationship type to a query.
* @param string $relationship The name of the relationship as defined in
* the mapper.
* @param array $args The parameter array as defined in the
* mapper:
* - mapper: The mapper object of the
* result class.
* - table: Optional name of the table to
* use.
* - tableAlias: Optional alias name for the
* base table.
* - join_type: Optional explicitly control
* the type of join.
* - type: The type of relation, any of
* the constants in Horde_Rdo.
*
* @return Horde_Rdo_Query This object.
*/
public function addRelationship($relationship, $args)
{
if (!isset($args['mapper'])) {
throw new InvalidArgumentException('Relationships must contain a Horde_Rdo_Mapper object.');
}
if (!isset($args['table'])) {
$args['table'] = $args['mapper']->table;
}
if (!isset($args['tableAlias'])) {
if (isset($args['mapper']->tableAlias)) {
$args['tableAlias'] = $args['mapper']->tableAlias;
} else {
$args['tableAlias'] = $this->_alias($args['table']);
}
}
if (!isset($args['type'])) {
$args['type'] = Horde_Rdo::MANY_TO_MANY;
}
if (!isset($args['join_type'])) {
switch ($args['type']) {
case Horde_Rdo::ONE_TO_ONE:
case Horde_Rdo::MANY_TO_ONE:
case Horde_Rdo::MANY_TO_MANY:
$args['join_type'] = 'INNER JOIN';
break;
default:
$args['join_type'] = 'LEFT JOIN';
}
}
$this->relationships[$relationship] = $args;
return $this;
}
/**
* Add a sorting rule.
*
* @param string $sort SQL sort fragment, such as 'updated DESC'
*/
public function sortBy($sort)
{
$this->_sortby[] = $sort;
return $this;
}
/**
*/
public function clearSort()
{
$this->_sortby = array();
return $this;
}
/**
* Restrict the query to a subset of the results.
*
* @param integer $limit Number of items to fetch.
* @param integer $offset Offset to start fetching at.
*/
public function limit($limit, $offset = null)
{
$this->limit = $limit;
$this->limitOffset = $offset;
return $this;
}
/**
* Accessor for any fields that we want some logic around.
*
* @param string $key
*/
public function __get($key)
{
switch ($key) {
case 'sortby':
if (!$this->_sortby && $this->mapper->defaultSort) {
// Add in any default sort values, if none are already
// set.
$this->sortBy($this->mapper->defaultSort);
}
return $this->_sortby;
}
throw new InvalidArgumentException('Undefined property ' . $key);
}
/**
* Query generator.
*
* @return array A two-element array of the SQL query and an array
* of bind parameters.
*/
public function getQuery()
{
$bindParams = array();
$sql = '';
$this->_select($sql, $bindParams);
$this->_from($sql, $bindParams);
$this->_join($sql, $bindParams);
$this->_where($sql, $bindParams);
$this->_orderBy($sql, $bindParams);
$this->_limit($sql, $bindParams);
return array($sql, $bindParams);
}
/**
*/
protected function _select(&$sql, &$bindParams)
{
$fields = array();
foreach ($this->fields as $field) {
$parts = explode('.@', $field, 2);
if (count($parts) == 1) {
$fields[] = $field;
} else {
list($tableName, $columnName) = $parts;
if (isset($this->_aliases[$tableName])) {
$tableName = $this->_aliases[$tableName];
}
$fields[] = str_replace('.@', '.', $field) . ' AS ' . $this->mapper->adapter->quoteColumnName($tableName . '@' . $columnName);
}
}
if ($this->distinct) {
$sql = 'SELECT ' . $this->mapper->adapter->distinct(implode(', ', $fields), implode(', ', $this->sortby));
} else {
$sql = 'SELECT ' . implode(', ', $fields);
}
}
/**
*/
protected function _from(&$sql, &$bindParams)
{
$sql .= ' FROM ' . $this->mapper->table;
}
/**
*/
protected function _join(&$sql, &$bindParams)
{
foreach ($this->relationships as $relationship) {
$relsql = array();
$table = $relationship['table'];
$tableAlias = $relationship['tableAlias'];
foreach ($relationship['query'] as $key => $value) {
if ($value instanceof Horde_Rdo_Query_Literal) {
$relsql[] = $key . ' = ' . str_replace("{$table}.", "{$tableAlias}.", (string)$value);
} else {
$relsql[] = $key . ' = ?';
$bindParams[] = $value;
}
}
$sql .= ' ' . $relationship['join_type'] . ' ' . $relationship['table'] . ' ' . $tableAlias . ' ON ' . implode(' AND ', $relsql);
}
}
/**
*/
protected function _where(&$sql, &$bindParams)
{
$clauses = array();
foreach ($this->tests as $test) {
if (strpos($test['field'], '@') !== false) {
list($rel, $field) = explode('@', $test['field']);
if (!isset($this->relationships[$rel])) {
continue;
}
$clause = $this->relationships[$rel]['tableAlias'] . '.' . $field . ' ' . $test['test'];
} else {
$clause = $this->mapper->table . '.' . $this->mapper->adapter->quoteColumnName($test['field']) . ' ' . $test['test'];
}
if ($test['value'] instanceof Horde_Rdo_Query_Literal) {
$clauses[] = $clause . ' ' . (string)$test['value'];
} else {
if (($test['test'] == 'IN' || $test['test'] == 'NOT IN') && is_array($test['value'])) {
$clauses[] = $clause . '(?' . str_repeat(',?', count($test['value']) - 1) . ')';
$bindParams = array_merge($bindParams, array_values($test['value']));
} else {
$clauses[] = $clause . ' ?';
$bindParams[] = $test['value'];
}
}
}
if ($clauses) {
$sql .= ' WHERE ' . implode(' ' . $this->conjunction . ' ', $clauses);
}
}
/**
*/
protected function _orderBy(&$sql, &$bindParams)
{
if ($this->sortby) {
$sql .= ' ORDER BY';
foreach ($this->sortby as $sort) {
if (strpos($sort, '@') !== false) {
list($rel, $field) = explode('@', $sort);
if (!isset($this->relationships[$rel])) {
continue;
}
$sql .= ' ' . $this->relationships[$rel]['tableAlias'] . '.' . $field . ',';
} else {
$sql .= " $sort,";
}
}
$sql = substr($sql, 0, -1);
}
}
/**
*/
protected function _limit(&$sql, &$bindParams)
{
if ($this->limit) {
$opts = array('limit' => $this->limit, 'offset' => $this->limitOffset);
$sql = $this->mapper->adapter->addLimitOffset($sql, $opts);
}
}
/**
* Callback for array_walk to prefix all elements of an array with
* a given prefix.
*/
protected function _prefix(&$fieldName, $key, $prefix)
{
$fieldName = $prefix . $fieldName;
}
/**
* Get a unique table alias
*/
protected function _alias($tableName)
{
$alias = 't' . ++$this->_aliasCount;
$this->_aliases[$alias] = $tableName;
return $alias;
}
/**
* Take a query array and replace @field@ placeholders with values
* that will match in the load query.
*
* @param Horde_Rdo_Mapper $m1 Left-hand mapper
* @param Horde_Rdo_Mapper $m2 Right-hand mapper
* @param array $query The query to process placeholders on.
*
* @return array The query with placeholders filled in.
*/
protected function _fillJoinPlaceholders($m1, $m2, $query)
{
$q = array();
foreach (array_keys($query) as $field) {
$value = $query[$field];
if (preg_match('/^@(.*)@$/', $value, $matches)) {
$q[$m1->tableAlias . '.' . $field] = new Horde_Rdo_Query_Literal($m2->table . '.' . $matches[1]);
} else {
$q[$m1->tableAlias . '.' . $field] = $value;
}
}
return $q;
}
}
|