#14 - Add between expression

Author: technicalguru

src/TgDatabase/Criterion/BetweenExpression.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace TgDatabase\Criterion;
+
+use TgDatabase\Criteria;
+use TgDatabase\Criterion;
+
+class BetweenExpression implements Criterion {
+
+	public function __construct($propertyName, $minValue, $maxValue, $ignoreCase = FALSE) {
+		$this->propertyName = $propertyName;
+		$this->minValue     = $minValue;
+		$this->maxValue     = $maxValue;
+		$this->ignoreCase   = $ignoreCase;
+	}
+
+	/**
+	  * Impose case-insensitive restriction.
+	  */
+	public function ignoreCase() {
+		$this->ignoreCase = TRUE;
+		return $this;
+	}
+
+	/**
+	  * Render the SQL fragment.
+	  * @param Criteria $localCriteria   - local criteria object (e.g. subquery)
+	  * @param Criteria $overallCriteria - overall criteria object
+	  * @return string - the SQL fragment representing this criterion.
+	  */
+	public function toSqlString($localCriteria, $overallCriteria) {
+		$lower = $this->ignoreCase && is_string($this->minValue) && is_string($this->maxValue);
+
+		$rc = '';
+		if ($lower) {
+			$rc .= 'LOWER(';
+		}
+		$rc .= $overallCriteria->quoteName($localCriteria->getAlias(), $this->propertyName);
+		if ($lower) {
+			$rc .= ')';
+		}
+		$rc .= ' BETWEEN ';
+		$rc .= $overallCriteria->prepareValue($this->minValue, $lower);
+		$rc .= ' AND ';
+		$rc .= $overallCriteria->prepareValue($this->maxValue, $lower);
+		return $rc;
+	}
+	
+}

src/TgDatabase/Restrictions.php

@@ -9,6 +9,7 @@
 use TgDatabase\Criterion\InExpression;
 use TgDatabase\Criterion\NotInExpression;
 use TgDatabase\Criterion\PropertyExpression;
+use TgDatabase\Criterion\BetweenExpression;
 
 /**
   * Provides the built-in citerions.
@@ -80,6 +81,13 @@ public static function le($propertyName, $value) {
 		return new SimpleExpression($propertyName, $value, '<=');
 	}
 
+	/**
+	  * Apply a "between" constraint to the named property.
+	  */
+	public static function between($propertyName, $minValue, $maxValue) {
+		return new BetweenExpression($propertyName, $minValue, $maxValue);
+	}
+
 	/**
 	  * Apply a "is null" constraint to the named property.
 	  */

tests/TgDatabase/RestrictionsTest.php

@@ -66,6 +66,16 @@ public function testle(): void {
         $this->testSqlString('`aName` <= \'aValue\'', $expr);
     }
 
+    public function testBetween(): void {
+        $expr = Restrictions::between('aName', 'aValue1', 'aValue2');
+        $this->testSqlString('`aName` BETWEEN \'aValue1\' AND \'aValue2\'', $expr);
+    }
+        
+    public function testBetweenIgnoreCase(): void {
+        $expr = Restrictions::between('aName', 'aValue1', 'aValue2')->ignoreCase();
+        $this->testSqlString('LOWER(`aName`) BETWEEN \'avalue1\' AND \'avalue2\'', $expr);
+    }
+        
     public function testIsNull(): void {
         $expr = Restrictions::isNull('aName');
         $this->testSqlString('`aName` IS NULL', $expr);