User bookmark feature for Laravel Application.
$ composer require trendsoft/laravel-bookmark -vvvThis step is optional
$ composer artisan vendor:publish --provider="Trendsoft\\LaravelBookmark\\BookmarkServiceProvider" --tag=configThis step is also optional, if you want to custom bookmarks table, you can publish the migration files:
$ composer artisan vendor:publish --provider="Trendsoft\\LaravelBookmark\\BookmarkServiceProvider" --tag=migrationsTrendsoft\LaravelBookmark\Traits\Bookmarker
use Illuminate\Database\Eloquent\Model;
use Trendsoft\LaravelBookmark\Traits\Bookmarker;
class User extends Model
{
use Bookmarker;
}Trendsoft\LaravelBookmark\Traits\Bookmarkable
use Illuminate\Database\Eloquent\Model;
use Trendsoft\LaravelBookmark\Traits\Bookmarkable;
class Post extends Model
{
use Bookmarkable;
}$user = User::find(1);
$post = Post::find(1);
$user->bookmark($post);
$user->unBookmark($post);
$user->toggleBookmark($post);
$user->hasBookmarked($post);
$post->isBookmarkedBy($user);Get user bookmarks with pagination:
$bookmarks = $user->bookmarks()->with('bookmarkable')->paginate(20);
foreach($bookmarks as $bookmark){
$bookmark->bookmarkable; // App\Post instance
}Get object bookmarkers:
foreach($post->bookmarkers as $user){
echo $user->name;
}with pagination:
$bookmarkers = $post->bookmarkers()->paginate(20);
foreach($bookmarkers as $user){
echo $user->name;
}//all
$user->bookmarks()->count();
//with type
$user->bookmarks()->withType(Post::class)->count();
// bookmarkers count
$post->bookmarkers()->count();List with *_count attribute:
$users = User::withCount('bookmarks')->get();
foreach($users as $user){
echo $user->bookmarks_count;
}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:
// Bookmarker
$users = App\User::with('bookmarks')->get();
foreach($users as $user) {
$user->hasBookmarked($post);
}
// Bookmarkable
$posts = App\Post::with('bookmarks')->get();
// or
$posts = App\Post::with('bookmarkers')->get();
foreach($posts as $post){
$post->isBookmarkedBy($user);
}| Event | Description |
|---|---|
Trendsoft\LaravelBookmark\Events\Bookmarked |
Triggered when the relationship is created. |
Trendsoft\LaravelBookmark\Events\Unbookmarked |
Triggered when the relationship is deleted. |
You can contribute in one of three ways:
- File bug reports using the issue tracker.
- Answer questions or fix bugs on the issue tracker.
- 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.
MIT