From 0cdad1072842d3968b93afece14fa3de567846ee Mon Sep 17 00:00:00 2001
From: Dragos Protung <dragos@protung.ro>
Date: Wed, 23 Dec 2015 15:46:57 +0100
Subject: [PATCH] Added support for PostgreSQL ST_MakeEnvelope

---
 CHANGELOG.md                                  |  1 +
 .../Functions/PostgreSql/STMakeEnvelope.php   | 49 +++++++++++
 .../PostgreSql/STMakeEnvelopeTest.php         | 86 +++++++++++++++++++
 tests/CrEOF/Spatial/Tests/OrmTestCase.php     |  1 +
 4 files changed, 137 insertions(+)
 create mode 100644 lib/CrEOF/Spatial/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelope.php
 create mode 100644 tests/CrEOF/Spatial/Tests/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelopeTest.php

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 031270b4..486f18da 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
+- Added support for PostgreSql ST_MakeEnvelope function.
 ### Changed
 ### Removed
 
diff --git a/lib/CrEOF/Spatial/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelope.php b/lib/CrEOF/Spatial/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelope.php
new file mode 100644
index 00000000..e1854f45
--- /dev/null
+++ b/lib/CrEOF/Spatial/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelope.php
@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Copyright (C) 2012 Derek J. Lambert
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql;
+
+use CrEOF\Spatial\ORM\Query\AST\Functions\AbstractSpatialDQLFunction;
+
+/**
+ * ST_MakeEnvelope DQL function
+ *
+ * @author  Dragos Protung
+ * @license http://dlambert.mit-license.org MIT
+ */
+class STMakeEnvelope extends AbstractSpatialDQLFunction
+{
+    protected $platforms = array('postgresql');
+
+    protected $functionName = 'ST_MakeEnvelope';
+
+    /**
+     * From Postgis 2.0, the 5th parameter (SRID) is not required.
+     *
+     * @var integer
+     */
+    protected $minGeomExpr = 4;
+
+    protected $maxGeomExpr = 5;
+}
diff --git a/tests/CrEOF/Spatial/Tests/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelopeTest.php b/tests/CrEOF/Spatial/Tests/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelopeTest.php
new file mode 100644
index 00000000..9e4d2262
--- /dev/null
+++ b/tests/CrEOF/Spatial/Tests/ORM/Query/AST/Functions/PostgreSql/STMakeEnvelopeTest.php
@@ -0,0 +1,86 @@
+<?php
+/**
+ * Copyright (C) 2015 Derek J. Lambert
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace CrEOF\Spatial\Tests\ORM\Query\AST\Functions\PostgreSql;
+
+use CrEOF\Spatial\PHP\Types\Geometry\LineString;
+use CrEOF\Spatial\PHP\Types\Geometry\Point;
+use CrEOF\Spatial\PHP\Types\Geometry\Polygon;
+use CrEOF\Spatial\Tests\Fixtures\PolygonEntity;
+use CrEOF\Spatial\Tests\OrmTestCase;
+use Doctrine\ORM\Query;
+
+/**
+ * ST_Area DQL function tests
+ *
+ * @author Dragos Protung
+ * @license http://dlambert.mit-license.org MIT
+ *
+ * @group dql
+ */
+class STMakeEnvelopeTest extends OrmTestCase
+{
+    protected function setUp()
+    {
+        $this->usesEntity(self::POLYGON_ENTITY);
+        $this->supportsPlatform('postgresql');
+
+        parent::setUp();
+    }
+
+    /**
+     * @group geometry
+     */
+    public function testSelectSTMakeEnvelope()
+    {
+        $entity = new PolygonEntity();
+        $rings = array(
+            new LineString(
+                array(
+                    new Point(0, 0),
+                    new Point(10, 0),
+                    new Point(10, 10),
+                    new Point(0, 10),
+                    new Point(0, 0),
+                )
+            ),
+        );
+
+        $entity->setPolygon(new Polygon($rings));
+        $this->getEntityManager()->persist($entity);
+
+        $this->getEntityManager()->flush();
+        $this->getEntityManager()->clear();
+
+        $query = $this->getEntityManager()->createQuery(
+            'SELECT ST_AsText(ST_MakeEnvelope(5,5, 10, 10)) FROM CrEOF\Spatial\Tests\Fixtures\PolygonEntity p'
+        );
+        $result = $query->getResult();
+
+        $expected = array(
+            array(1 => 'POLYGON((5 5,5 10,10 10,10 5,5 5))'),
+        );
+
+        $this->assertEquals($expected, $result);
+    }
+}
diff --git a/tests/CrEOF/Spatial/Tests/OrmTestCase.php b/tests/CrEOF/Spatial/Tests/OrmTestCase.php
index eb95a771..dd3f99f0 100644
--- a/tests/CrEOF/Spatial/Tests/OrmTestCase.php
+++ b/tests/CrEOF/Spatial/Tests/OrmTestCase.php
@@ -332,6 +332,7 @@ protected function setUpFunctions()
             $configuration->addCustomStringFunction('st_geomfromtext', 'CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql\STGeomFromText');
             $configuration->addCustomNumericFunction('st_length', 'CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql\STLength');
             $configuration->addCustomNumericFunction('st_linecrossingdirection', 'CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql\STLineCrossingDirection');
+            $configuration->addCustomStringFunction('st_makeenvelope', 'CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql\STMakeEnvelope');
             $configuration->addCustomStringFunction('st_startpoint', 'CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql\STStartPoint');
             $configuration->addCustomStringFunction('st_summary', 'CrEOF\Spatial\ORM\Query\AST\Functions\PostgreSql\STSummary');
         }