cybercog / laravel-ban

src/Models/Ban.php

<?php

/*
 * This file is part of Laravel Ban.
 *
 * (c) Anton Komarev <anton@komarev.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cog\Laravel\Ban\Models;

use Cog\Contracts\Ban\Ban as BanContract;
use Cog\Contracts\Ban\Bannable as BannableContract;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Carbon;

class Ban extends Model implements BanContract
{
    use HasFactory;
    use SoftDeletes;

    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'bans';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'comment',
        'expired_at',
        'created_by_type',
        'created_by_id',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'expired_at' => 'datetime',
        'deleted_at' => 'datetime',
    ];

    /**
     * Expired timestamp mutator.
     *
     * @param \Illuminate\Support\Carbon|string $value
     * @return void
     */
    public function setExpiredAtAttribute($value): void
    {
        if (!is_null($value) && !$value instanceof Carbon) {
            $value = Carbon::parse($value);
        }

        $this->attributes['expired_at'] = $value;
    }

    /**
     * Entity responsible for ban.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
     */
    public function createdBy(): MorphTo
    {
        return $this->morphTo('created_by');
    }

    /**
     * Bannable model.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
     */
    public function bannable(): MorphTo
    {
        return $this->morphTo('bannable');
    }

    /**
     * Determine if Ban is permanent.
     *
     * @return bool
     */
    public function isPermanent(): bool
    {
        return !isset($this->attributes['expired_at']) || is_null($this->attributes['expired_at']);
    }

    /**
     * Determine if Ban is temporary.
     *
     * @return bool
     */
    public function isTemporary(): bool
    {
        return !$this->isPermanent();
    }

    /**
     * Scope a query to only include models by owner.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param \Cog\Contracts\Ban\Bannable $bannable
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWhereBannable(Builder $query, BannableContract $bannable): Builder
    {
        return $query->where([
            'bannable_type' => $bannable->getMorphClass(),

The method getMorphClass() does not exist on Cog\Contracts\Ban\Bannable. Since it exists in all sub-types, consider adding an abstract or default implementation to Cog\Contracts\Ban\Bannable.

            'bannable_id' => $bannable->getKey(),

The method getKey() does not exist on Cog\Contracts\Ban\Bannable. Since it exists in all sub-types, consider adding an abstract or default implementation to Cog\Contracts\Ban\Bannable.

        ]);
    }
}