Cog\Flag\Traits\Classic\HasKeptFlagHelpers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeHasKeptFlagHelpers()	0	3	1
A	unkeep()	0	9	2
A	scopeOnlyUnkeptOlderThanHours()	0	6	1
A	keep()	0	6	1
A	isKept()	0	3	1
A	isUnkept()	0	3	1

<?php

/*
 * This file is part of Laravel Eloquent Flag.
 *
 * (c) Anton Komarev <a.komarev@cybercog.su>
 *
 * 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\Flag\Traits\Classic;

use Cog\Flag\Scopes\Classic\KeptFlagScope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Facades\Date;

trait HasKeptFlagHelpers
{
    public function initializeHasKeptFlagHelpers(): void
    {
        $this->casts['is_kept'] = 'boolean';

The property casts does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * If entity is kept.
     *
     * @return bool
     */
    public function isKept(): bool
    {
        return $this->getAttributeValue('is_kept');

It seems like getAttributeValue() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * If entity is unkept.
     *
     * @return bool
     */
    public function isUnkept(): bool
    {
        return !$this->isKept();
    }

    /**
     * Mark entity as kept.
     *
     * @return void
     */
    public function keep(): void
    {
        $this->setAttribute('is_kept', true);

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->fireModelEvent('kept', false);

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Mark entity as unkept.
     *
     * @return void
     */
    public function unkeep(): void
    {
        $this->setAttribute('is_kept', false);
        if (property_exists($this, 'setKeptOnUpdate')) {
            $this->setKeptOnUpdate = false;

The property setKeptOnUpdate does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }
        $this->save();

        $this->fireModelEvent('unkept', false);
    }

    /**
     * Get unkept models that are older than the given number of hours.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param int $hours
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOnlyUnkeptOlderThanHours(Builder $builder, $hours)
    {
        return $builder
            ->withoutGlobalScope(KeptFlagScope::class)
            ->where('is_kept', 0)
            ->where(static::getCreatedAtColumn(), '<=', Date::now()->subHours($hours)->toDateTimeString());
    }
}