flipbox\spark\filters\RawFilter

Complexity

Total Complexity

11

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	afterAction()	0	8	2
A	renderTemplate()	0	10	2
A	findView()	0	17	3
A	resolveView()	0	18	4

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/guardian/license
 * @link       https://www.flipboxfactory.com/software/guardian/
 */

namespace flipbox\spark\filters;

use Craft;
use craft\helpers\Template;
use flipbox\spark\helpers\ViewHelper;
use flipbox\spark\views\ViewInterface;
use yii\base\ActionFilter;
use yii\base\Exception;
use yii\web\Controller;
use yii\web\Response;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 *
 * @property Controller $sender
 */
class RawFilter extends ActionFilter
{
    /**
     * @var array this property defines the transformers for each action.
     * Each action that should only support one transformer.
     *
     * You can use `'*'` to stand for all actions. When an action is explicitly
     * specified, it takes precedence over the specification given by `'*'`.
     *
     * For example,
     *
     * ```php
     * [
     *   'create' => $view,
     *   'update' => $view,
     *   'delete' => $view,
     *   '*' => $view,
     * ]
     * ```
     */
    public $actions = [];

    /**
     * @var array|ViewInterface
     */
    public $view;

    /**
     * @param \yii\base\Action $action
     * @param mixed $result
     * @return mixed|\Twig_Markup
     */
    public function afterAction($action, $result)
    {
        if (Craft::$app->getResponse()->format === Response::FORMAT_RAW) {
            return $this->renderTemplate($result);
        }
        
        return parent::afterAction($action, $result);
    }

    /**
     * @param $data
     * @return \Twig_Markup
     */
    protected function renderTemplate($data)
    {
        if (!$view = $this->findView()) {
            return $data;
        }

        return Template::raw(
            $this->resolveView($view)->render($data)
        );
    }

    /**
     * @return ViewInterface|array|null
     * @throws Exception
     */
    protected function findView()
    {
        // The requested action
        $action = Craft::$app->requestedAction->id;

        // Default view
        $view = $this->view;

        // Look for definitions
        if (isset($this->actions[$action])) {
            $view = $this->actions[$action];
        } elseif (isset($this->actions['*'])) {
            $view = $this->actions['*'];
        }

        return $view;
    }

    /**
     * @param $view
     * @return ViewInterface
     * @throws Exception
     */
    protected function resolveView($view): ViewInterface
    {
        if (ViewHelper::isView($view)) {
            return $view;
        }

        if (ViewHelper::isViewClass($view)) {
            return new $view();
        }

        $view = Craft::createObject($view);

        if (!$view instanceof ViewInterface) {
            throw new Exception("Invalid view");
        }

        return $view;
    }
}