Imanghafoori\Widgets\Utils\WidgetRenderer

Complexity

Total Complexity

14

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

89.47%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	generateHtml()	0	17	2
A	makeDataForView()	0	13	2
A	renderTemplate()	0	18	3
A	renderWidget()	0	20	4
A	makeWidgetObj()	0	10	2

<?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(Policies::class);
    }

    /**
     * @param $widget object|string
     * @param array $args
     * @return string
     */
    public function renderWidget($widget, ...$args)
    {
        if (is_string($widget)) {
            $widget = $this->makeWidgetObj($widget);
        }

        app(Normalizer::class)->normalizeWidgetConfig($widget);

        if (app()->offsetExists('debugbar')) {
            app('widgetize.debugger')->addMessage(['widget class:' => $widget, 'args:' => $args]);
        }

        try {
            $html = $this->generateHtml($widget, ...$args);
        } catch (\Exception $e) {
            return app()->make(ExceptionHandler::class)->render(app('request'), $e)->send();
        }

        return $html;
    }

    /**
     * @param $widget object
     * @return \Illuminate\Foundation\Application|mixed
     */
    private function makeWidgetObj($widget)
    {
        if (starts_with($widget, ['\\'])) {
            return app($widget);
        }

        $widget = app()->getNamespace().'Widgets\\'.$widget;

        return app($widget);
    }

    /**
     * It tries to get the html from cache if possible, otherwise generates it.
     *
     * @param $widget object
     * @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->makeDataForView($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(Cache::class)->cacheResult($args, $expensivePhpCode, $widget);
        }

        return $expensivePhpCode();
    }

    /**
     * @param $widget object
     * @param $args array
     *
     * @return null
     */
    private function makeDataForView($widget, array $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;
    }

    /**
     * @param $widget object
     * @return string HTML output
     */
    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(HtmlMinifier::class)->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(DebugInfo::class)->addIdentifierToHtml($widget, $this->html);
        }

        return $this->html;
    }
}