roboapp\crud\BaseAction

Complexity

Total Complexity

12

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	6

Test Coverage

Coverage

74.19%

Importance

Changes	4
Bugs	3	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getModel()	0	13	3
B	redirect()	0	18	5
A	addSuccessFlash()	0	8	2
A	addErrorFlash()	0	8	2

<?php
/**
 * @link https://github.com/roboapp
 * @copyright Copyright (c) 2016 Roboapp
 * @license [MIT License](https://opensource.org/licenses/MIT)
 */

namespace roboapp\crud;

use Yii;
use yii\base\Action;
use yii\db\ActiveRecord;
use yii\di\Instance;
use yii\web\NotFoundHttpException;
use yii\web\Session;

/**
 * A base class for CRUD actions.
 *
 * @author iRipVanWinkle <iripvanwinkle@gmail.com>
 * @since 1.0
 */
class BaseAction extends Action
{
    /**
     * @var callable a PHP callable that will be called to return the model corresponding
     * to the specified primary key value.
     * The signature of the callable should be:
     *
     * ```php
     * function ($params) {
     *     // $params is the params from request
     * }
     * ```
     *
     * The callable should return the model found. Otherwise the not found exception will be thrown.
     */
    public $findModel;

    /**
     * @var mixed $redirectTo the route to redirect to. It can be one of the followings:
     *
     * - A PHP callable. The callable will be executed to get route. The signature of the callable
     *   should be:
     *
     * ```php
     * function ($model){
     *     // $model is the model object.
     * }
     * ```
     *
     * The callable should return route/url to redirect to.
     *
     * - An array. Treated as route.
     * - A string. Treated as url.
     */
    public $redirectTo = null;

    /**
     * @var string the message shown after success completed operation.
     */
    public $successMessage = '';

    /**
     * @var string the message shown after completed operation with error.
     */
    public $errorMessage = '';

    /**
     * @var string the Session object or the application component ID of the session object.
     */
    public $session = 'session';

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

    /**
     * If the data model is not found, an exception is thrown HTTP 404
     * @param mixed $id
     * @return ActiveRecord
     * @throws NotFoundHttpException
     */
    public function getModel($id)
    {
        if (!is_array($id)) {
            $id = [$id];
        }

        $model = call_user_func($this->findModel, $id);
        if ($model === null) {
            throw new NotFoundHttpException('The requested page does not exist.');
        }

        return $model;
    }


    /**
     * Redirect to route passed as param
     * @param ActiveRecord $model
     * @return mixed
     */
    public function redirect(ActiveRecord $model = null)
    {
        $route = $this->redirectTo;
        $controller = $this->controller;
        $request = Yii::$app->getRequest();

        // if callable
        if ($model && $route instanceof \Closure) {
            $route = call_user_func($route, $model);
        }

        if ($route === null) {
            return $request->getReferrer() ?
                $controller->redirect($request->getReferrer()) : $controller->goHome();
        }

        return $controller->redirect($route);
    }

     /**
     * Adds flash message about success completed operation.
     */
    public function addSuccessFlash()
    {
        if ($this->successMessage) {
            /* @var Session $session */
            $session = Instance::of($this->session)->get();
            $session->addFlash('success', $this->successMessage);
        }
    }

    /**
     * Adds flash message if completed operation with error.
     */
    public function addErrorFlash()
    {
        if ($this->errorMessage) {
            /* @var Session $session */
            $session = Instance::of($this->session)->get();
            $session->addFlash('error', $this->errorMessage);
        }
    }
}