https://github.com/abdullahghanem/rating

rating system for laravel 5
https://github.com/abdullahghanem/rating

laravel laravelrating rating rating-stars

Last synced: about 10 hours ago
JSON representation

rating system for laravel 5

• Host: GitHub
• URL: https://github.com/abdullahghanem/rating
• Owner: AbdullahGhanem
• License: mit
• Created: 2015-10-24T14:28:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-10T03:21:07.000Z (almost 2 years ago)
• Last Synced: 2025-01-08T07:09:13.581Z (8 days ago)
• Topics: laravel, laravelrating, rating, rating-stars
• Language: PHP
• Size: 18.6 KB
• Stars: 86
• Watchers: 8
• Forks: 36
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Latest Stable Version](https://poser.pugx.org/ghanem/rating/v/stable.svg)](https://packagist.org/packages/ghanem/rating) [![License](https://poser.pugx.org/ghanem/rating/license.svg)](https://packagist.org/packages/ghanem/rating)

[![Total Downloads](https://poser.pugx.org/ghanem/rating/downloads.svg)](https://packagist.org/packages/ghanem/rating)

# Laravel Rating

![https://scontent-cai1-1.xx.fbcdn.net/v/t31.0-8/18192521_1536772739688541_5883708562629992092_o.jpg?oh=281577e64a1e326ff1989f047ab21df6&oe=59BAEBCA](https://scontent-cai1-1.xx.fbcdn.net/v/t31.0-8/18192521_1536772739688541_5883708562629992092_o.jpg?oh=281577e64a1e326ff1989f047ab21df6&oe=59BAEBCA)

Rating system for laravel 5

## Installation

First, pull in the package through Composer.

```js

composer require ghanem/rating

```

or add this in your project's composer.json file .

````

"require": {

  "Ghanem/Rating": "1.*",

}

````

And then include the service provider within `app/config/app.php`.

```php

'providers' => [

    Ghanem\Rating\RatingServiceProvider::class

];

```

-----

## Getting started

After the package is correctly installed, you need to generate the migration.

````

php artisan rating:migration

````

It will generate the `_create_ratings_table.php` migration. You may now run it with the artisan migrate command:

````

php artisan migrate

````

After the migration, one new table will be present, `ratings`.

## Usage

### Setup a Model

```php

rating([

    'rating' => 5

], $user);

dd($rating);

```

### Create or update a unique rating

```php

$user = User::first();

$post = Post::first();

$rating = $post->ratingUnique([

    'rating' => 5

], $user);

dd($rating);

```

### Update a rating

```php

$rating = $post->updateRating(1, [

    'rating' => 3

]);

```

### Delete a rating:

```php

$post->deleteRating(1);

```

### fetch the Sum rating:

````php

$post->sumRating

// $post->sumRating() also works for this.

```` 

### fetch the average rating:

````php

$post->avgRating

// $post->avgRating() also works for this.

````

### fetch the rating percentage. 

This is also how you enforce a maximum rating value.

````php

$post->ratingPercent

$post->ratingPercent(10)); // Ten star rating system

// Note: The value passed in is treated as the maximum allowed value.

// This defaults to 5 so it can be called without passing a value as well.

````

### Count positive rating:

````php

$post->countPositive

// $post->countPositive() also works for this.

````

### Count negative rating:

````php

$post->countNegative

// $post->countNegative() also works for this.

````

## Sponsor

[💚️ Become a Sponsor](https://github.com/sponsors/AbdullahGhanem)