Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Naoray/laravel-reviewable
Adds a reviewable feature to your laravel app.
https://github.com/Naoray/laravel-reviewable
laravel package rating review reviews stars
Last synced: about 1 month ago
JSON representation
Adds a reviewable feature to your laravel app.
- Host: GitHub
- URL: https://github.com/Naoray/laravel-reviewable
- Owner: Naoray
- License: mit
- Archived: true
- Created: 2018-02-11T19:12:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-04T01:50:03.000Z (about 5 years ago)
- Last Synced: 2024-08-04T09:08:15.113Z (5 months ago)
- Topics: laravel, package, rating, review, reviews, stars
- Language: PHP
- Homepage:
- Size: 118 KB
- Stars: 56
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-reviewable
[](LICENSE.md)
[]()
[](https://styleci.io/repos/121157590)
[](https://packagist.org/packages/naoray/laravel-reviewable)
This package adds a reviewable feature to your app.
## Install
#### Laravel Version 5.7+
`composer require naoray/laravel-reviewable`
#### Laravel Version 5.6+
`composer require naoray/laravel-reviewable:1.1.*`
#### Laravel Version 5.5
`composer require naoray/laravel-reviewable:1.0.*`
*publish config:* `php artisan vendor:publish --provider="Naoray\LaravelReviewable\LaravelReviewableServiceProvider"`
## Usage
First, add the `Naoray\LaravelReviewable\Traits\HasReviews` trait to your model you want to add reviews to.
```php
use Naoray\LaravelReviewable\Traits\HasReviews;
class Post extends Model
{
use HasReviews;
// ...
}
```
Now you can create a review by:
```php
// from reviewable entity
Post::first()->createReview(5, 'Example review text', $author);
// author is assumed to be logged in and executing this operation
Post::first()->createReview(10);
// with helper
review($post, 5, 'Example Text', $author);
```
and receive review scores by:
```php
// summarizes all scores
Post::first()->score;
// gives the average of all scores
Post::first()->avg_score;
```
### Using your own Review-Model
If you just want to change the global configuration to use your own Review-Model, just create a new Model and reference it in the `reviewable.models.review` config.
If you do not want to change the global `review` Model you can take a look at [this issue](https://github.com/Naoray/laravel-reviewable/issues/16) for an example configuration.
## Testing
Run the tests with:
``` bash
vendor/bin/phpunit
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
## License
The MIT License (MIT). Please see [License File](/LICENSE.md) for more information.