Faulancer\View\ViewController

Complexity

Total Complexity

25

Size/Duplication

Total Lines	241
Duplicated Lines	4.98 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
B	setTemplate()	0	17	5
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	4	1
A	render()	0	18	2
B	__call()	12	26	3
A	__destruct()	0	5	1

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

use Faulancer\Exception\ClassNotFoundException;
use Faulancer\Exception\ConstantMissingException;
use Faulancer\Exception\FileNotFoundException;
use Faulancer\Exception\ViewHelperIncompatibleException;
use Faulancer\Service\Config;
use Faulancer\ServiceLocator\ServiceLocator;

/**
 * Class ViewController
 */
class ViewController
{

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

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

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

    /**
     * Holds the registered view helper
     * @var array
     */
    public $viewHelper = [];

    /**
     * Set template for this view
     * @param string $template
     * @return self
     * @throws ConstantMissingException
     * @throws FileNotFoundException
     */
    public function setTemplate(string $template = '') :self
    {
        /** @var Config $config */
        $config = ServiceLocator::instance()->get(Config::class);

        if (strpos($template, $config->get('viewsRoot')) === false) {
            $template = $config->get('viewsRoot') . $template;
        }

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

        $this->template = $template;

        return $this;
    }

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

    /**
     * Add stylesheet from outside
     * @param string $file
     * @return self
     */
    public function addStylesheet($file) :self
    {
        $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 $key
     * @return string|array
     */
    public function getVariable($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 = []) :self
    {
        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
    {
        return str_replace(array("\t", "\r", "  "), "", trim($output));
    }

    /**
     * Render the current view
     * @return string
     */
    public function render() :string
    {
        extract($this->variable);

        ob_start();

        include $this->getTemplate();

        $content = ob_get_contents();

        ob_end_clean();

        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 helper
     * @param $name
     * @param $arguments
     * @return string
     * @throws FileNotFoundException
     * @throws ViewHelperIncompatibleException
     * @throws ClassNotFoundException
     */
    public function __call($name, $arguments)
    {
        $coreViewHelper = __NAMESPACE__ . '\Helper\\' . ucfirst($name);

        if (class_exists($coreViewHelper)) {

This code seems to be duplicated across your project.

            $class = new $coreViewHelper;
            array_unshift($arguments, $this);
            $this->viewHelper[$coreViewHelper] = call_user_func_array($class, $arguments);
            return $this->viewHelper[$coreViewHelper];
        }

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

        $customViewHelper = $namespace . '\\View\\' . ucfirst($name);

        if (class_exists($customViewHelper)) {

This code seems to be duplicated across your project.

            $class = new $customViewHelper;
            array_unshift($arguments, $this);
            $this->viewHelper[$customViewHelper] = $class($arguments);
            return $this->viewHelper[$customViewHelper];
        }

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

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

}