hipanel\actions\SwitchAction

Complexity

Total Complexity

12

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	6	1
A	getDefaultRules()	0	4	1
A	getItemConfig()	0	12	1
B	run()	0	21	7
A	perform()	0	8	2

<?php
/**
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\actions;

use hiqdev\hiart\Collection;
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;

/**
 * Class SwitchAction.
 *
 * @property Collection|mixed $collection
 */
class SwitchAction extends Action implements \ArrayAccess, \IteratorAggregate, \yii\base\Arrayable
{
    use \hiqdev\yii2\collection\ManagerTrait;

    /**
     * @var string|callable the success message or a callback, that returns string.
     * Gets arguments
     */
    public $success;

    /**
     * @var string the error message
     */
    public $error;

    /**
     * @var SwitchRule instance of the current running rule
     */
    public $rule;

    /** {@inheritdoc} */
    public function init()
    {
        parent::init();

        $this->addItems($this->getDefaultRules());
    }

    /**
     * @return array the default rules for the action.
     * You can override this method in child classes to set own default rules.
     */
    protected function getDefaultRules()
    {
        return [];
    }

    public function getItemConfig($name = null, array $config = [])
    {
        return [
            'class'   => SwitchRule::class,
            'name'    => $name,
            'switch'  => $this,
            'save'    => ArrayHelper::remove($config, 'save'),
            'success' => ArrayHelper::remove($config, 'success', $config),
            'error'   => ArrayHelper::remove($config, 'error'),
            'flash'   => ArrayHelper::remove($config, 'flash', true),
        ];
    }

    public function run()
    {
        foreach ($this->keys() as $k) {
            $rule = $this->getItem($k);
            if ($rule instanceof SwitchRule && $rule->isApplicable()) {
                $oldRule    = $this->rule;
                $this->rule = $rule;
                $error      = $this->perform();
                $type       = $error ? 'error' : 'success';
                if ($rule->save && $rule->flash) {
                    $this->addFlash($type, $error);

It seems like $error defined by $this->perform() on line 79 can also be of type boolean; however, hipanel\actions\Action::addFlash() does only seem to accept string|null, maybe add an additional type check?

                }
                $result     = $rule->run($type);
                $this->rule = $oldRule;

                return $result;
            }
        }

        throw new InvalidConfigException('Broken SwitchAction, no applicable rule found');
    }

    /**
     * Does perform only if rule has 'save' enabled.
     */
    public function perform()
    {
        if (!$this->rule->save) {
            return false;
        }

        return parent::perform();
    }
}