Cog\Flag\Traits\Classic\HasPublishedFlagHelpers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeHasPublishedFlagHelpers()	0	3	1
A	publish()	0	5	1
A	setPublishedFlag()	0	5	1
A	unsetPublishedFlag()	0	5	1
A	isUnpublished()	0	3	1
A	unpublish()	0	5	1
A	isPublished()	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;

trait HasPublishedFlagHelpers
{
    public function initializeHasPublishedFlagHelpers(): void
    {
        $this->casts['is_published'] = 'boolean';

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

    }

    /**
     * Set published flag.
     *
     * @return static
     */
    public function setPublishedFlag()
    {
        $this->setAttribute('is_published', true);

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 published flag.
     *
     * @return static
     */
    public function unsetPublishedFlag()
    {
        $this->setAttribute('is_published', false);

        return $this;
    }

    /**
     * If entity is published.
     *
     * @return bool
     */
    public function isPublished(): bool
    {
        return $this->getAttributeValue('is_published');

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

    /**
     * Mark entity as published.
     *
     * @return void
     */
    public function publish(): void
    {
        $this->setPublishedFlag()->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('published', 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 unpublished.
     *
     * @return void
     */
    public function unpublish(): void
    {
        $this->unsetPublishedFlag()->save();

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