Cog\Flag\Traits\Inverse\HasDraftedAtHelpers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	draft()	0	5	1
A	isDrafted()	0	3	1
A	unsetDraftedFlag()	0	5	1
A	initializeHasDraftedAtHelpers()	0	3	1
A	isUndrafted()	0	3	1
A	setDraftedFlag()	0	5	1
A	undraft()	0	5	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\Inverse;

use Illuminate\Support\Carbon;

trait HasDraftedAtHelpers
{
    public function initializeHasDraftedAtHelpers(): void
    {
        $this->dates[] = 'drafted_at';

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

    }

    /**
     * Set drafted flag.
     *
     * @return static
     */
    public function setDraftedFlag()
    {
        $this->setAttribute('drafted_at', Carbon::now());

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

        return $this;
    }

    /**
     * Unset drafted flag.
     *
     * @return static
     */
    public function unsetDraftedFlag()
    {
        $this->setAttribute('drafted_at', null);

        return $this;
    }

    /**
     * If entity is drafted.
     *
     * @return bool
     */
    public function isDrafted(): bool
    {
        return !is_null($this->getAttributeValue('drafted_at'));

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 opened.
     *
     * @return bool
     */
    public function isUndrafted(): bool
    {
        return !$this->isDrafted();
    }

    /**
     * Mark entity as drafted.
     *
     * @return void
     */
    public function draft(): void
    {
        $this->setDraftedFlag()->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('drafted', 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 opened.
     *
     * @return void
     */
    public function undraft(): void
    {
        $this->unsetDraftedFlag()->save();

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