Added __toString on queries (#718)

Nyholm · web-flow · commit b132d4460882 · 2017-06-26T18:46:31.000+02:00
* Added __toString on queries

* Applied changes from StyleCI
diff --git a/src/Common/Query/GeocodeQuery.php b/src/Common/Query/GeocodeQuery.php
@@ -177,4 +177,20 @@ public function getAllData(): array
     {
         return $this->data;
     }
+
+    /**
+     * String for logging. This is also a unique key for the query
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf('GeocodeQuery: %s', json_encode([
+            'text' => $this->getText(),
+            'bounds' => $this->getBounds() ? $this->getBounds()->toArray() : 'null',
+            'locale' => $this->getLocale(),
+            'limit' => $this->getLimit(),
+            'data' => $this->getAllData(),
+        ]));
+    }
 }
diff --git a/src/Common/Query/ReverseQuery.php b/src/Common/Query/ReverseQuery.php
@@ -155,4 +155,20 @@ public function getAllData(): array
     {
         return $this->data;
     }
+
+    /**
+     * String for logging. This is also a unique key for the query
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf('ReverseQuery: %s', json_encode([
+            'lat' => $this->getCoordinates()->getLatitude(),
+            'lng' => $this->getCoordinates()->getLongitude(),
+            'locale' => $this->getLocale(),
+            'limit' => $this->getLimit(),
+            'data' => $this->getAllData(),
+        ]));
+    }
 }
diff --git a/src/Common/Tests/Query/GeocodeQueryTest.php b/src/Common/Tests/Query/GeocodeQueryTest.php
@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Geocoder package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Geocoder\Tests;
+
+use Geocoder\Query\GeocodeQuery;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class GeocodeQueryTest extends TestCase
+{
+    public function testToString()
+    {
+        $query = GeocodeQuery::create('foo');
+        $query = $query->withLocale('en');
+        $query = $query->withLimit(3);
+        $query = $query->withData('name', 'value');
+
+        $string = $query->__toString();
+        $this->assertContains('GeocodeQuery', $string);
+        $this->assertContains('"text":"foo"', $string);
+        $this->assertContains('"locale":"en"', $string);
+        $this->assertContains('"limit":3', $string);
+        $this->assertContains('"name":"value"', $string);
+    }
+}
diff --git a/src/Common/Tests/Query/ReverseQueryTest.php b/src/Common/Tests/Query/ReverseQueryTest.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Geocoder package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Geocoder\Tests;
+
+use Geocoder\Query\ReverseQuery;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class ReverseQueryTest extends TestCase
+{
+    public function testToString()
+    {
+        $query = ReverseQuery::fromCoordinates(1, 2);
+        $query = $query->withLocale('en');
+        $query = $query->withLimit(3);
+        $query = $query->withData('name', 'value');
+
+        $string = $query->__toString();
+        $this->assertContains('ReverseQuery', $string);
+        $this->assertContains('"lat":1', $string);
+        $this->assertContains('"lng":2', $string);
+        $this->assertContains('"locale":"en"', $string);
+        $this->assertContains('"limit":3', $string);
+        $this->assertContains('"name":"value"', $string);
+    }
+}
