README.md

Laravel Favorite

User favorite/unfavorite behaviour for Laravel.

Introduction

It let people express how they feel about the model(documentation/subject/topic).

Installation

Requirements

• PHP 8.0+
• Composer
• Laravel 8.0+

Instructions

Require Laravel Favorite using Composer.

composer require laravel-interaction/favorite

Publish configuration and migrations

php artisan vendor:publish --tag=favorite-config
php artisan vendor:publish --tag=favorite-migrations

Run database migrations.

php artisan migrate

Usage

Setup Favoriter

use Illuminate\Database\Eloquent\Model;
use LaravelInteraction\Favorite\Concerns\Favoriter;

class User extends Model
{
    use Favoriter;
}

Setup Favoriteable

use Illuminate\Database\Eloquent\Model;
use LaravelInteraction\Favorite\Concerns\Favoriteable;

class Channel extends Model
{
    use Favoriteable;
}

Favoriter

use LaravelInteraction\Favorite\Tests\Models\Channel;
/** @var \LaravelInteraction\Favorite\Tests\Models\User $user */
/** @var \LaravelInteraction\Favorite\Tests\Models\Channel $channel */
// Favorite to Favoriteable
$user->favorite($channel);
$user->unfavorite($channel);
$user->toggleFavorite($channel);

// Compare Favoriteable
$user->hasFavorited($channel);
$user->hasNotFavorited($channel);

// Get favorited info
$user->favoriterFavorites()->count(); 

// with type
$user->favoriterFavorites()->withType(Channel::class)->count(); 

// get favorited channels
Channel::query()->whereFavoritedBy($user)->get();

// get favorited channels doesnt favorited
Channel::query()->whereNotFavoritedBy($user)->get();

Favoriteable

use LaravelInteraction\Favorite\Tests\Models\User;
use LaravelInteraction\Favorite\Tests\Models\Channel;
/** @var \LaravelInteraction\Favorite\Tests\Models\User $user */
/** @var \LaravelInteraction\Favorite\Tests\Models\Channel $channel */
// Compare Favoriter
$channel->isFavoritedBy($user); 
$channel->isNotFavoritedBy($user);
// Get favoriters info
$channel->favoriters->each(function (User $user){
    echo $user->getKey();
});

$channels = Channel::query()->withCount('favoriters')->get();
$channels->each(function (Channel $channel){
    echo $channel->favoriters()->count(); // 1100
    echo $channel->favoriters_count; // "1100"
    echo $channel->favoritersCount(); // 1100
    echo $channel->favoritersCountForHumans(); // "1.1K"
});

Events

Event	Fired
LaravelInteraction\Favorite\Events\Favorited	When an object get favorited.
LaravelInteraction\Favorite\Events\Unfavorited	When an object get unfavorited.

License

Laravel Favorite is an open-sourced software licensed under the MIT license.