Faulancer\View\ViewController

Complexity

Total Complexity

33

Size/Duplication

Total Lines	342
Duplicated Lines	6.43 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	setTemplate()	0	16	6
A	setTemplatePath()	0	5	1
A	getTemplatePath()	0	4	1
A	addScript()	0	5	1
A	addStylesheet()	0	5	1
A	getTemplate()	0	4	1
A	setVariable()	0	4	1
A	getVariable()	0	8	2
A	hasVariable()	0	8	2
A	setVariables()	0	8	2
A	getVariables()	0	4	1
A	setParentTemplate()	0	4	1
A	getParentTemplate()	0	4	1
A	_cleanOutput()	0	8	3
B	render()	0	24	3
A	__call()	22	47	3
A	_callUserFuncArray()	0	4	1
A	__destruct()	0	5	1

<?php

namespace Faulancer\View;

use Faulancer\Event\Observer;
use Faulancer\Event\Type\OnPostRender;
use Faulancer\Event\Type\OnRender;
use Faulancer\Exception\FileNotFoundException;
use Faulancer\Exception\ServiceNotFoundException;
use Faulancer\Exception\ViewHelperException;
use Faulancer\Service\Config;
use Faulancer\ServiceLocator\ServiceLocator;

/**
 * Class ViewController | ViewController.php
 *
 * @package Faulancer\View
 * @author Florian Knapp <office@florianknapp.de>
 */
class ViewController
{

    /**
     * @var Config
     */
    private $config;

    /**
     * Holds the view variables
     * @var array
     */
    private $variable = [];

    /**
     * Holds the view template
     * @var string
     */
    private $template = '';

    /**The template path without filename
     * @var string
     */
    private $templatePath = '';

    /**
     * Holds the registered view helpers
     * @var array
     */
    //private $viewHelpers = [];

56% of this comment could be valid code. Did you maybe forget this after debugging?

    /**
     * Holds the parent template
     * @var ViewController
     */
    private $parentTemplate = null;

    /**
     * ViewController constructor.
     *
     * @throws ServiceNotFoundException
     */
    public function __construct()
    {
        $this->config = ServiceLocator::instance()->get(Config::class);

It seems like \Faulancer\ServiceLocator\ServiceLocator::instance()->get(\Faulancer\Service\Config::class) of type object<Faulancer\ServiceLocator\ServiceInterface> or object<Faulancer\ServiceLocator\FactoryInterface> is incompatible with the declared type object<Faulancer\Service\Config> of property $config.

    }

    /**
     * Set template for this view
     *
     * @param string $template
     * @return self
     *
     * @throws FileNotFoundException
     */
    public function setTemplate(string $template = '')
    {
        if (empty($this->templatePath) && strpos($template, $this->config->get('viewsRoot')) === false) {
            $template = $this->config->get('viewsRoot') . $template;
        } else {
            $template = $this->templatePath . $template;
        }

        if (empty($template) || !file_exists($template) || is_dir($template)) {
            throw new FileNotFoundException('Template "' . $template . '" not found');
        }

        $this->template = $template;

        return $this;
    }

    /**
     * Set the template path
     *
     * @param string $path
     * @return self
     */
    public function setTemplatePath(string $path = '')
    {
        $this->templatePath = $path;
        return $this;
    }

    /**
     * Get the template path
     *
     * @return string
     */
    public function getTemplatePath()
    {
        return $this->templatePath;
    }

    /**
     * Add javascript from outside
     *
     * @param string $file
     * @return self
     */
    public function addScript(string $file)
    {
        $this->variable['assetsJs'][] = $file;
        return $this;
    }

    /**
     * Add stylesheet from outside
     *
     * @param string $file
     * @return self
     */
    public function addStylesheet(string $file)
    {
        $this->variable['assetsCss'][] = $file;
        return $this;
    }

    /**
     * Return current template
     *
     * @return string
     */
    public function getTemplate() :string
    {
        return (string)$this->template;
    }

    /**
     * Set a single variable
     *
     * @param string $key
     * @param string|array $value
     */
    public function setVariable(string $key = '', $value = '')
    {
        $this->variable[$key] = $value;
    }

    /**
     * Get a single variable
     *
     * @param string $key
     * @return string|array
     */
    public function getVariable(string $key)
    {
        if(isset($this->variable[$key])) {
            return $this->variable[$key];
        }

        return '';
    }

    /**
     * Check if variable exists
     *
     * @param string $key
     * @return bool
     */
    public function hasVariable(string $key) :bool
    {
        if(isset($this->variable[$key])) {
            return true;
        }

        return false;
    }

    /**
     * Set many variables at once
     *
     * @param array $variables
     * @return self
     */
    public function setVariables(array $variables = [])
    {
        foreach($variables AS $key=>$value) {
            $this->setVariable($key, $value);
        }

        return $this;
    }

    /**
     * Get all variables
     *
     * @return array
     */
    public function getVariables() :array
    {
        return $this->variable;
    }

    /**
     * Define parent template
     *
     * @param ViewController $view
     */
    public function setParentTemplate(ViewController $view)
    {
        $this->parentTemplate = $view;
    }

    /**
     * Get parent template
     *
     * @return ViewController
     */
    public function getParentTemplate()
    {
        return $this->parentTemplate;
    }

    /**
     * Strip spaces and tabs from output
     *
     * @param $output
     * @return string
     */
    private function _cleanOutput($output) :string
    {
        if (defined('APPLICATION_ENV') && APPLICATION_ENV === 'production') {
            return preg_replace('/(\s{2,}|\t|\r|\n)/', ' ', trim($output));
        } else {
            return str_replace(["\t", "\r", "\n\n\n"], ' ', trim($output));
        }
    }

    /**
     * Render the current view
     *
     * @return string
     * @throws ServiceNotFoundException
     */
    public function render()
    {
        Observer::instance()->trigger(new OnRender($this));

        extract($this->variable);

        ob_start();

        include $this->getTemplate();

        $content = ob_get_contents();

        if (ob_get_length()) {
            ob_end_clean();
        }

        Observer::instance()->trigger(new OnPostRender($this));

        if ($this->getParentTemplate() instanceof ViewController) {
            return $this->_cleanOutput($this->getParentTemplate()->setVariables($this->getVariables())->render());
        } else {
            return $this->_cleanOutput($content);
        }
    }

    /**
     * Magic method for providing a view helpers
     *
     * @param  string $name      The class name
     * @param  array  $arguments Arguments if given
     *
     * @return AbstractViewHelper
     *
     * @throws ViewHelperException
     * @throws ServiceNotFoundException
     */
    public function __call($name, $arguments)
    {
        $coreViewHelper   = __NAMESPACE__ . '\Helper\\' . ucfirst($name);

//        if (!empty($this->viewHelpers[$coreViewHelper])) {

70% of this comment could be valid code. Did you maybe forget this after debugging?

//            return $this->_callUserFuncArray($this->viewHelpers[$coreViewHelper], $arguments);
//        }

        /** @var Config $config */
        $config           = ServiceLocator::instance()->get(Config::class);
        $namespace        = '\\' . $config->get('namespacePrefix');
        $customViewHelper = $namespace . '\\View\\Helper\\' . ucfirst($name);

//        if (!empty($this->viewHelpers[$customViewHelper])) {

70% of this comment could be valid code. Did you maybe forget this after debugging?

//            return $this->_callUserFuncArray($this->viewHelpers[$customViewHelper], $arguments);
//        }

        // Search in custom view helpers

        if (class_exists($customViewHelper)) {

This code seems to be duplicated across your project.

            /** @var AbstractViewHelper $class */
            $class = new $customViewHelper;
            $class->setView($this);

            //$this->viewHelpers[$customViewHelper] = $class;

64% of this comment could be valid code. Did you maybe forget this after debugging?

            return $this->_callUserFuncArray($class, $arguments);

        }

        // No custom view helper found, search in core view helpers

        if (class_exists($coreViewHelper)) {

This code seems to be duplicated across your project.

            /** @var AbstractViewHelper $class */
            $class = new $coreViewHelper;
            $class->setView($this);

            //$this->viewHelpers[$coreViewHelper] = $class;

64% of this comment could be valid code. Did you maybe forget this after debugging?

            return $this->_callUserFuncArray($class, $arguments);

        }

        throw new ViewHelperException('No view helper for "' . $name . '" found.');
    }

    /**
     * Abstraction of call_user_func_array
     *
     * @param $class
     * @param $arguments
     *
     * @return mixed
     */
    private function _callUserFuncArray($class, $arguments)
    {
        return call_user_func_array($class, $arguments);
    }

    /**
     * Destructor
     */
    public function __destruct()
    {
        unset( $this->variable );
        unset( $this->template );
    }

}