Create interface for Query (#741)

Nyholm · web-flow · commit 1433c179745f · 2017-07-17T11:17:59.000+02:00
* Create interface for Query

* Applied changes from StyleCI

* Removed return type
diff --git a/src/Common/Query/GeocodeQuery.php b/src/Common/Query/GeocodeQuery.php
@@ -19,7 +19,7 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-final class GeocodeQuery
+final class GeocodeQuery implements Query
 {
     /**
      * The address or text that should be geocoded.
diff --git a/src/Common/Query/Query.php b/src/Common/Query/Query.php
@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Query;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+interface Query
+{
+    /**
+     * @param string $locale
+     *
+     * @return Query
+     */
+    public function withLocale(string $locale);
+
+    /**
+     * @param int $limit
+     *
+     * @return Query
+     */
+    public function withLimit(int $limit);
+
+    /**
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return Query
+     */
+    public function withData(string $name, $value);
+
+    /**
+     * @return string|null
+     */
+    public function getLocale();
+
+    /**
+     * @return int
+     */
+    public function getLimit(): int;
+
+    /**
+     * @param string     $name
+     * @param mixed|null $default
+     *
+     * @return mixed
+     */
+    public function getData(string $name, $default = null);
+
+    /**
+     * @return array
+     */
+    public function getAllData(): array;
+
+    /**
+     * @return string
+     */
+    public function __toString();
+}
diff --git a/src/Common/Query/ReverseQuery.php b/src/Common/Query/ReverseQuery.php
@@ -18,7 +18,7 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-final class ReverseQuery
+final class ReverseQuery implements Query
 {
     /**
      * @var Coordinates

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`/**`
`20`	`20`	`* @author Tobias Nyholm <[email protected]>`
`21`	`21`	`*/`
`22`		`-final class GeocodeQuery`
	`22`	`+final class GeocodeQuery implements Query`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`	`25`	`* The address or text that should be geocoded.`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`/**`
`19`	`19`	`* @author Tobias Nyholm <[email protected]>`
`20`	`20`	`*/`
`21`		`-final class ReverseQuery`
	`21`	`+final class ReverseQuery implements Query`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* @var Coordinates`