ufutx/laravel-favorite

Allows Laravel Eloquent models to implement a 'favorite' or 'remember' or 'follow' feature.

Laravel Favorite (Laravel 5 Package, forked from Ufutx/laravel-favorite)

![Software License][ico-license] , _(*1)

Allows Laravel Eloquent models to implement a 'favorite' or 'remember' or 'follow' feature., _(*2)

Index

• Installation
• Models
• Usage
• Testing
• Change log
• Contributions
  • Pull Requests
• Security
• Credits
• License

Installation

1) Install the package via Composer, _(*3)

$ composer require ufutx/laravel-favorite

2) Update config/app.php by adding an entry for the service provider., _(*4)

'providers' => [
    // ...
    Ufutx\LaravelFavorite\FavoriteServiceProvider::class,
];

3) Migrate the database from the command line:, _(*5)

php artisan migrate

Models

Your User model should import the Traits/Favoriteability.php trait and use it, that trait allows the user to favorite the models. (see an example below):, _(*6)

use Ufutx\LaravelFavorite\Traits\Favoriteability;

class User extends Authenticatable
{
    use Favoriteability;
}

Your models should import the Traits/Favoriteable.php trait and use it, that trait have the methods that you'll use to allow the model be favoriteable. In all the examples I will use the Post model as the model that is 'Favoriteable', thats for example propuses only. (see an example below):, _(*7)

use Ufutx\LaravelFavorite\Traits\Favoriteable;

class Post extends Model
{
    use Favoriteable;
}

That's it ... your model is now "favoriteable"! Now the User can favorite models that have the favoriteable trait., _(*8)

Usage

The models can be favorited with and without an authenticated user (see examples below):, _(*9)

Add to favorites and remove from favorites:

If no param is passed in the favorite method, then the model will asume the auth user., _(*10)

``` php $post = Post::find(1); $post->addFavorite(); // auth user added to favorites this post $post->removeFavorite(); // auth user removed from favorites this post $post->toggleFavorite(); // auth user toggles the favorite status from this post, <sub>(*11)</sub>

If a param is passed in the favorite method, then the model will asume the user with that id.

``` php
$post = Post::find(1);
$post->addFavorite(5); // user with that id added to favorites this post
$post->removeFavorite(5); // user with that id removed from favorites this post
$post->toggleFavorite(5); // user with that id toggles the favorite status from this post

The user model can also add to favorites and remove from favrites:, <sub>(*12)</sub>

``` php $user = User::first(); $post = Post::first(); $user->addFavorite($post); // The user added to favorites this post $user->removeFavorite($post); // The user removed from favorites this post $user->toggleFavorite($post); // The user toggles the favorite status from this post, <sub>(*13)</sub>

### Return the favorite objects for the user:

A user can return the objects he marked as favorite. 
You just need to pass the **class** in the `favorite()` method in the `User` model.

``` php
$user = Auth::user();
$user->favorite(Post::class); // returns a collection with the Posts the User marked as favorite

Return the favorites count from an object:

You can return the favorites count from an object, you just need to return the favoritesCount attribute from the model, <sub>(*14)</sub>

``` php $post = Post::find(1); $post->favoritesCount; // returns the number of users that have marked as favorite this object., <sub>(*15)</sub>

### Return the users who marked this object as favorite

You can return the users who marked this object, you just need to call the `favoritedBy()` method in the object

``` php
$post = Post::find(1);
$post->favoritedBy(); // returns a collection with the Users that marked the post as favorite.

Testing

The package have integrated testing, so everytime you make a pull request your code will be tested., <sub>(*16)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*17)</sub>

Contributions

Contributions are welcome and will be fully credited. We accept contributions via Pull Requests on Github., <sub>(*18)</sub>

Pull Requests

• PSR-2 Coding Standard - Check the code style with $ composer check-style and fix it with $ composer fix-style., <sub>(*19)</sub>

• Add tests! - Your patch won't be accepted if it doesn't have tests., <sub>(*20)</sub>

• Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date., <sub>(*21)</sub>

• Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option., <sub>(*22)</sub>

• Create feature branches - Don't ask us to pull from your master branch., <sub>(*23)</sub>

• One pull request per feature - If you want to do more than one thing, send multiple pull requests., <sub>(*24)</sub>

• Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting., <sub>(*25)</sub>

Security

Please report any issue you find in the issues page.
Pull requests are welcome., <sub>(*26)</sub>

Credits

• Christian Kuri
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*27)</sub>