arrays are now returned as Illiuminate Collections; new exception add…

…ed for Invalid API request

composer.json

@@ -21,9 +21,10 @@
     ]
   },
   "require": {
-    "php": "^8.1",
+    "php": "^8.2",
     "guzzlehttp/guzzle": "^7.8",
     "nesbot/carbon": "^3.2",
-    "phpfastcache/phpfastcache": "^9.2"
+    "phpfastcache/phpfastcache": "^9.2",
+    "illuminate/collections": "^11.6"
   }
 }

readme.md

@@ -9,7 +9,7 @@ composer require benjaminhansen/nws-php
 
 ## Usage
 Notes
-* Requires PHP 8.1 or greater
+* Requires PHP 8.2 or greater
 * All requests can be cached locally to reduce outbound requests to the API endpoint
 * All datetime fields are automatically returned as a <code>Carbon</code> object
 * Any timezone fields are automatically returned as a PHP <code>DateTimeZone</code> object

src/Api.php

@@ -7,6 +7,7 @@
 use NWS\Features\Point;
 use NWS\Features\ForecastOffice;
 use NWS\Features\ObservationStation;
+use NWS\Exceptions\InvalidRequestException;
 use DateTimeZone;
 
 class Api
@@ -164,5 +165,7 @@ public function getLocation(float $lat = null, float $lon = null, string $observ
             $url = "{$this->base_url}/offices/{$forecast_office}";
             return new ForecastOffice($this->get($url), $this);
         }
+
+        throw new InvalidRequestException("Invalid API request!");
     }
 }

src/Exceptions/InvalidRequestException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace NWS\Exceptions;
+
+use Exception;
+
+class InvalidRequestException extends Exception
+{
+    //
+}

src/Features/Alerts.php

@@ -4,6 +4,7 @@
 
 use NWS\Traits\IsCallable;
 use NWS\Support\Carbon;
+use Illuminate\Support\Collection;
 
 class Alerts
 {
@@ -30,22 +31,22 @@ public function updatedAt(): Carbon
 
     public function hasAlerts(): bool
     {
-        return (boolean)count($this->data->features);
+        return (boolean) $this->count();
     }
 
     public function count(): int
     {
         return count($this->data->features);
     }
 
-    public function get(): array
+    public function get(): Collection
     {
         $return = [];
 
         foreach($this->data->features as $alert) {
             $return[] = new Alert($alert, $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 }

src/Features/FireZone.php

@@ -4,6 +4,7 @@
 
 use DateTimeZone;
 use NWS\Traits\IsCallable;
+use Illuminate\Support\Collection;
 
 class FireZone
 {
@@ -23,31 +24,31 @@ public function timezone(): DateTimeZone
         return new DateTimeZone($this->data->properties->timeZone);
     }
 
-    public function forecastOffices(): array
+    public function forecastOffices(): Collection
     {
         $return = [];
 
         foreach($this->data->properties->forecastOffices as $office) {
             $return[] = new ForecastOffice($this->api->get($office), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
     public function forecastOffice(int $i = 0): ForecastOffice
     {
         return $this->forecastOffices()[$i];
     }
 
-    public function observationStations(): array
+    public function observationStations(): Collection
     {
         $return = [];
 
         foreach($this->data->properties->observationStations as $station) {
             $return[] = new ObservationStation($this->api->get($station), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
     public function observationStation(int $i = 0): ObservationStation

src/Features/ForecastGridData.php

@@ -5,6 +5,7 @@
 use NWS\Traits\IsCallable;
 use NWS\Support\Helpers;
 use NWS\Support\Carbon;
+use Illuminate\Support\Collection;
 
 class ForecastGridData
 {
@@ -49,7 +50,7 @@ public function gridY(): int
         return $this->data->properties->gridY;
     }
 
-    public function temeratures(string $unit = 'f', int $decimal_points = 0): array
+    public function temeratures(string $unit = 'f', int $decimal_points = 0): Collection
     {
         $return = [];
 
@@ -66,6 +67,6 @@ public function temeratures(string $unit = 'f', int $decimal_points = 0): array
             ];
         }
 
-        return $return;
+        return collect($return);
     }
 }

src/Features/ForecastHourly.php

@@ -5,6 +5,7 @@
 use NWS\Support\Coordinate;
 use NWS\Traits\IsCallable;
 use NWS\Support\Carbon;
+use Illuminate\Support\Collection;
 
 class ForecastHourly
 {
@@ -44,7 +45,7 @@ public function period($i): ForecastPeriod
         return (new ForecastPeriods($this->data->properties->periods, $this->api))->period($i);
     }
 
-    public function coordinates(): array
+    public function coordinates(): Collection
     {
         $return = [];
 
@@ -56,6 +57,6 @@ public function coordinates(): array
             }
         }
 
-        return $return;
+        return collect($return);
     }
 }

src/Features/ForecastOffice.php

@@ -3,6 +3,7 @@
 namespace NWS\Features;
 
 use NWS\Traits\IsCallable;
+use Illuminate\Support\Collection;
 
 class ForecastOffice
 {
@@ -47,47 +48,47 @@ public function address(): string
         return $this->data->address;
     }
 
-    public function counties(): array
+    public function counties(): Collection
     {
         $return = [];
 
         foreach($this->data->responsibleCounties as $county) {
             $return[] = new County($this->api->get($county), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
-    public function forecastZones(): array
+    public function forecastZones(): Collection
     {
         $return = [];
 
         foreach($this->data->responsibleForecastZones as $zone) {
             $return[] = new ForecastZone($this->api->get($zone), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
-    public function observationStations(): array
+    public function observationStations(): Collection
     {
         $return = [];
 
         foreach($this->data->approvedObservationStations as $station) {
             $return[] = new ObservationStation($this->api->get($station), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
-    public function fireZones(): array
+    public function fireZones(): Collection
     {
         $return = [];
 
         foreach($this->data->responsibleFireZones as $zone) {
             $return[] = new FireZone($this->api->get($zone), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 }

src/Features/ForecastPeriods.php

@@ -3,6 +3,7 @@
 namespace NWS\Features;
 
 use NWS\Traits\IsCallable;
+use Illuminate\Support\Collection;
 
 class ForecastPeriods
 {
@@ -17,15 +18,15 @@ public function __construct($data, $api)
         $this->api = $api;
     }
 
-    public function get(): array
+    public function get(): Collection
     {
         $return = [];
 
         foreach($this->data as $period) {
             $return[] = new ForecastPeriod($period, $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
     public function period(int $i): ForecastPeriod

src/Features/ForecastZone.php

@@ -4,6 +4,7 @@
 
 use DateTimeZone;
 use NWS\Traits\IsCallable;
+use Illuminate\Support\Collection;
 
 class ForecastZone
 {
@@ -23,15 +24,15 @@ public function timezone(int $i = 0): DateTimeZone
         return $this->timezones()[$i];
     }
 
-    public function timezones(): array
+    public function timezones(): Collection
     {
         $return = [];
 
         foreach($this->data->properties->timeZone as $timezone) {
             $return[] = new DateTimeZone($timezone);
         }
 
-        return $return;
+        return collect($return);
     }
 
     public function id(): string
@@ -65,15 +66,15 @@ public function observationStation(int $i = 0): ObservationStation
         return $this->observationStations()[$i];
     }
 
-    public function forecastOffices(): array
+    public function forecastOffices(): Collection
     {
         $return = [];
 
         foreach($this->data->properties->forecastOffices as $office) {
             $return[] = new ForecastOffice($this->api->get($office), $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
     public function forecastOffice(int $i = 0): ForecastOffice

src/Features/ObservationStations.php

@@ -3,6 +3,7 @@
 namespace NWS\Features;
 
 use NWS\Traits\IsCallable;
+use Illuminate\Support\Collection;
 
 class ObservationStations
 {
@@ -17,15 +18,15 @@ public function __construct($data, $api)
         $this->api = $api;
     }
 
-    public function get(): array
+    public function get(): Collection
     {
         $return = [];
 
         foreach($this->data->features as $station) {
             $return[] = new ObservationStation($station, $this->api);
         }
 
-        return $return;
+        return collect($return);
     }
 
     public function station(int $i = 0): ObservationStation