README

Favorites addon for GetCandy 2 Application.

Installing

composer require servnx/getcandy-favorites

Publishing Configurations & Migrations (Optional)

php artisan vendor:publish --tag="getcandy-favorites"

Run Migrations

php artisan migrate

Adding screens to GetCandy Admin Hub (Optional)

If you have the admin hub installed, you can enable the screens by publishing the configs demonstrated above and setting the hub value to true (false by default).

/*
* If you have GetCandy Admin Hub installed set this to true (default is false).
*/
'hub' => true,

The Favoriter

The favoriter is the user in which is favoriting objects.

Add the Favoriter Trait to your desired User model.

use Servnx\GetCandyFavorite\Traits\Favoriter;

class User extends Authenticatable
{
    use HasFactory,
        GetCandyUser,
        Favoriter,
        Billable,
        Notifiable;
       
    ...
}

Usage

Supported GetCandy Favoriteable Models.

GetCandy\Models\Product::class
... more to come ...

Adding favoritebale to your own Models.

use Illuminate\Database\Eloquent\Model;
use Servnx\GetCandyFavorite\Traits\Favoriteable;

class Post extends Model
{
    use Favoriteable;
    
    ...
}

API

$user = User::find(1);
$product = Product::find(2);

$user->favorite($product);
$user->unfavorite($product);
$user->toggleFavorite($product);
$user->getFavoriteItems(Product::class)

$user->hasFavorited($product);
$product->hasBeenFavoritedBy($user);

Get Favoriters example:

foreach($product->favoriters as $user) {
    ...
}

Get Favorite Model from User.

This will return a Illuminate\Database\Eloquent\Builder instance.

$favoriteItems = $user->getFavoriteItems(Product::class);

// more examples
$favoriteItems->get();
$favoriteItems->paginate();
$favoriteItems->find(1)->get();

Aggregations

// all favorites by this user
$user->favorites->count();

// how many Products has this user favorited ?
$user->favorites()->withType(Product::class)->count();

// how many users favorited this product ?
$product->favoriters->count();

List with *_count attribute:

$users = User::withCount('favorites')->get();

foreach($users as $user) {
    echo $user->favorites_count;
}


// for Favoriteable models:
$products = Product::withCount('favoriters')->get();

foreach($products as $product) {
    echo $product->favoriters_count;
}

Attach user favorite status to favoriteable collection

You can use Favoriter::attachFavoriteStatus($favoriteables) to attach the user favorite status, it will set has_favorited attribute to each model of $favoriteables:

For Models

$product = Product::find(1);

$product = $user->attachFavoriteStatus($product);

$product->toArray();

// example result
[
    "id" => 1
    ...
    "has_favorited" => true
],

For Collection | Paginator | LengthAwarePaginator | array:

$products = Product::oldest('id')->get();

$products = $user->attachFavoriteStatus($products);

$products->toArray();

// example result
[
  [
    "id" => 1
    ...
    "has_favorited" => true
  ],
  [
    "id" => 2
    ...
    "has_favorited" => false
  ],
  [
    "id" => 3
    ...
    "has_favorited" => true
  ],
]

N+1 issue

To avoid the N+1 issue, you can use eager loading to reduce this operation to just 2 queries. When querying, you may specify which relationships should be eager loaded using the with method:

// Favoriter
$users = User::with('favorites')->get();

// Favoriteable
$products = Product::with('favorites')->get();
$products = Product::with('favoriters')->get();

Events

License

MIT

Credits to Overtrue Laravel Favorites.