stylers-llc/laravel-ban

<?php

namespace Stylers\LaravelBan\Contracts\Models\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Stylers\LaravelBan\Contracts\Models\BanInterface;

/**
 * Interface BannableInterface
 * @package Stylers\LaravelBan\Contracts\Traits
 */
interface BannableInterface
{
    /**
     * @return mixed
     */
    public function bans(): MorphMany;

    /**
     * @return bool
     */
    public function isBanned(): bool;

    /**
     * @param Builder $query
     * @return mixed
     */
    public function scopeBanned(Builder $query);

    /**
     * @param Builder $query
     * @return mixed
     */
    public function scopeNotBanned(Builder $query);

    /**
     * @param string|null $comment
     * @param \DatetimeInterface $startAt
     * @param \DateTimeInterface|null $endAt
     * @return BanInterface
     */
    public function ban(string $comment = null, \DatetimeInterface $startAt = null, \DateTimeInterface $endAt = null): BanInterface;

    /**
     * @return Collection
     */
    public function unban(): Collection;
}