Wip

Author: codebyray

config/review-ratable.php

@@ -0,0 +1,24 @@
+<?php
+
+return [
+    // Default rating types for reviews
+    'default_rating_types' => [
+        'overall',
+        'customer_service',
+        'quality',
+        'friendly',
+        'price',
+    ],
+
+    // Default departments if needed
+    'default_departments' => [
+        'Sales',
+        'Service',
+        'Parts',
+    ],
+
+    // Other configuration settings can be added here
+    'default_approved' => false,
+    'max_rating_value' => 10,
+    'min_rating_value' => 1,
+];

database/migrations/create_reviews_table.php.stub

@@ -10,12 +10,9 @@ class CreateReviewsTable extends Migration
         Schema::create('reviews', function (Blueprint $table) {
             $table->bigIncrements('id');
             $table->integer('rating');
-            $table->integer('customer_service_rating')->nullable();
-            $table->integer('quality_rating')->nullable();
-            $table->integer('friendly_rating')->nullable();
-            $table->integer('pricing_rating')->nullable();
+            $table->json('ratings')->nullable();
+            $table->json('departments')->nullable();
             $table->enum('recommend', ['Yes', 'No']);
-            $table->enum('department', ['Sales', 'Service', 'Parts']);
             $table->string('title');
             $table->string('body');
             $table->boolean('approved')->default(0);

src/Contracts/ReviewRateable.php

@@ -7,177 +7,155 @@
 interface ReviewRateable
 {
     /**
+     * Get all reviews for the model.
+     *
      * @return \Illuminate\Database\Eloquent\Relations\MorphMany
      */
-    public function ratings();
+    public function reviews();
 
     /**
+     * Get the rating types for the model.
      *
-     * @param $round
-     * @return double
+     * @return array
      */
-    public function averageRating($round = null);
+    public function ratingTypes();
 
     /**
+     * Add a review to the model.
      *
-     * @param $round
-     * @return double
+     * @param array $data
+     * @return \Illuminate\Database\Eloquent\Model
      */
-    public function averageCustomerServiceRating($round = null);
+    public function addReview(array $data);
 
     /**
+     * Add a rating to a specific review.
      *
-     * @param $round
-     * @return double
+     * @param int $reviewId
+     * @param string $type
+     * @param int $rating
+     * @return void
      */
-    public function averageQualityRating($round = null);
+    public function addRatingToReview($reviewId, $type, $rating);
 
     /**
+     * Get a specific rating from a review.
      *
-     * @param $round
-     * @return double
+     * @param int $reviewId
+     * @param string $type
+     * @return int|null
      */
-    public function averageFriendlyRating($round = null);
+    public function getReviewRating($reviewId, $type);
 
     /**
+     * Calculate the average rating for a specific type.
      *
-     * @param $round
+     * @param string|null $type
+     * @param int|null $round
      * @return double
      */
-    public function averagePricingRating($round = null);
-
-    /**
-     *
-     * @return int
-     */
-    public function countRating();
-
-    /**
-     *
-     * @return int
-     */
-    public function countCustomerServiceRating();
-
-    /**
-     *
-     * @return int
-     */
-    public function countQualityRating();
-
-    /**
-     *
-     * @return int
-     */
-    public function countFriendlyRating();
+    public function averageRating($type = 'rating', $round = null);
 
     /**
+     * Count the number of ratings for a specific type.
      *
+     * @param string|null $type
      * @return int
      */
-    public function countPriceRating();
+    public function countRating($type = 'rating');
 
     /**
+     * Sum the ratings for a specific type.
      *
+     * @param string|null $type
      * @return double
      */
-    public function sumRating();
+    public function sumRating($type = 'rating');
 
     /**
+     * Calculate the rating percentage for a specific type.
      *
-     * @param $max
-     *
+     * @param string|null $type
+     * @param int $max
      * @return double
      */
-    public function ratingPercent($max = 5);
+    public function ratingPercent($type = 'rating', $max = 5);
 
     /**
+     * Retrieve all ratings for the given ID.
      *
-     * @param $data
-     * @param $author
-     * @param $parent
-     *
-     * @return static
-     */
-    public function rating($data, Model $author, Model $parent = null);
-
-    /**
-     *
-     * @param $id
-     * @param $data
-     * @param $parent
-     *
-     * @return mixed
-     */
-    public function updateRating($id, $data, Model $parent = null);
-
-    /**
-     *
-     * @param $id
-     * @param $sort
-     *
+     * @param int $id
+     * @param string $sort
      * @return mixed
      */
     public function getAllRatings($id, $sort = 'desc');
 
     /**
+     * Retrieve all approved ratings for the given ID.
      *
-     * @param $id
-     * @param $sort
-     *
+     * @param int $id
+     * @param string $sort
      * @return mixed
      */
     public function getApprovedRatings($id, $sort = 'desc');
 
     /**
+     * Retrieve all non-approved ratings for the given ID.
      *
-     * @param $id
-     * @param $sort
-     *
+     * @param int $id
+     * @param string $sort
      * @return mixed
      */
     public function getNotApprovedRatings($id, $sort = 'desc');
 
     /**
-     * @param $id
-     * @param $limit
-     * @param $sort
+     * Retrieve recent ratings for the given ID.
      *
+     * @param int $id
+     * @param int $limit
+     * @param string $sort
      * @return mixed
      */
     public function getRecentRatings($id, $limit = 5, $sort = 'desc');
 
     /**
-     * @param $id
-     * @param $limit
-     * @param $approved
-     * @param $sort
+     * Retrieve recent user ratings.
      *
+     * @param int $id
+     * @param int $limit
+     * @param bool $approved
+     * @param string $sort
      * @return mixed
      */
     public function getRecentUserRatings($id, $limit = 5, $approved = true, $sort = 'desc');
 
     /**
-     * @param $rating
-     * @para $type
-     * @param $approved
-     * @param $sort
+     * Get a collection of reviews by average rating.
      *
+     * @param double $rating
+     * @param string $type
+     * @param bool $approved
+     * @param string $sort
      * @return mixed
      */
     public function getCollectionByAverageRating($rating, $type = 'rating', $approved = true, $sort = 'desc');
 
     /**
+     * Delete a rating by its ID.
      *
-     * @param $id
-     *
+     * @param int $id
      * @return mixed
      */
     public function deleteRating($id);
 
     /**
+     * Retrieve user ratings.
      *
-     * @param $id
+     * @param int $id
+     * @param string $author
+     * @param string $sort
      * @return mixed
      */
     public function getUserRatings($id, $author, $sort = 'desc');
 }
+