2017 © Pedro Peláez
 

library votable

Voteable trait for laravel 5.5

image

keggermont/votable

Voteable trait for laravel 5.5

  • Sunday, May 13, 2018
  • by k-eggermont
  • Repository
  • 0 Watchers
  • 0 Stars
  • 1 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

Laravel Voteable Trait

Installation

Use Composer :, (*1)

``` bash $ composer require k-eggermont/laravel-voteable, (*2)


Publish the vendor assets:

php artisan vendor:publish --provider="Keggermont\Voteable\VoteableServiceProvider" php artisan migrate, (*3)


## Configuration

You can configure the package on /config/laravel-voteable.php

## Usage

### Api

By default, the api is accessible at /api/votes/. You have 3 routes :
* GET /api/votes/{type}/{id} : Get votes list, and overall rating
* POST /api/votes/create/{type}/{id} : Create a new vote (or update existing vote). Data required : "rate" (integer, between 0 up to 5 (/5) )
* DELETE /api/votes/{vote_id} : Delete the vote


### Include trait for your model
``` php
<?php

namespace App;

use Keggermont\Voteable\Traits\Voteable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Voteable;
}

Configure the config/laravel-voteable.php

<?php
$allowType = [
"mymodel" => App\MyModel::class
]

Create a vote (5/5) from a model or controller

``` php $object = MyModel::first();, (*4)

$vote = $post->createVote([ 'rate' => 5 ], Auth::user());, (*5)

```, (*6)

License

MIT, (*7)

The Versions

13/05 2018

dev-master

9999999-dev

Voteable trait for laravel 5.5

  Sources   Download

The Requires

 

The Development Requires

by keggermont