OrderByExpression.php 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 3.0.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Database\Expression;
  16. use Cake\Database\ExpressionInterface;
  17. use Cake\Database\ValueBinder;
  18. /**
  19. * An expression object for ORDER BY clauses
  20. */
  21. class OrderByExpression extends QueryExpression
  22. {
  23. /**
  24. * Constructor
  25. *
  26. * @param string|array|\Cake\Database\ExpressionInterface $conditions The sort columns
  27. * @param array|\Cake\Database\TypeMap $types The types for each column.
  28. * @param string $conjunction The glue used to join conditions together.
  29. */
  30. public function __construct($conditions = [], $types = [], $conjunction = '')
  31. {
  32. parent::__construct($conditions, $types, $conjunction);
  33. }
  34. /**
  35. * Convert the expression into a SQL fragment.
  36. *
  37. * @param \Cake\Database\ValueBinder $generator Placeholder generator object
  38. * @return string
  39. */
  40. public function sql(ValueBinder $generator)
  41. {
  42. $order = [];
  43. foreach ($this->_conditions as $k => $direction) {
  44. if ($direction instanceof ExpressionInterface) {
  45. $direction = $direction->sql($generator);
  46. }
  47. $order[] = is_numeric($k) ? $direction : sprintf('%s %s', $k, $direction);
  48. }
  49. return sprintf('ORDER BY %s', implode(', ', $order));
  50. }
  51. /**
  52. * Auxiliary function used for decomposing a nested array of conditions and
  53. * building a tree structure inside this object to represent the full SQL expression.
  54. *
  55. * New order by expressions are merged to existing ones
  56. *
  57. * @param array $orders list of order by expressions
  58. * @param array $types list of types associated on fields referenced in $conditions
  59. * @return void
  60. */
  61. protected function _addConditions(array $orders, array $types)
  62. {
  63. foreach ($orders as $key => $val) {
  64. if (is_string($key) && is_string($val) && !in_array(strtoupper($val), ['ASC', 'DESC'], true)) {
  65. deprecationWarning(
  66. 'Passing extra sort expressions by associative array is deprecated. ' .
  67. 'Use QueryExpression or numeric array instead.'
  68. );
  69. }
  70. }
  71. $this->_conditions = array_merge($this->_conditions, $orders);
  72. }
  73. }