Consistent docblocks

Author: edwinvdpol

src/Casts/TimezonedDatetime.php

@@ -13,7 +13,7 @@
 class TimezonedDatetime implements CastsAttributes
 {
     /**
-     * A developer-specific format to use for string parsing
+     * A developer-specific format to use for string parsing.
      *
      * @var null|string
      */
@@ -22,7 +22,7 @@ class TimezonedDatetime implements CastsAttributes
     /**
      * Create a new casting instance.
      *
-     * @param null|string $format
+     * @param  null|string  $format
      * @return void
      */
     public function __construct(?string $format = null)
@@ -48,12 +48,12 @@ public function get($model, $key, $value, $attributes)
         if ($this->isTimestamp($model, $key)) {
             $value = Carbon::parse($value)->format($this->format ?? $model->getDateFormat());
         }
-        
+
         $original = Timezone::store($value, fn($raw, $tz) => $this->asDateTime($raw, $tz, $model));
 
         return Timezone::date($original);
     }
- 
+
     /**
      * Prepare the given value for storage.
      *
@@ -79,22 +79,22 @@ public function set($model, $key, $value, $attributes)
     }
 
     /**
-     * Check if the given key is part of the model's known timestamps
-     * 
-     * @param Model $model 
-     * @param string $key 
-     * @return bool 
+     * Check if the given key is part of the model's known timestamps.
+     *
+     * @param  Model  $model
+     * @param  string  $key
+     * @return bool
      */
     protected function isTimestamp(Model $model, string $key): bool
     {
         return $model->usesTimestamps() && in_array($key, $model->getDates());
     }
- 
+
     /**
-     * Create a new date value from raw material
+     * Create a new date value from raw material.
      *
      * @param  mixed  $value
-     * @param  Carbon\CarbonTimeZone  $timezone
+     * @param  \Carbon\CarbonTimeZone  $timezone
      * @param  \Illuminate\Database\Eloquent\Model  $model
      * @return \Carbon\CarbonInterface
      */
@@ -110,15 +110,14 @@ public function asDateTime($value, $timezone, $model)
     }
 
     /**
-     * Check if the provided value contains timezone information
-     * 
-     * @param mixed $value 
-     * @return bool 
+     * Check if the provided value contains timezone information.
+     *
+     * @param  mixed  $value
+     * @return bool
      */
     protected function hasTimezone(mixed $value): bool
     {
         return (is_string($value) && array_key_exists('zone', date_parse($value)))
             || (is_a($value, DateTime::class) && $value->getTimezone());
     }
-
 }

src/Concerns/HasTimezonedTimestamps.php

@@ -21,10 +21,10 @@ protected function isDateAttribute($key)
     }
 
     /**
-     * Check if key is a timezoned datetime cast
-     * 
-     * @param string $key 
-     * @return bool 
+     * Check if key is a timezoned datetime cast.
+     *
+     * @param  string  $key
+     * @return bool
      */
     protected function hasTimezonedDatetimeCast(string $key): bool
     {
@@ -37,8 +37,8 @@ protected function hasTimezonedDatetimeCast(string $key): bool
         $castClassName = explode(':', $cast)[0];
 
         return in_array(
-            $castClassName, 
+            $castClassName,
             [TimezonedDatetime::class, ImmutableTimezonedDatetime::class]
         );
     }
-}
+}

src/DatetimeParser.php

@@ -10,15 +10,15 @@ class DatetimeParser
     use HasAttributes;
 
     /**
-     * The model's date storage format
+     * The model's date storage format.
      */
     protected ?string $format;
 
     /**
-     * Parse the value into a carbon instance
-     * 
-     * @param mixed $value 
-     * @param null|string $format 
+     * Parse the value into a carbon instance.
+     *
+     * @param  mixed  $value
+     * @param  null|string  $format
      * @return CarbonInterface
      */
     public function parse(mixed $value, ?string $format): CarbonInterface
@@ -28,7 +28,6 @@ public function parse(mixed $value, ?string $format): CarbonInterface
         return $this->asDateTime($value);
     }
 
-
     /**
      * Get the format for database stored dates.
      *

src/Facades/Timezone.php

@@ -6,6 +6,11 @@
 
 class Timezone extends Facade
 {
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
     public static function getFacadeAccessor()
     {
         return \Whitecube\LaravelTimezones\Timezone::class;

src/Timezone.php

@@ -12,13 +12,13 @@ class Timezone
     use Macroable;
 
     /**
-     * The app's current display & manipulation timezone
+     * The app's current display & manipulation timezone.
      *
      * @var \Carbon\CarbonTimeZone
      */
     protected CarbonTimeZone $current;
     /**
-     * The app's current storage timezone
+     * The app's current storage timezone.
      *
      * @var \Carbon\CarbonTimeZone
      */
@@ -27,7 +27,7 @@ class Timezone
     /**
      * Create a new singleton instance.
      *
-     * @param string $default
+     * @param  string  $default
      * @return void
      */
     public function __construct(string $default)
@@ -41,7 +41,7 @@ public function __construct(string $default)
      *
      * Set the current application timezone.
      *
-     * @param mixed $timezone
+     * @param  mixed  $timezone
      * @return void
      */
     public function set($timezone = null)
@@ -52,7 +52,7 @@ public function set($timezone = null)
     /**
      * Set the current application timezone.
      *
-     * @param mixed $timezone
+     * @param  mixed  $timezone
      * @return void
      */
     public function setCurrent($timezone)
@@ -73,7 +73,7 @@ public function current(): CarbonTimeZone
     /**
      * Set the current database timezone.
      *
-     * @param mixed $timezone
+     * @param  mixed  $timezone
      * @return void
      */
     public function setStorage($timezone)
@@ -104,8 +104,8 @@ public function now(): CarbonInterface
     /**
      * Configure given date for the application's current timezone.
      *
-     * @param mixed $value
-     * @param null|callable $maker
+     * @param  mixed  $value
+     * @param  null|callable  $maker
      * @return \Carbon\CarbonInterface
      */
     public function date($value, callable $maker = null): CarbonInterface
@@ -116,8 +116,8 @@ public function date($value, callable $maker = null): CarbonInterface
     /**
      * Configure given date for the database storage timezone.
      *
-     * @param mixed $value
-     * @param null|callable $maker
+     * @param  mixed  $value
+     * @param  null|callable  $maker
      * @return \Carbon\CarbonInterface
      */
     public function store($value, callable $maker = null): CarbonInterface
@@ -128,7 +128,7 @@ public function store($value, callable $maker = null): CarbonInterface
     /**
      * Duplicate the given date and shift its timezone to the application's current timezone.
      *
-     * @param \Carbon\CarbonInterface
+     * @param  \Carbon\CarbonInterface  $date
      * @return \Carbon\CarbonInterface
      */
     protected function convertToCurrent(CarbonInterface $date): CarbonInterface
@@ -139,7 +139,7 @@ protected function convertToCurrent(CarbonInterface $date): CarbonInterface
     /**
      * Duplicate the given date and shift its timezone to the database's storage timezone.
      *
-     * @param \Carbon\CarbonInterface
+     * @param  \Carbon\CarbonInterface  $date
      * @return \Carbon\CarbonInterface
      */
     protected function convertToStorage(CarbonInterface $date): CarbonInterface
@@ -150,8 +150,8 @@ protected function convertToStorage(CarbonInterface $date): CarbonInterface
     /**
      * Create or configure date using the application's current timezone.
      *
-     * @param mixed $value
-     * @param null|callable $maker
+     * @param  mixed  $value
+     * @param  null|callable  $maker
      * @return \Carbon\CarbonInterface
      */
     protected function makeDateWithCurrent($value, callable $maker = null): CarbonInterface
@@ -164,8 +164,8 @@ protected function makeDateWithCurrent($value, callable $maker = null): CarbonIn
     /**
      * Create or configure date using the database's storage timezone.
      *
-     * @param mixed $value
-     * @param null|callable $maker
+     * @param  mixed  $value
+     * @param  null|callable  $maker
      * @return \Carbon\CarbonInterface
      */
     protected function makeDateWithStorage($value, callable $maker = null): CarbonInterface
@@ -178,9 +178,9 @@ protected function makeDateWithStorage($value, callable $maker = null): CarbonIn
     /**
      * Create a date using the provided timezone.
      *
-     * @param mixed $value
-     * @param \Carbon\CarbonTimeZone $timezone
-     * @param null|callable $maker
+     * @param  mixed  $value
+     * @param  \Carbon\CarbonTimeZone  $timezone
+     * @param  null|callable  $maker
      * @return \Carbon\CarbonInterface
      */
     protected function makeDate($value, CarbonTimeZone $timezone, callable $maker = null): CarbonInterface
@@ -193,7 +193,7 @@ protected function makeDate($value, CarbonTimeZone $timezone, callable $maker =
     /**
      * Create a Carbon timezone from given value.
      *
-     * @param mixed $value
+     * @param  mixed  $value
      * @return \Carbon\CarbonTimeZone
      */
     protected function makeTimezone($value): CarbonTimeZone