Cog\Flag\Traits\Inverse\HasClosedAtHelpers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeHasClosedAtHelpers()	0	3	1
A	close()	0	5	1
A	unsetClosedFlag()	0	5	1
A	setClosedFlag()	0	5	1
A	isClosed()	0	3	1
A	isOpened()	0	3	1
A	open()	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 HasClosedAtHelpers
{
    public function initializeHasClosedAtHelpers(): void
    {
        $this->dates[] = 'closed_at';

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

    }

    /**
     * Set closed flag.
     *
     * @return static
     */
    public function setClosedFlag()
    {
        $this->setAttribute('closed_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 closed flag.
     *
     * @return static
     */
    public function unsetClosedFlag()
    {
        $this->setAttribute('closed_at', null);

        return $this;
    }

    /**
     * If entity is closed.
     *
     * @return bool
     */
    public function isClosed(): bool
    {
        return !is_null($this->getAttributeValue('closed_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 isOpened(): bool
    {
        return !$this->isClosed();
    }

    /**
     * Mark entity as closed.
     *
     * @return void
     */
    public function close(): void
    {
        $this->setClosedFlag()->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('closed', 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 open(): void
    {
        $this->unsetClosedFlag()->save();

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