Add type hints & remove unnecessary comment type hints

Author: olivervogel

phpcs.xml

@@ -75,6 +75,10 @@
         </properties>
     </rule>
     <rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint"/>
     <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>

src/Calculator.php

@@ -97,9 +97,7 @@ public static function compare(ZodiacInterface $zodiac1, ZodiacInterface $zodiac
     /**
      * Normalze given date to Carbon object
      *
-     * @param string|DateTimeInterface $date
      * @throws NotReadableException
-     * @return ZodiacComparableDate
      */
     private function normalizeDate(int|string|DateTimeInterface $date): ZodiacComparableDate
     {

src/Compatibility.php

@@ -196,10 +196,6 @@ class Compatibility
 
     /**
      * Calculate zodiac sign compatibility between two signs
-     *
-     * @param ZodiacInterface $a
-     * @param ZodiacInterface $b
-     * @return float
      */
     public function __invoke(ZodiacInterface $a, ZodiacInterface $b): float
     {

src/Interfaces/CalculatorInterface.php

@@ -10,18 +10,11 @@ interface CalculatorInterface
 {
     /**
      * Get zodiac for given date
-     *
-     * @param int|string|DateTimeInterface $date
-     * @return ZodiacInterface
      */
     public static function zodiac(int|string|DateTimeInterface $date): ZodiacInterface;
 
     /**
      * Calculate zodiac sign compatibility between given objects
-     *
-     * @param ZodiacInterface $zodiac1
-     * @param ZodiacInterface $zodiac2
-     * @return float
      */
     public static function compare(ZodiacInterface $zodiac1, ZodiacInterface $zodiac2): float;
 }

src/Interfaces/TranslatableInterface.php

@@ -10,17 +10,11 @@ interface TranslatableInterface
 {
     /**
      * Get translator for given locale
-     *
-     * @param null|string $locale
-     * @return Translator
      */
     public function translator(?string $locale = null): Translator;
 
     /**
      * Set translator on current object
-     *
-     * @param Translator $translator
-     * @return CalculatorInterface|ZodiacInterface
      */
     public function setTranslator(Translator $translator): CalculatorInterface|ZodiacInterface;
 }

src/Interfaces/ZodiacInterface.php

@@ -10,39 +10,28 @@ interface ZodiacInterface
 {
     /**
      * Return the start date of the current zodiac sign
-     *
-     * @return Carbon
      */
     public function start(): Carbon;
 
     /**
      * Return the end date of the current zodiac sign
-     *
-     * @return Carbon
      */
     public function end(): Carbon;
 
     /**
      * Return the name of the current zodiac. This is more a identification key
      * than a textual title.
-     *
-     * @return string
      */
     public function name(): string;
 
     /**
      * Return the HTML UTF-8 symbol code representing an icon of the current zodiac sign.
-     *
-     * @return string
      */
     public function html(): string;
 
     /**
      * Return the localized title of the current zodiac in the given locale.
      * The locale parameter is optional, by default the english language is returned.
-     *
-     * @param null|string $locale
-     * @return null|string
      */
     public function localized(?string $locale = null): ?string;
 
@@ -51,16 +40,11 @@ public function localized(?string $locale = null): ?string;
      * where 0 means no match and a maximum of 10 is a total match.
      *
      * Completely made up :) Don't plan your life around it.
-     *
-     * @param ZodiacInterface $zodiac
-     * @return float
      */
     public function compatibility(self $zodiac): float;
 
     /**
      * Cast current object to string
-     *
-     * @return string
      */
     public function __toString(): string;
 }

src/Laravel/Traits/CanResolveZodiac.php

@@ -10,7 +10,7 @@
 
 trait CanResolveZodiac
 {
-    protected $birthdayAttribute = 'birthday';
+    protected string $birthdayAttribute = 'birthday';
 
     public function getZodiacAttribute(): ?ZodiacInterface
     {

src/Laravel/ZodiacBridge.php

@@ -25,13 +25,11 @@ public function __construct(protected Application $app)
     /**
      * Create zodiac from input date
      *
-     * @param int|string|DateTimeInterface $date
      * @throws NotReadableException
      * @throws InvalidArgumentException
      * @throws ReflectionException
      * @throws RuntimeException
      * @throws BindingResolutionException
-     * @return ZodiacInterface
      */
     public function make(int|string|DateTimeInterface $date): ZodiacInterface
     {
@@ -44,7 +42,6 @@ public function make(int|string|DateTimeInterface $date): ZodiacInterface
     /**
      * @throws BindingResolutionException
      * @throws RuntimeException
-     * @return Translator
      */
     private function translator(): Translator
     {

src/Laravel/ZodiacFacade.php

@@ -8,6 +8,10 @@
 
 class ZodiacFacade extends Facade
 {
+    /**
+     * @return string
+     */
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.ReturnTypeHint
     protected static function getFacadeAccessor()
     {
         return 'zodiac';

src/Laravel/ZodiacServiceProvider.php

@@ -11,28 +11,22 @@ class ZodiacServiceProvider extends ServiceProvider
 {
     /**
      * Indicates if loading of the provider is deferred.
-     *
-     * @var bool
      */
-    protected $defer = true;
+    protected bool $defer = true;
 
     /**
      * Bootstrap the application events.
-     *
-     * @return void
      */
-    public function boot()
+    public function boot(): void
     {
         // load translation files
         $this->loadTranslationsFrom(__DIR__ . '/../lang', 'zodiacs');
     }
 
     /**
      * Register the service provider.
-     *
-     * @return void
      */
-    public function register()
+    public function register(): void
     {
         $this->app->singleton('zodiac', fn(Application $app): ZodiacBridge => new ZodiacBridge($app));
     }
@@ -42,6 +36,7 @@ public function register()
      *
      * @return array<string>
      */
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.ReturnTypeHint
     public function provides()
     {
         return ['zodiac'];