Merge pull request #62 from codebyray/php_84_adjustments

fix: resolve PHP 8.4 implicitly nullable param deprecations

Author: codebyray

src/Contracts/ReviewRateableContract.php

@@ -26,61 +26,65 @@ public function addReview(array $data, ?int $userId = null): mixed;
     /**
      * Update a review by its ID.
      *
-     * @param int   $reviewId
-     * @param array $data
+     * @param  int|null   $reviewId
+     * @param  array|null $data
      * @return bool
      */
-    public function updateReview(int $reviewId = null, array $data = null): bool;
+    public function updateReview(?int $reviewId = null, ?array $data = null): bool;
 
     /**
      * Mark a review as approved by its ID.
      *
-     * @param int $reviewId
+     * @param  int|null $reviewId
      * @return bool
      */
-    public function approveReview(int $reviewId = null): bool;
+    public function approveReview(?int $reviewId = null): bool;
 
     /**
      * Get the average rating for a given key.
      *
-     * @param string $key
-     * @param bool $approved
+     * @param  string|null $key
+     * @param  bool        $approved
      * @return float|null
      */
-    public function averageRating(string $key = null, bool $approved = true): ?float;
+    public function averageRating(?string $key = null, bool $approved = true): ?float;
 
     /**
      * Get overall average ratings for all keys.
      *
-     * @param bool $approved
+     * @param  bool $approved
      * @return array
      */
     public function averageRatings(bool $approved = true): array;
 
     /**
      * Get the average rating for a given key within a department.
      *
-     * @param string $department
-     * @param string $key
-     * @param bool $approved
+     * @param  string      $department
+     * @param  string|null $key
+     * @param  bool        $approved
      * @return float|null
      */
-    public function averageRatingByDepartment(string $department = "default", string $key = null, bool $approved = true): ?float;
+    public function averageRatingByDepartment(
+        string $department = "default",
+        ?string $key = null,
+        bool $approved = true
+    ): ?float;
 
     /**
      * Get overall average ratings for all keys within a department.
      *
-     * @param string $department
-     * @param bool $approved
+     * @param  string $department
+     * @param  bool   $approved
      * @return array
      */
     public function averageRatingsByDepartment(string $department = "default", bool $approved = true): array;
 
     /**
      * Get all reviews (with attached ratings) for the attached model.
      *
-     * @param bool $approved
-     * @param bool $withRatings
+     * @param  bool $approved
+     * @param  bool $withRatings
      * @return Collection
      */
     public function getReviews(bool $approved = true, bool $withRatings = true): Collection;
@@ -89,52 +93,56 @@ public function getReviews(bool $approved = true, bool $withRatings = true): Col
      * Get all reviews (with attached ratings) for a department,
      * filtered by the approved status.
      *
-     * @param string $department
-     * @param bool $approved
-     * @param bool $withRatings
+     * @param  string $department
+     * @param  bool   $approved
+     * @param  bool   $withRatings
      * @return Collection
      */
-    public function getReviewsByDepartment(string $department = "default", bool $approved = true, bool $withRatings = true): Collection;
+    public function getReviewsByDepartment(
+        string $department = "default",
+        bool $approved = true,
+        bool $withRatings = true
+    ): Collection;
 
     /**
      * Get the total number of reviews for the attached model.
      *
-     * @param bool $approved
+     * @param  bool $approved
      * @return int
      */
     public function totalReviews(bool $approved = true): int;
 
     /**
      * Get the total number of reviews for the model by department.
      *
-     * @param string $department
-     * @param bool $approved
+     * @param  string $department
+     * @param  bool   $approved
      * @return int
      */
     public function totalDepartmentReviews(string $department = "default", bool $approved = true): int;
 
     /**
      * Get the overall average rating for all ratings attached to the model.
      *
-     * @param bool $approved
+     * @param  bool $approved
      * @return float|null
      */
     public function overallAverageRating(bool $approved = true): ?float;
 
     /**
      * Delete a review.
      *
-     * @param int $reviewId
+     * @param  int|null $reviewId
      * @return bool
      */
-    public function deleteReview(int $reviewId = null): bool;
+    public function deleteReview(?int $reviewId = null): bool;
 
     /**
      * Return an array of rating value ⇒ count, for the full model
      * or for a given department.
      *
-     * @param string|null $department
-     * @param bool $approved
+     * @param  string|null $department
+     * @param  bool        $approved
      * @return array
      */
     public function ratingCounts(?string $department = "default", bool $approved = true): array;
@@ -145,20 +153,25 @@ public function ratingCounts(?string $department = "default", bool $approved = t
      *  • percentages: [1 => pct1, …, 5 => pct5]
      *  • total:      total number of ratings
      *
-     * @param  string|null  $department
-     * @param  bool         $approved
+     * @param  string|null $department
+     * @param  bool        $approved
      * @return array
      */
     public function ratingStats(?string $department = "default", bool $approved = true): array;
 
     /**
      * Return reviews based on star ratings.
      *
-     * @param int|null $starValue
-     * @param string $department
-     * @param bool $approved
-     * @param bool $withRatings
+     * @param  int|null    $starValue
+     * @param  string      $department
+     * @param  bool        $approved
+     * @param  bool        $withRatings
      * @return Collection
      */
-    public function getReviewsByRating(int $starValue = null, string $department = "default", bool $approved   = true, bool $withRatings = true): Collection;
+    public function getReviewsByRating(
+        ?int $starValue = null,
+        string $department = "default",
+        bool $approved = true,
+        bool $withRatings = true
+    ): Collection;
 }