laravel-interaction/interactions

View on GitHub
packages/bookmark/src/Concerns/Bookmarker.php

Summary

Maintainability
A
0 mins
Test Coverage
A
97%
<?php

declare(strict_types=1);

namespace LaravelInteraction\Bookmark\Concerns;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use LaravelInteraction\Bookmark\Bookmark;

/**
 * @property-read \Illuminate\Database\Eloquent\Collection|\LaravelInteraction\Bookmark\Bookmark[] $bookmarkerBookmarks
 * @property-read int|null $bookmarkerBookmarks_count
 */
trait Bookmarker
{
    public function bookmark(Model $object): Bookmark
    {
        $attributes = [
            'bookmarkable_id' => $object->getKey(),
            'bookmarkable_type' => $object->getMorphClass(),
        ];

        return $this->bookmarkerBookmarks()
            ->where($attributes)
            ->firstOr(function () use ($attributes) {
                $bookmarkerBookmarksLoaded = $this->relationLoaded('bookmarkerBookmarks');
                if ($bookmarkerBookmarksLoaded) {
                    $this->unsetRelation('bookmarkerBookmarks');
                }

                return $this->bookmarkerBookmarks()
                    ->create($attributes);
            });
    }

    public function bookmarkerBookmarks(): HasMany
    {
        return $this->hasMany(config('bookmark.models.pivot'), config('bookmark.column_names.user_foreign_key'));
    }

    public function hasBookmarked(Model $object): bool
    {
        return ($this->relationLoaded(
            'bookmarkerBookmarks'
        ) ? $this->bookmarkerBookmarks : $this->bookmarkerBookmarks())
            ->where('bookmarkable_id', $object->getKey())
            ->where('bookmarkable_type', $object->getMorphClass())
            ->count() > 0;
    }

    public function hasNotBookmarked(Model $object): bool
    {
        return ! $this->hasBookmarked($object);
    }

    public function toggleBookmark(Model $object): Bookmark|bool
    {
        return $this->hasBookmarked($object) ? $this->unbookmark($object) : $this->bookmark($object);
    }

    public function unbookmark(Model $object): bool
    {
        $hasNotBookmarked = $this->hasNotBookmarked($object);
        if ($hasNotBookmarked) {
            return true;
        }

        $bookmarkerBookmarksLoaded = $this->relationLoaded('bookmarkerBookmarks');
        if ($bookmarkerBookmarksLoaded) {
            $this->unsetRelation('bookmarkerBookmarks');
        }

        return (bool) $this->bookmarks($object::class)
            ->detach($object->getKey());
    }

    protected function bookmarks(string $class): MorphToMany
    {
        return $this->morphedByMany(
            $class,
            'bookmarkable',
            config('bookmark.models.pivot'),
            config('bookmark.column_names.user_foreign_key')
        )
            ->withTimestamps();
    }
}