Adds an easy way to make every model favoritable
tobischulz/laravel-favoritable is a Laravel package for adds an easy way to make every model favoritable.
It currently has 5 GitHub stars and 4.726 downloads on Packagist (latest version 1.4.1).
Install it with composer require tobischulz/laravel-favoritable.
Discover more Laravel packages by tobischulz
or browse all Laravel packages to compare alternatives.
Last updated
Adds an easy way to make every model favoritable.
You can install the package via composer:
composer require tobischulz/laravel-favoritable
Publish all required assets:
php artisan vendor:publish --provider=TobiSchulz\Favoritable\FavoritableServiceProvider
Migrate your database:
php artisan migrate
Add trait to eloquent model that you like to be favoritable.
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use TobiSchulz\Favoritable\Traits\Favoriteable;
class Post extends Model
{
use Favoriteable;
// ...
}
Add trait your user model that will have favorites.
<?php
namespace App;
use Illuminate\Foundation\Auth\User as Authenticatable;
use TobiSchulz\Favoritable\Traits\HasFavorites;
class User extends Authenticatable
{
use HasFavorites;
// ...
}
<?php
/**
* API for Favoritable
*/
$post = Post::find(1);
$post->addFavorite(); // adds this post to favorites to current user
$post->removeFavorite(); // remove this post from favorites
$post->toggleFavorite(); // toggle this post as favorite
$post->isFavorited(); // returns boolean for this post favorite state
$post = Post::find(1);
$user = User::find(2);
$post->addFavorite($user); // adds favorite for this post and a specific user.
/**
* API for HasFavorites
*/
$user = User::find(1);
$user->favorites(Post::class); // returns collection of Post::class favorites
wip
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
