hipanel\actions\Action

Complexity

Total Complexity

44

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

0%

Importance

Changes	4
Bugs	1	Features	1

18 Methods

Rating	Name	Duplication	Size	Complexity
A	setScenario()	0	4	1
A	getScenario()	0	4	3
B	perform()	0	21	5
A	setCollection()	0	4	1
B	getCollection()	0	23	4
A	beforeLoad()	0	8	2
A	loadCollection()	0	10	2
A	beforeSave()	0	8	2
A	saveCollection()	0	5	1
A	beforePerform()	0	8	2
A	afterPerform()	0	8	2
A	getModel()	0	4	2
A	getModelClass()	0	12	3
A	getModels()	0	4	2
A	prepareData()	0	4	2
A	getUniqueId()	0	4	2
A	getFlashText()	0	10	3
B	addFlash()	0	16	5

<?php

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

namespace hipanel\actions;

use Closure;
use hipanel\base\Controller;
use hiqdev\hiart\Collection;
use hiqdev\hiart\ErrorResponseException;
use Yii;
use yii\base\InvalidCallException;
use yii\helpers\ArrayHelper;

/**
 * HiPanel basic action.
 * Holds scenario and collection. Displays flash.
 *
 * @property Collection collection
 */
class Action extends \yii\base\Action
{
    const EVENT_BEFORE_SAVE = 'beforeSave';
    const EVENT_BEFORE_LOAD = 'beforeLoad';
    const EVENT_BEFORE_PERFORM = 'beforePerform';
    const EVENT_AFTER_PERFORM = 'afterPerform';

    /**
     * @var Controller the controller that owns this action
     */
    public $controller;

    /**
     * @var Action|SwitchAction parent called action
     */
    public $parent;

    /**
     * @var string scenario to be used when save
     */
    public $_scenario;

    /**
     * @var array|Closure additional data passed when rendering
     */
    public $data = [];

    /**
     * @param string $scenario
     */
    public function setScenario($scenario)
    {
        $this->_scenario = $scenario;
    }

    /**
     * @return string
     */
    public function getScenario()
    {
        return $this->_scenario ?: ($this->parent ? $this->parent->getScenario() : $this->id);
    }

    /**
     * @var Collection|array the options that will be used to create the collection.
     * Stores collection after creating
     */
    protected $_collection;

    /**
     * Setter for the collection.
     *
     * @param array $collection config for the collection
     */
    public function setCollection($collection)
    {
        $this->_collection = $collection;
    }

    /**
     * Gets the instance of the collection.
     *
     * @return Collection
     */
    public function getCollection()
    {
        if ($this->parent) {
            return $this->parent->getCollection();
        }

        if (!is_object($this->_collection)) {
            $action = $this->controller->action;
            if ($action instanceof self) {
                $scenario = $action->getScenario();
            } else {
                $scenario = $action->id;
            }

            $this->_collection = Yii::createObject(ArrayHelper::merge([
                'class' => Collection::className(),
                'model' => $this->controller->newModel(),
                'scenario' => $scenario,
            ], (array) $this->_collection));
        }

        return $this->_collection;
    }

    /**
     * @var callable the custom callback to load data into the collection. Gets [[$this]] as the only argument
     * Should call `$this->collection->load()`
     */
    public $collectionLoader;

    public function beforeLoad()
    {
        if (isset($this->parent)) {
            $this->parent->trigger(static::EVENT_BEFORE_LOAD);
        }

        $this->trigger(static::EVENT_BEFORE_LOAD);
    }

    /**
     * Loads data to the [[collection]].
     *
     * @param array $data
     */
    public function loadCollection($data = null)
    {
        $this->beforeLoad();

        if ($this->collectionLoader instanceof Closure) {
            call_user_func($this->collectionLoader, $this, $data);
        } else {
            $this->collection->load($data);
        }
    }

    public function beforeSave()
    {
        if (isset($this->parent)) {
            $this->parent->trigger(static::EVENT_BEFORE_SAVE);
        }

        $this->trigger(static::EVENT_BEFORE_SAVE);
    }

    /**
     * Saves stored [[collection]].
     *
     * @return bool
     */
    public function saveCollection()
    {
        $this->beforeSave();
        return $this->collection->save();
    }

    public function beforePerform()
    {
        if (isset($this->parent)) {
            $this->parent->trigger(static::EVENT_BEFORE_PERFORM);
        }

        $this->trigger(static::EVENT_BEFORE_PERFORM);
    }

    public function afterPerform()
    {
        if (isset($this->parent)) {
            $this->parent->trigger(static::EVENT_AFTER_PERFORM);
        }

        $this->trigger(static::EVENT_AFTER_PERFORM);
    }

    /**
     * Performs action.
     *
     * @return boolean|string Whether save is success
     *  - boolean true or sting - an error
     *  - false - no errors
     */
    public function perform()
    {
        $this->beforePerform();

        $this->loadCollection();

        try {
            $error = !$this->saveCollection();

            if ($error === true && $this->collection->hasErrors()) {
                $error = $this->collection->getFirstError();
            }
        } catch (ErrorResponseException $e) {
            $error = $e->getMessage();
        } catch (InvalidCallException $e) {
            $error = $e->getMessage();
        }

        $this->afterPerform();
        return $error;
    }

    /**
     * @return \hiqdev\hiart\ActiveRecord
     */
    public function getModel()
    {
        return $this->parent ? $this->parent->getModel() : $this->getCollection()->first;
    }

    /**
     * Return the model class name
     *
     * @return string
     */
    public function getModelClass()
    {
        if (isset($this->parent)) {
            return $this->parent->getModelClass();
        }

        if (isset($this->getCollection()->first)) {
            return $this->getCollection()->first->className();
        }

        return $this->getCollection()->getModel()->className();
    }

    /**
     * @return \hiqdev\hiart\ActiveRecord[]
     */
    public function getModels()
    {
        return $this->parent ? $this->parent->getModels() : $this->getCollection()->models;
    }

    /**
     * Prepares additional data for render.
     *
     * @param $data array Additional data, prepared by other classes. Optional.
     * @return array
     */
    public function prepareData($data = [])
    {
        return (array) ($this->data instanceof Closure ? call_user_func($this->data, $this, $data) : $this->data);
    }

    /**
     * {@inheritdoc}
     */
    public function getUniqueId()
    {
        return $this->parent !== null ? $this->parent->getUniqueId() : $this->controller->getUniqueId() . '/' . $this->id;
    }

    /**
     * Returns text for flash messages, search in parent actions.
     * Used by [[addFlash()]].
     *
     * @param $type string
     * @return string
     */
    public function getFlashText($type)
    {
        if ($this->{$type}) {
            return $this->{$type};
        } elseif ($this->parent) {
            return $this->parent->getFlashText($type);
        }

        return $type;
    }

    /**
     * Adds flash message.
     *
     * @param string $type the type of flash
     * @param string $error the text of error
     */
    public function addFlash($type, $error = null)
    {
        if ($type === 'error' && is_string($error) && !empty($error)) {
            $text = Yii::t('app', $error);
        } else {
            $text = $this->getFlashText($type);
        }

        if ($type instanceof \Closure) {
            $text = call_user_func($text, $text, $this);
        }

        Yii::$app->session->addFlash($type, [
            'text' => $text,
        ]);
    }
}