flipbox\spark\records\traits\RecordWithState

Complexity

Total Complexity

5

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	stateRules()	0	16	1
A	isEnabled()	0	4	1
A	isDisabled()	0	4	1
A	toEnabled()	0	5	1
A	toDisabled()	0	5	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipbox/spark/blob/master/LICENSE
 * @link       https://github.com/flipbox/spark
 */

namespace flipbox\spark\records\traits;

use flipbox\spark\helpers\RecordHelper;

/**
 * @property bool $enabled
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.2.0
 */
trait RecordWithState
{

    /**
     * @var bool Enabled
     */
    public $enabled;

    /**
     * @inheritdoc
     */
    protected function stateRules()
    {

        return [
            [
                [
                    'enabled'
                ],
                'safe',
                'on' => [
                    RecordHelper::SCENARIO_DEFAULT
                ]
            ]
        ];

    }

    /**
     * @inheritdoc
     */
    public function isEnabled()
    {
        return (bool)$this->enabled;
    }

    /**
     * @inheritdoc
     */
    public function isDisabled()
    {
        return !$this->isEnabled();
    }

    /**
     * @inheritdoc
     */
    public function toEnabled()
    {
        $this->enabled = true;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function toDisabled()
    {
        $this->enabled = false;
        return $this;
    }

}