docs: add weather overview docs

Author: andrepimpao

docs/03-supported-apis.md

@@ -5,6 +5,7 @@
     - [getWeather](#getweather)
     - [getWeatherByDate](#getweatherbydate)
     - [getWeatherSummaryByDate](#getweathersummarybydate)
+    - [getWeatherOverviewByDate](#getweatheroverviewbydate)
   - [Weather](#weather)
     - [getCurrent](#getcurrent)
     - [getForecast](#getforecast)
@@ -68,6 +69,21 @@ Returns a [`WeatherSummary`](05-entities.md#weathersummary) object:
 $weatherSummary = $api->oneCall()->getWeatherSummaryByDate(50, 50, new \DateTime('1985-07-19'));
 ```
 
+#### `getWeatherOverviewByDate`
+
+```php
+getWeatherOverviewByDate(float $latitude, float $longitude, \DateTimeInterface $date): WeatherOverview
+```
+
+Get the weather overview with a human-readable summary for today and tomorrow's forecast, 
+using OpenWeather AI.
+
+Returns a [`WeatherOverview`](05-entities.md#weatheroverview) object:
+
+```php
+$weatherOverview = $api->oneCall()->getWeatherOverviewByDate(50, 50, new \DateTime('today'));
+```
+
 ### Weather
 
 #### `getCurrent`

docs/05-entities.md

@@ -78,6 +78,13 @@
 - `getAtmosphericPressure()`: `int`
 - `getWind()`: [`Wind`](#wind)
 
+### WeatherOverview
+
+- `getCoordinate()`: [`Coordinate`](#coordinate)
+- `getTimezone()`: [`Timezone`](#timezone)
+- `getDateTime()`: `\DateTimeImmutable`
+- `getOverview()`: `string`
+
 ### WeatherData
 
 - `getDateTime()`: `\DateTimeImmutable`

src/Entity/AirPollution/AirPollutionCollection.php

@@ -18,7 +18,7 @@ class AirPollutionCollection
 
     public function __construct(array $data)
     {
-        $this->numResults = \count($data['list']);
+        $this->numResults = count($data['list']);
         $this->coordinate = new Coordinate($data['coord']);
         $this->data = $this->createEntityList(AirPollutionData::class, $data['list']);
     }

src/Entity/AirPollution/AirQuality.php

@@ -28,12 +28,12 @@ private function findQualitativeName(int $index): string
     {
         // levels based on https://openweathermap.org/api/air-pollution
         return match ($index) {
-            0 => 'Undefined',
             1 => 'Good',
             2 => 'Fair',
             3 => 'Moderate',
             4 => 'Poor',
-            5 => 'Very Poor'
+            5 => 'Very Poor',
+            default => 'Undefined'
         };
     }
 }

src/Entity/OneCall/DayData.php

@@ -28,7 +28,7 @@ public function __construct(array $data)
 
         $this->temperature = new Temperature($data['temp']);
         $this->temperatureFeelsLike = new Temperature($data['feels_like']);
-        $this->precipitationProbability = \round($data['pop'] * 100);
+        $this->precipitationProbability = round($data['pop'] * 100);
         $this->summary = $data['summary'];
         $this->moonPhase = new MoonPhase($data);
         $this->moonriseAt = \DateTimeImmutable::createFromFormat('U', $data['moonrise']);

src/Entity/OneCall/HourData.php

@@ -19,7 +19,7 @@ public function __construct(array $data)
         $this->temperature = $data['temp'];
         $this->temperatureFeelsLike = $data['feels_like'];
         $this->visibility = $data['visibility'];
-        $this->precipitationProbability = \round($data['pop'] * 100);
+        $this->precipitationProbability = round($data['pop'] * 100);
     }
 
     public function getTemperature(): float

src/Entity/OneCall/MoonPhase.php

@@ -23,7 +23,7 @@ public function __construct(array $data)
     {
         $this->value = $data['moon_phase'];
         $this->systemName = $this->findSystemName($this->value);
-        $this->name = \ucwords(\strtolower(\str_replace('_', ' ', $this->systemName)));
+        $this->name = ucwords(strtolower(str_replace('_', ' ', $this->systemName)));
     }
 
     public function getValue(): float

src/Entity/Weather/WeatherData.php

@@ -54,7 +54,7 @@ public function __construct(array $data)
         $this->wind = new Wind($data['wind']);
 
         $this->precipitationProbability = isset($data['pop'])
-            ? \round($data['pop'] * 100)
+            ? round($data['pop'] * 100)
             : null;
 
         $this->rainVolume = $data['rain']['1h'] ?? $data['rain']['3h'] ?? null;