Imanghafoori\Widgets\Utils\WidgetRenderer

Complexity

Total Complexity

10

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	renderWidget()	0	10	2
A	generateHtml()	0	16	2
A	prepareDataForView()	0	13	2
A	renderTemplate()	0	19	3

<?php

namespace Imanghafoori\Widgets\Utils;

use Illuminate\Contracts\Debug\ExceptionHandler;


class WidgetRenderer
{
    public $html;
    private $viewData;
    private $policies;

    /**
     * BaseWidget constructor.
     */
    public function __construct()
    {
        $this->policies = app('imanghafoori.widget.policies');
    }

    /**
     * @param $widget
     * @param array $args
     * @return string
     */
    public function renderWidget($widget, ...$args)
    {
        app('imanghafoori.widget.normalizer')->normalizeWidgetConfig($widget);
        try {
            $html = $this->generateHtml($widget, ...$args);
        } catch (\Exception $e) {
            return app()->make(ExceptionHandler::class)->render(app('request'), $e)->send();
        }
        return $html;
    }

    /**
     * It tries to get the html from cache if possible, otherwise generates it.
     * @param $widget
     * @param array ...$args
     * @return string
     */
    private function generateHtml($widget, ...$args)
    {
        // Everything inside this function is executed only when the cache is not available.
        $expensivePhpCode = function () use ($widget, $args) {
            $this->prepareDataForView($widget, $args);
            // render the template with the resulting data.
            return $this->renderTemplate($widget);
        };

        // We first try to get the output from the cache before trying to run the expensive $expensivePhpCode...
        if ($this->policies->widgetShouldUseCache($widget->cacheLifeTime)) {
            return app('imanghafoori.widget.cache')->cacheResult($args, $expensivePhpCode, $widget);
        }

        return $expensivePhpCode();
    }


    /**
     * @param $widget
     * @param $args
     * @return null
     */
    private function prepareDataForView($widget, $args)
    {
        // Here we call the data method on the widget class.
        $viewData = \App::call($widget->controller, $args);

        if (($widget->presenter)) {
            // We make an object and call the `present` method on it.
            // Piping the data through the presenter before sending it to view.
            $viewData = \App::call($widget->presenter, [$viewData]);
        }

        $this->viewData = $viewData;
    }

    private function renderTemplate($widget)
    {
        // Here we render the view file to raw html.
        $this->html = view($widget->template, [$widget->contextAs => $this->viewData])->render();

The method render does only exist in Illuminate\View\View, but not in Illuminate\Contracts\View\Factory.

        // We try to minify the html before storing it in cache to save space.
        if ($this->policies->widgetShouldBeMinified()) {
            $this->html = app('imanghafoori.widget.minifier')->minify($this->html);
        }

        // We add some HTML comments before and after the widget output
        // So then, we will be able to easily identify the widget in browser's developer tool.
        if ($this->policies->widgetShouldHaveDebugInfo()) {
            $this->html = app('imanghafoori.widget.debugInfo')->addIdentifierToHtml($widget, $this->html);
        }


        return $this->html;
    }

}