- Added OrderBySpecification

- Added a way to define OrderBy by external parameters

Author: rkrx

.travis.yml

@@ -1,7 +1,8 @@
 language: php
 
 php:
-  - 7
+  - 7.1
+  - 7.0
   - 5.6
   - 5.5
   - 5.4

src/Builder/Expr/DBExprOrderBySpec.php

@@ -0,0 +1,43 @@
+<?php
+namespace Kir\MySQL\Builder\Expr;
+
+class DBExprOrderBySpec implements OrderBySpecification {
+	/** @var array[] */
+	private $fields = [];
+	
+	/**
+	 * @param $spec
+	 * @param $sortFieldsSpec
+	 */
+	public function __construct($spec, $sortFieldsSpec) {
+		$expressions = [];
+		foreach($spec as $specReference => $dbExpr) {
+			if(is_int($specReference)) {
+				$specReference = $dbExpr;
+			}
+			$expressions[$specReference] = $dbExpr;
+		}
+		foreach($sortFieldsSpec as $sortFieldSpec) {
+			if(array_key_exists(0, $sortFieldSpec) && array_key_exists($sortFieldSpec[0], $expressions)) {
+				$direction = 'ASC';
+				if(array_key_exists(1, $sortFieldSpec) && strtoupper($sortFieldSpec[1]) !== 'ASC') {
+					$direction = 'DESC';
+				}
+				$this->fields[] = [
+					$expressions[$sortFieldSpec[0]],
+					$direction
+				];
+			}
+		}
+	}
+	
+	/**
+	 * Returns an array[], where each value is a [db-expression, sort-direction]
+	 * The sort-direction can be either ASC or DESC
+	 *
+	 * @return array[]
+	 */
+	public function getFields() {
+		return $this->fields;
+	}
+}

src/Builder/Expr/OrderBySpecification.php

@@ -0,0 +1,12 @@
+<?php
+namespace Kir\MySQL\Builder\Expr;
+
+interface OrderBySpecification {
+	/**
+	 * Returns an array[], where each value is a [db-expression, sort-direction]
+	 * The sort-direction can be either ASC or DESC
+	 *
+	 * @return array[]
+	 */
+	public function getFields();
+}

src/Builder/Traits/OrderByBuilder.php

@@ -1,36 +1,34 @@
 <?php
 namespace Kir\MySQL\Builder\Traits;
 
+use Kir\MySQL\Builder\Expr\OrderBySpecification;
+
 trait OrderByBuilder {
 	use AbstractDB;
 
 	/** @var array */
 	private $orderBy = array();
 
 	/**
-	 * @param string $expression
+	 * @param string|OrderBySpecification $expression
 	 * @param string $direction
 	 * @return $this
 	 */
 	public function orderBy($expression, $direction = 'asc') {
-		if(strtolower($direction) != 'desc') {
-			$direction = 'ASC';
-		}
-		if(is_array($expression)) {
-			if(!count($expression)) {
-				return $this;
+		if($expression instanceof OrderBySpecification) {
+			foreach($expression->getFields() as $field) {
+				$this->addOrder($field[0], $field[1]);
 			}
-			$arguments = array(
-				$expression[0],
-				array_slice($expression, 1)
-			);
-			$expression = call_user_func_array(array($this->db(), 'quoteExpression'), $arguments);
+			return $this;
 		}
-		$this->orderBy[] = array($expression, $direction);
+		$this->addOrder($expression, $direction);
 		return $this;
 	}
-
+	
 	/**
+	 * @param string $fieldName
+	 * @param array $values
+	 * @return $this
 	 */
 	public function orderByValues($fieldName, array $values) {
 		$expr = [];
@@ -57,4 +55,31 @@ protected function buildOrder($query) {
 		}
 		return $query.join(",\n", $arr)."\n";
 	}
+	
+	/**
+	 * @param string $expression
+	 * @param string $direction
+	 */
+	private function addOrder($expression, $direction) {
+		$direction = $this->fixDirection($direction);
+		if(is_array($expression)) {
+			if(!count($expression)) {
+				return;
+			}
+			$arguments = array(
+				$expression[0],
+				array_slice($expression, 1)
+			);
+			$expression = call_user_func_array(array($this->db(), 'quoteExpression'), $arguments);
+		}
+		$this->orderBy[] = array($expression, $direction);
+	}
+	
+	/**
+	 * @param string $direction
+	 * @return string
+	 */
+	private function fixDirection($direction) {
+		return strtoupper($direction) !== 'ASC' ? 'DESC' : 'ASC';
+	}
 }

tests/Builder/SelectTest.php

@@ -2,6 +2,7 @@
 namespace Kir\MySQL\Builder;
 
 use Kir\MySQL\Builder\Expr\DBExprFilter;
+use Kir\MySQL\Builder\Expr\DBExprOrderBySpec;
 use Kir\MySQL\Builder\Expr\OptionalDBFilterMap;
 use Kir\MySQL\Builder\Expr\RequiredDBFilterMap;
 use Kir\MySQL\Builder\Expr\RequiredValueNotFoundException;
@@ -307,7 +308,7 @@ public function testOptionalExpressions() {
 		$this->assertEquals("SELECT\n\tt.field\nFROM\n\ttest t\n", $query);
 	}
 
-	public function testRequired() {
+	public function testRequiredExpression() {
 		$filter = ['filter' => ['name' => 'aaa']];
 		$req = new RequiredDBFilterMap($filter);
 
@@ -327,4 +328,14 @@ public function testRequired() {
 		->where($req('t.field=?', 'filter.id'))
 		->asString();
 	}
+
+	public function testSortSpecification() {
+		$query = TestSelect::create()
+		->field('t.field')
+		->from('t', 'test')
+		->orderBy(new DBExprOrderBySpec(['field1', 'field2'], [['field2', 'ASC'], ['field1', 'DESC'], ['field3' => 'ASC']]))
+		->asString();
+
+		$this->assertEquals("SELECT\n\tt.field\nFROM\n\ttest t\nORDER BY\n\tfield2 ASC,\n\tfield1 DESC\n", $query);
+	}
 }