animelhd/animes-view

User view features for Laravel Application.

dev-main 2025-03-19 21:48 UTC

Requires

• php: ^8.0.2
• laravel/framework: ^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• brainmaestro/composer-git-hooks: dev-master
• friendsofphp/php-cs-fixer: ^3.5
• laravel/pint: ^1.2
• mockery/mockery: ^1.4.4
• orchestra/testbench: ^8.0|^9.0|^10.0
• phpunit/phpunit: ^10.0.0|^11.5.3

MIT

• animelhd

README

❤️ User view feature for Laravel Application.

Installing

composer require animelhd/animes-view -vvv

Configuration & Migrations

php artisan vendor:publish --provider="Animelhd\AnimesView\ViewServiceProvider"

Usage

Traits

Animelhd\AnimesView\Traits\Viewer

use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Animelhd\AnimesView\Traits\Viewer;

class User extends Authenticatable
{
    use Viewer;

    <...>
}

Animelhd\AnimesView\Traits\Vieweable

use Illuminate\Database\Eloquent\Model;
use Animelhd\AnimesView\Traits\Vieweable;

class Post extends Model
{
    use Vieweable;

    <...>
}

API

$user = User::find(1);
$post = Post::find(2);

$user->view($post);
$user->unview($post);
$user->toggleView($post);
$user->getViewItems(Post::class)

$user->hasViewed($post);
$post->hasBeenViewedBy($user);

Get object viewers:

foreach($post->viewers as $user) {
    // echo $user->name;
}

Get View Model from User.

Used Viewer Trait Model can easy to get Vieweable Models to do what you want. _note: this method will return a Illuminate\Database\Eloquent\Builder _

$user->getViewItems(Post::class);

// Do more
$viewPosts = $user->getViewItems(Post::class)->get();
$viewPosts = $user->getViewItems(Post::class)->paginate();
$viewPosts = $user->getViewItems(Post::class)->where('title', 'Laravel-View')->get();

Aggregations

// all
$user->views()->count();

// with type
$user->views()->withType(Post::class)->count();

// viewers count
$post->viewers()->count();

List with *_count attribute:

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

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


// for Vieweable models:
$posts = Post::withCount('viewers')->get();

foreach($posts as $post) {
    echo $post->views_count;
}

Attach user view status to vieweable collection

You can use Viewer::attachViewStatus($vieweables) to attach the user view status, it will set has_viewed attribute to each model of $vieweables:

For model

$post = Post::find(1);

$post = $user->attachViewStatus($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_viewed" => true
 ],

For Collection | Paginator | CursorPaginator | array:

$posts = Post::oldest('id')->get();

$posts = $user->attachViewStatus($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_viewed" => true
  ],
  [
    "id" => 2
    "title" => "Post title2"
    "created_at" => "2021-05-20T03:26:16.000000Z"
    "updated_at" => "2021-05-20T03:26:16.000000Z"
    "has_viewed" => false
  ],
  [
    "id" => 3
    "title" => "Post title3"
    "created_at" => "2021-05-20T03:26:16.000000Z"
    "updated_at" => "2021-05-20T03:26:16.000000Z"
    "has_viewed" => true
  ],
]

For pagination

$posts = Post::paginate(20);

$user->attachViewStatus($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:

// Viewer
$users = User::with('views')->get();

foreach($users as $user) {
    $user->hasViewed($post);
}

// with vieweable object
$users = User::with('views.vieweable')->get();

foreach($users as $user) {
    $user->hasViewed($post);
}

// Vieweable
$posts = Post::with('views')->get();
// or
$posts = Post::with('viewers')->get();

foreach($posts as $post) {
    $post->isViewedBy($user);
}

Events

Event	Description
Animelhd\AnimesView\Events\Viewed	Triggered when the relationship is created.
Animelhd\AnimesView\Events\Unviewed	Triggered when the relationship is deleted.

License

MIT