erdiko\core\Layout

Complexity

Total Complexity

16

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	1	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	setTitle()	0	4	1
A	getTitle()	0	4	1
A	getTemplateFile()	0	10	1
A	setViewRootFolder()	0	4	1
A	getThemeRootFolder()	0	4	1
A	setThemeRootFolder()	0	4	1
A	setThemeName()	0	4	1
A	getThemeName()	0	4	1
A	setRegion()	0	4	1
A	setRegions()	0	4	1
A	getRegions()	0	4	1
A	getRegion()	0	11	3
A	toHtml()	0	7	1

<?php
/**
 * Layout
 * @todo allow switching between layout templates in the theme and the views folder
 *
 * @package     erdiko/core
 * @copyright   2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
 * @author      John Arroyo <john@arroyolabs.com>
 */
namespace erdiko\core;


class Layout extends Container
{
    /** Theme Template folder */
    protected $_themeRootFolder;
    /** Regions */
    protected $_regions = array();
    /** Data */
    protected $_data = array();
    /** Title */
    protected $_title = "";
    /** Theme */
    protected $_theme;
    /** Theme */
    protected $_viewRootFolder;
    

    /**
     * Constructor
     *
     * @param string $template , Theme Object (Contaier)
     * @param mixed $data
     * @param string $theme

There is no parameter named $theme. Was it maybe removed?

     */
    public function __construct($template = null, $data = array(), $themeName = null)
    {
        $this->initiate($template, $data); // @todo don't store in both _data and _regions
        $this->setRegions($data);
        $this->setThemeRootFolder('themes');
        $this->setThemeName($themeName);
        $this->setTemplateFolder($this->getThemeRootFolder().'/'.$themeName.'/templates/layouts');
    }

    /**
     * setTitle
     *
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->_title = $title;
    }

    /**
     * getTitle
     *
     * @return string $title
     */
    public function getTitle()
    {
        return $this->_title;
    }

    /**
     * Get template file
     *
     * @param string $filename
     * @param mixed $data Typically a string, Container object or other object
     * @return string
     * @todo array merge regions with data
     */
    public function getTemplateFile($filename, $data)
    {
        $data['getRegion'] = function($name) { 
            return $this->getRegion($name); 
            }; // This is for mustache compatibility

        // Push the data into regions and then pass a pointer to this class to the layout
        // $this->setRegions($data);

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

        return parent::getTemplateFile($filename, $data); // Pass in layout object to template
    }

    /**
     * Set View Root Folder
     *
     * @param string $folder
     */
    public function setViewRootFolder($folder)
    {
        $this->_viewRootFolder = $folder;
    }

    /**
     * Get Theme Root Folder
     *
     * @param string $folder

There is no parameter named $folder. Was it maybe removed?

     */
    public function getThemeRootFolder()
    {
        return $this->_themeRootFolder;
    }

    /**
     * Set Theme Root Folder
     *
     * @param string $folder
     */
    public function setThemeRootFolder($folder)
    {
        $this->_themeRootFolder = $folder;
    }

    /**
     * Set theme name
     *
     * @param string $themeName
     */
    public function setThemeName($themeName)
    {
        $this->_theme = $themeName;
    }

    /**
     * Get theme name
     */
    public function getThemeName()
    {
        return $this->_theme;
    }

    /**
     * set region
     *
     * @param string $name
     * @param mixed $content , Typically a string, Container object or other object
     */
    public function setRegion($name, $content)
    {
        $this->_regions[$name] = $content;
    }

    /**
     * Set all regions at once
     *
     * @param array $data , Associative array of containers/strings
     */
    public function setRegions($data)
    {
        $this->_regions = $data;
    }

    /**
     * Get regions
     *
     * @return array $this_regions
     */
    public function getRegions()
    {
        return $this->_regions;
    }

    /**
     * get rendered region
     *
     * @param string $name
     * @return mixed $content, typically a string, Container object or other object
     */
    public function getRegion($name)
    {
        if(array_key_exists($name, $this->_regions)) {
            $html = (is_subclass_of($this->_regions[$name], 'erdiko\core\Container')) ?
                $this->_regions[$name]->toHtml() : $this->_regions[$name];
        } else {
            throw new \Exception("Template region '{$name}' does not exits.");
        }
        
        return $html;
    }

    /**
     * Render container to HTML
     *
     * @return string $html
     */
    public function toHtml()
    {
        $filename = $this->getTemplateFolder().$this->getTemplate();
        // $data = (is_subclass_of($this->_data, 'erdiko\core\Container')) ? $this->_data->toHtml() : $this->_data;

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

        return $this->getTemplateFile($filename, $this->_data);
    }
}