tobischulz/laravel-favoritable

Adds an easy way to make every model favoritable

1.4.1 2024-02-12 13:04 UTC

Requires

• php: ^8.2

Requires (Dev)

• orchestra/testbench: 8.2

MIT

• Tobias Schulz

README

Adds an easy way to make every model favoritable.

Installation

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

Preparation

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;

    // ...
}

Usage

<?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

Testing

wip

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Tobias Schulz
• All Contributors

License

The MIT License (MIT). Please see License File for more information.