stylers-llc/laravel-ban

<?php

namespace Stylers\LaravelBan\Models\Traits;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Stylers\LaravelBan\Builders\BanBuilder;
use Stylers\LaravelBan\Contracts\Builders\BanBuilderInterface;
use Stylers\LaravelBan\Contracts\Models\BanInterface;
use Stylers\LaravelBan\Contracts\Services\BanServiceInterface;

/**
 * Trait Bannable
 * @package Stylers\LaravelBan\Models\Traits
 */
trait Bannable
{
    /**
     * @return mixed
     */
    public function bans(): MorphMany
    {
        return $this->morphMany(app(BanInterface::class), 'bannable');
    }

    // This relation makes scoped relation to eager loadable
    public function liveBans(): MorphMany
    {
        return $this->bans()->live();
    }

    /**
     * @return bool
     */
    public function isBanned(): bool
    {
        return (bool)$this->liveBans->first();
    }

    /**
     * @param Builder $query
     * @return Builder
     */
    public function scopeBanned(Builder $query)
    {
        return $query->whereHas('bans', function ($q) {
            $q->live();
        });
    }

    /**
     * @param Builder $query
     * @return mixed
     */
    public function scopeNotBanned(Builder $query)
    {
        $bannedIds = $this->banned()->pluck('id')->toArray();

        return $query->whereNotIn('id', $bannedIds);
    }

    /**
     * @param string|null $comment
     * @param \DateTimeInterface|null $startAt
     * @param \DateTimeInterface|null $endAt
     * @return BanInterface
     */
    public function ban(
        string $comment = null,
        \DateTimeInterface $startAt = null,
        \DateTimeInterface $endAt = null
    ): BanInterface
    {
        $banService = app(BanServiceInterface::class);
        $banBuilder = app(BanBuilderInterface::class, ['bannable' => $this]);
        $banBuilder
            ->setCreatedBy(auth()->user() ?: null)
            ->setComment($comment)
            ->setStartAt($startAt ?: Carbon::now())
            ->setEndAt($endAt)
            ->build();

        return $banService->ban($banBuilder);
    }

    /**
     * @return Collection
     */
    public function unban(): Collection
    {
        $banService = app(BanServiceInterface::class);

        return $banService->unban($this);
    }
}