Merge pull request #12 from edwinvdpol/feature/arguments-return-types

Argument- and return typehints

Author: toonvandenbos

src/Casts/TimezonedDatetime.php

@@ -5,6 +5,8 @@
 use Whitecube\LaravelTimezones\Facades\Timezone;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Carbon\Carbon;
+use Carbon\CarbonInterface;
+use Carbon\CarbonTimeZone;
 use DateTime;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Database\Eloquent\Model;
@@ -39,7 +41,7 @@ public function __construct(?string $format = null)
      * @param  array  $attributes
      * @return \Carbon\CarbonInterface
      */
-    public function get($model, $key, $value, $attributes)
+    public function get(Model $model, string $key, mixed $value, array $attributes)
     {
         if(!$value && $value !== 0) {
             return null;
@@ -63,7 +65,7 @@ public function get($model, $key, $value, $attributes)
      * @param  array  $attributes
      * @return string
      */
-    public function set($model, $key, $value, $attributes)
+    public function set(Model $model, string $key, mixed $value, array $attributes)
     {
         if(!$value && $value !== 0) {
             return null;
@@ -98,7 +100,7 @@ protected function isTimestamp(Model $model, string $key): bool
      * @param  \Illuminate\Database\Eloquent\Model  $model
      * @return \Carbon\CarbonInterface
      */
-    public function asDateTime($value, $timezone, $model)
+    public function asDateTime(mixed $value, CarbonTimeZone $timezone, Model $model): CarbonInterface
     {
         $date = (new DatetimeParser)->parse($value, $this->format ?? $model->getDateFormat());
 

src/Concerns/HasTimezonedTimestamps.php

@@ -13,7 +13,7 @@ trait HasTimezonedTimestamps
      * @param  string  $key
      * @return bool
      */
-    protected function isDateAttribute($key)
+    protected function isDateAttribute($key): bool
     {
         return (in_array($key, $this->getDates(), true) ||
             $this->isDateCastable($key)) &&

src/DatetimeParser.php

@@ -34,7 +34,7 @@ public function parse(mixed $value, ?string $format): CarbonInterface
      *
      * @return string
      */
-    public function getDateFormat()
+    public function getDateFormat(): ?string
     {
         return $this->format;
     }

src/Timezone.php

@@ -44,7 +44,7 @@ public function __construct(string $default)
      * @param mixed $timezone
      * @return void
      */
-    public function set($timezone = null)
+    public function set(mixed $timezone = null): void
     {
         $this->setCurrent($timezone);
     }
@@ -55,7 +55,7 @@ public function set($timezone = null)
      * @param mixed $timezone
      * @return void
      */
-    public function setCurrent($timezone)
+    public function setCurrent(mixed $timezone): void
     {
         $this->current = $this->makeTimezone($timezone);
     }
@@ -76,7 +76,7 @@ public function current(): CarbonTimeZone
      * @param mixed $timezone
      * @return void
      */
-    public function setStorage($timezone)
+    public function setStorage(mixed $timezone): void
     {
         $this->storage = $this->makeTimezone($timezone);
     }
@@ -108,7 +108,7 @@ public function now(): CarbonInterface
      * @param null|callable $maker
      * @return \Carbon\CarbonInterface
      */
-    public function date($value, callable $maker = null): CarbonInterface
+    public function date(mixed $value, callable $maker = null): CarbonInterface
     {
         return $this->makeDateWithCurrent($value, $maker);
     }
@@ -120,7 +120,7 @@ public function date($value, callable $maker = null): CarbonInterface
      * @param null|callable $maker
      * @return \Carbon\CarbonInterface
      */
-    public function store($value, callable $maker = null): CarbonInterface
+    public function store(mixed $value, callable $maker = null): CarbonInterface
     {
         return $this->makeDateWithStorage($value, $maker);
     }
@@ -154,7 +154,7 @@ protected function convertToStorage(CarbonInterface $date): CarbonInterface
      * @param null|callable $maker
      * @return \Carbon\CarbonInterface
      */
-    protected function makeDateWithCurrent($value, callable $maker = null): CarbonInterface
+    protected function makeDateWithCurrent(mixed $value, callable $maker = null): CarbonInterface
     {
         return is_a($value, CarbonInterface::class)
             ? $this->convertToCurrent($value)
@@ -168,7 +168,7 @@ protected function makeDateWithCurrent($value, callable $maker = null): CarbonIn
      * @param null|callable $maker
      * @return \Carbon\CarbonInterface
      */
-    protected function makeDateWithStorage($value, callable $maker = null): CarbonInterface
+    protected function makeDateWithStorage(mixed $value, callable $maker = null): CarbonInterface
     {
         return is_a($value, CarbonInterface::class)
             ? $this->convertToStorage($value)
@@ -183,7 +183,7 @@ protected function makeDateWithStorage($value, callable $maker = null): CarbonIn
      * @param null|callable $maker
      * @return \Carbon\CarbonInterface
      */
-    protected function makeDate($value, CarbonTimeZone $timezone, callable $maker = null): CarbonInterface
+    protected function makeDate(mixed $value, CarbonTimeZone $timezone, callable $maker = null): CarbonInterface
     {
         return ($maker)
             ? call_user_func($maker, $value, $timezone)
@@ -196,7 +196,7 @@ protected function makeDate($value, CarbonTimeZone $timezone, callable $maker =
      * @param mixed $value
      * @return \Carbon\CarbonTimeZone
      */
-    protected function makeTimezone($value): CarbonTimeZone
+    protected function makeTimezone(mixed $value): CarbonTimeZone
     {
         if(! is_a($value, CarbonTimeZone::class)) {
             $value = new CarbonTimeZone($value);