https://github.com/overtrue/laravel-favorite
:heart: User favorite feature for Laravel Application.
https://github.com/overtrue/laravel-favorite
favorites followers following laravel-favorite user-relations
Last synced: 5 months ago
JSON representation
:heart: User favorite feature for Laravel Application.
- Host: GitHub
- URL: https://github.com/overtrue/laravel-favorite
- Owner: overtrue
- Created: 2019-04-30T03:54:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T04:57:07.000Z (7 months ago)
- Last Synced: 2025-04-13T08:58:42.920Z (6 months ago)
- Topics: favorites, followers, following, laravel-favorite, user-relations
- Language: PHP
- Homepage:
- Size: 90.8 KB
- Stars: 439
- Watchers: 6
- Forks: 54
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
## Laravel Favorite
❤️ User favorite feature for Laravel Application.
[](https://github.com/overtrue/laravel-favorite/actions)
[](https://packagist.org/packages/overtrue/laravel-favorite)
[](https://packagist.org/packages/overtrue/laravel-favorite)
[](https://packagist.org/packages/overtrue/laravel-favorite)
[](https://packagist.org/packages/overtrue/laravel-favorite)
[](https://github.com/sponsors/overtrue)
## Installing
```shell
composer require overtrue/laravel-favorite -vvv
```
### Configuration & Migrations
```php
php artisan vendor:publish --provider="Overtrue\LaravelFavorite\FavoriteServiceProvider"
```
## Usage
### Traits
#### `Overtrue\LaravelFavorite\Traits\Favoriter`
```php
use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Overtrue\LaravelFavorite\Traits\Favoriter;
class User extends Authenticatable
{
use Favoriter;
<...>
}
```
#### `Overtrue\LaravelFavorite\Traits\Favoriteable`
```php
use Illuminate\Database\Eloquent\Model;
use Overtrue\LaravelFavorite\Traits\Favoriteable;
class Post extends Model
{
use Favoriteable;
<...>
}
```
### API
```php
$user = User::find(1);
$post = Post::find(2);
$user->favorite($post);
$user->unfavorite($post);
$user->toggleFavorite($post);
$user->getFavoriteItems(Post::class)
$user->hasFavorited($post);
$post->hasBeenFavoritedBy($user);
```
#### Get object favoriters:
```php
foreach($post->favoriters as $user) {
// echo $user->name;
}
```
#### Get Favorite Model from User.
Used Favoriter Trait Model can easy to get Favoriteable Models to do what you want.
_note: this method will return a `Illuminate\Database\Eloquent\Builder` _
```php
$user->getFavoriteItems(Post::class);
// Do more
$favoritePosts = $user->getFavoriteItems(Post::class)->get();
$favoritePosts = $user->getFavoriteItems(Post::class)->paginate();
$favoritePosts = $user->getFavoriteItems(Post::class)->where('title', 'Laravel-Favorite')->get();
```
### Aggregations
```php
// all
$user->favorites()->count();
// with type
$user->favorites()->withType(Post::class)->count();
// favoriters count
$post->favoriters()->count();
```
List with `*_count` attribute:
```php
$users = User::withCount('favorites')->get();
foreach($users as $user) {
echo $user->favorites_count;
}
// for Favoriteable models:
$posts = Post::withCount('favoriters')->get();
foreach($posts as $post) {
echo $post->favorites_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 model
```php
$post = Post::find(1);
$post = $user->attachFavoriteStatus($post);
// result
[
"id" => 1
"title" => "Add socialite login support."
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_favorited" => true
],
```
#### For `Collection | Paginator | CursorPaginator | array`:
```php
$posts = Post::oldest('id')->get();
$posts = $user->attachFavoriteStatus($posts);
$posts = $posts->toArray();
// result
[
[
"id" => 1
"title" => "Post title1"
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_favorited" => true
],
[
"id" => 2
"title" => "Post title2"
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_favorited" => false
],
[
"id" => 3
"title" => "Post title3"
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_favorited" => true
],
]
```
#### For pagination
```php
$posts = Post::paginate(20);
$user->attachFavoriteStatus($posts);
```
### 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:
```php
// Favoriter
$users = User::with('favorites')->get();
foreach($users as $user) {
$user->hasFavorited($post);
}
// with favoriteable object
$users = User::with('favorites.favoriteable')->get();
foreach($users as $user) {
$user->hasFavorited($post);
}
// Favoriteable
$posts = Post::with('favorites')->get();
// or
$posts = Post::with('favoriters')->get();
foreach($posts as $post) {
$post->isFavoritedBy($user);
}
```
### Events
| **Event** | **Description** |
| --------------------------------------------- | ------------------------------------------- |
| `Overtrue\LaravelFavorite\Events\Favorited` | Triggered when the relationship is created. |
| `Overtrue\LaravelFavorite\Events\Unfavorited` | Triggered when the relationship is deleted. |
## Related packages
- Follow: [overtrue/laravel-follow](https://github.com/overtrue/laravel-follow)
- Like: [overtrue/laravel-like](https://github.com/overtrue/laravel-like)
- Favorite: [overtrue/laravel-favorite](https://github.com/overtrue/laravel-favorite)
- Subscribe: [overtrue/laravel-subscribe](https://github.com/overtrue/laravel-subscribe)
- Vote: [overtrue/laravel-vote](https://github.com/overtrue/laravel-vote)
- Bookmark: overtrue/laravel-bookmark (working in progress)
## Contributing
You can contribute in one of three ways:
1. File bug reports using the [issue tracker](https://github.com/overtrue/laravel-favorite/issues).
2. Answer questions or fix bugs on the [issue tracker](https://github.com/overtrue/laravel-favorite/issues).
3. Contribute new features or update the wiki.
_The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable._
## :heart: Sponsor me
[](https://github.com/sponsors/overtrue)
如果你喜欢我的项目并想支持它，[点击这里 :heart:](https://github.com/sponsors/overtrue)
## Project supported by JetBrains
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[](https://www.jetbrains.com/?from=https://github.com/overtrue)
## PHP 扩展包开发
> 想知道如何从零开始构建 PHP 扩展包？
>
> 请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— [《PHP 扩展包实战教程 - 从入门到发布》](https://learnku.com/courses/creating-package)
## License
MIT