Merge pull request #8 from Luke-Shepp/feature/language-selection

Add ability to fetch translated Loqate address
Cyber-Duck · Mar 6, 2023 · e42dd11 · e42dd11
2 parents 01812b3 + f363893
commit e42dd11
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 26 deletions.
diff --git a/src/AddressFinder.php b/src/AddressFinder.php
@@ -25,11 +25,12 @@ public function suggestions($query, $country, $group_id)
     /**
      * @param $addressId
      * @param bool $raw
+     * @param bool $translated
      * @return Details|array
      */
-    public function details($addressId, bool $raw = false)
+    public function details($addressId, bool $raw = false, bool $translated = false)
     {
-        return $this->addressEngine()->getDetails($addressId, $raw);
+        return $this->addressEngine()->getDetails($addressId, $raw, $translated);
     }
 
     /**

diff --git a/src/Drivers/DriverContract.php b/src/Drivers/DriverContract.php
@@ -18,7 +18,8 @@ public function suggestions($query, $country, $group_id): Suggestions;
     /**
      * @param $id
      * @param bool $raw
+     * @param bool $translated
      * @return Details
      */
-    public function getDetails($id, bool $raw = false);
+    public function getDetails($id, bool $raw = false, bool $translated = false);
 }
diff --git a/src/Drivers/LoqateDriver.php b/src/Drivers/LoqateDriver.php
@@ -37,7 +37,7 @@ public function __construct()
         $config = config('laravel-address-finder.loqate');
         $this->suggestionsEndpoint = $config['api']['endpoints']['suggestions'];
         $this->detailsEndpoint = $config['api']['endpoints']['details'];
-        $this->client =  Http::withOptions([
+        $this->client = Http::withOptions([
             'base_uri' => $config['api']['base_uri'],
             'query' => [
                 'Key' => $config['api']['key'],
@@ -69,9 +69,7 @@ public function suggestions($query, $country, $group_id): Suggestions
      */
     public function parseSuggestions($response)
     {
-        /**
-         * @var $suggestions Suggestions
-         */
+        /** @var Suggestions $suggestions */
         $suggestions = app(Suggestions::class);
 
         foreach ($response['Items'] ?? [] as $item) {
@@ -92,29 +90,32 @@ public function parseSuggestions($response)
 
     /**
      * @param $id
+     * @param bool $raw
+     * @param bool $translated
      * @return Details
      */
-    public function getDetails($id, $raw = false)
+    public function getDetails($id, bool $raw = false, bool $translated = false)
     {
         return $this->parseDetails($this->client->get(
             $this->detailsEndpoint,
             ['Id' => $id]
-        )->json(), $raw);
+        )->json(), $raw, $translated);
     }
 
     /**
      * @param $response
+     * @param bool $raw
+     * @param bool $translated
      * @return Details|array
      */
-    public function parseDetails($response, $raw = false)
+    public function parseDetails($response, bool $raw = false, bool $translated = false)
     {
-
-        /**
-         * @var $details Details
-         */
+        /** @var Details $details */
         $details = app(Details::class);
 
-        $addressDetails = array_first($response['Items']) ?? null;
+        $addressDetails = array_first($response['Items'], function ($item) use ($translated) {
+            return ! $translated || $item['Language'] === 'ENG';
+        });
 
         if (! $addressDetails) {
             return $details;

diff --git a/src/Drivers/MockDriver.php b/src/Drivers/MockDriver.php
@@ -139,9 +139,7 @@ private function getAddressChildrenResponse()
      */
     public function parseSuggestions($response)
     {
-        /**
-         * @var $suggestions Suggestions
-         */
+        /** @var Suggestions $suggestions */
         $suggestions = app(Suggestions::class);
 
         foreach($response['Items'] ?? [] as $item) {
@@ -162,9 +160,11 @@ public function parseSuggestions($response)
 
     /**
      * @param $id
+     * @param bool $raw
+     * @param bool $translated
      * @return Details
      */
-    public function getDetails($id, bool $raw = false)
+    public function getDetails($id, bool $raw = false, bool $translated = false)
     {
         $addresses = [
             'default' => [
@@ -385,23 +385,23 @@ public function getDetails($id, bool $raw = false)
 
         ];
 
-        return $this->parseDetails($addresses[$id], $raw);
+        return $this->parseDetails($addresses[$id], $raw, $translated);
     }
 
     /**
      * @param $response
+     * @param bool $raw
+     * @param bool $translated
      * @return Details|array
      */
-    public function parseDetails($response, bool $raw = false)
+    public function parseDetails($response, bool $raw = false, bool $translated = false)
     {
-        /**
-         * @var $details Details
-         */
+        /** @var Details $details */
         $details = app(Details::class);
 
         $addressDetails = array_first($response['Items']) ?? null;
 
-        if (!$addressDetails) {
+        if (! $addressDetails) {
             return $details;
         }
 

diff --git a/src/Facades/Address.php b/src/Facades/Address.php
@@ -8,7 +8,7 @@
 
 /**
  * @method static Suggestions suggestions($query, $country, $group_id)
- * @method static Details details($id, $raw = false)
+ * @method static Details details($id, bool $raw = false, bool $translated = false)
  *
  * @see \CyberDuck\AddressFinder\AddressFinder
  *