Added docblocks

voidgraphics · voidgraphics · commit f5ada1e6a5fe · 2023-04-27T11:40:23.000+02:00
diff --git a/src/Casts/TimezonedDatetime.php b/src/Casts/TimezonedDatetime.php
@@ -5,7 +5,6 @@
 use Whitecube\LaravelTimezones\Facades\Timezone;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Carbon\Carbon;
-use Carbon\CarbonInterface;
 use DateTime;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Database\Eloquent\Model;
@@ -81,6 +80,7 @@ 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 
@@ -109,7 +109,13 @@ public function asDateTime($value, $timezone, $model)
         return $date->shiftTimezone($timezone);
     }
 
-    protected function hasTimezone($value): 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());
diff --git a/src/Concerns/HasTimezonedTimestamps.php b/src/Concerns/HasTimezonedTimestamps.php
@@ -21,8 +21,11 @@ protected function isDateAttribute($key)
 
     /**
      * Check if key is a timezoned datetime cast
+     * 
+     * @param string $key 
+     * @return bool 
      */
-    protected function hasTimezonedDatetimeCast($key)
+    protected function hasTimezonedDatetimeCast(string $key): bool
     {
         $casts = $this->getCasts();
 
diff --git a/src/DatetimeParser.php b/src/DatetimeParser.php
@@ -9,8 +9,18 @@ class DatetimeParser
 {
     use HasAttributes;
 
+    /**
+     * The model's date storage format
+     */
     protected ?string $format;
 
+    /**
+     * Parse the value into a carbon instance
+     * 
+     * @param mixed $value 
+     * @param null|string $format 
+     * @return Carbon 
+     */
     public function parse(mixed $value, ?string $format): Carbon
     {
         $this->format = $format;
