erdiko\core\Controller

Complexity

Total Complexity

55

Size/Duplication

Total Lines	488
Duplicated Lines	2.05 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

38 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	_before()	0	5	1
A	_after()	0	4	1
A	get()	0	10	2
A	put()	0	10	2
A	post()	0	10	2
A	delete()	0	10	2
A	setPathInfo()	0	4	1
A	prepareTheme()	0	4	1
A	setThemeName()	0	4	1
A	setTheme()	0	5	1
A	getThemeName()	0	4	1
A	setThemeTemplate()	0	4	1
A	getResponse()	0	4	1
A	send()	0	4	1
A	setResponseKeyValue()	0	4	1
A	getResponseKeyValue()	0	4	1
A	setPageTitle()	0	4	1
A	setBodyTitle()	0	5	1
A	getBodyTitle()	0	4	1
A	setTitle()	0	5	1
A	getTitle()	0	4	1
A	setContent()	0	4	1
A	appendContent()	0	4	1
A	_autoaction()	0	11	2
A	_replaceActionName()	0	4	1
A	urlToActionName()	0	7	1
A	getView()	10	10	2
A	addView()	0	9	3
A	getLayout()	0	12	2
A	redirect()	0	5	1
A	addMeta()	0	4	1
A	setMeta()	0	5	2
A	addCss()	0	6	1
A	addJs()	0	6	1
A	__get()	0	4	1
A	__set()	0	4	1
B	addPhpToJs()	0	16	7

<?php
/**
 * Controller
 * Base request handler, All controllers should be a child this class
 * or one of the subclasses (e.g. AjaxController or ApiController).
 *
 * @package     erdiko/core
 * @copyright   2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
 * @author      John Arroyo <john@arroyolabs.com>
 */
namespace erdiko\core;


class Controller
{
    /** Response */
    protected $_response;
    /** Webroot */
    protected $_webroot;
    /** Theme name */
    protected $_themeName = null;
    /** Request URI */
    protected $_pathInfo = null;
    /** Title (body title) */
    protected $_title = null;
    
    /**
     * Constructor
     */
    public function __construct()
    {
        $this->_webroot = ERDIKO_ROOT;
        $this->_response = new \erdiko\core\Response;

        if ($this->_themeName != null) {
            $this->_response->setThemeName($this->_themeName);
        }
    }

    /**
     * Before action hook
     * Anything here gets called immediately BEFORE the Action method runs.
     */
    public function _before()
    {
        // Set up the theme object
        $this->prepareTheme();
    }

    /**
     * After action hook
     * Anything here gets called immediately AFTER the Action method runs.
     */
    public function _after()
    {
        // do something...
    }

    /**
     * Get action
     *
     * @param mixed $var
     * @return mixed
     */
    public function get($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'get');

        } else {
            return $this->getIndex();

The method getIndex() does not seem to exist on object<erdiko\core\Controller>.

        }
    }

    /**
     * Put action
     *
     * @param mixed $var
     * @return mixed
     */
    public function put($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'put');

        } else {
            return $this->getIndex();

The method getIndex() does not seem to exist on object<erdiko\core\Controller>.

        }
    }

    /**
     * Post action
     *
     * @param mixed $var
     * @return mixed
     */
    public function post($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'post');

        } else {
            return $this->getIndex();

The method getIndex() does not seem to exist on object<erdiko\core\Controller>.

        }
    }

    /**
     * Delete action
     *
     * @param mixed $var
     * @return mixed
     */
    public function delete($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'delete');

        } else {
            return $this->getIndex();

The method getIndex() does not seem to exist on object<erdiko\core\Controller>.

        }
    }

    /**
     * Set Path Info (Requested URI)
     */
    public function setPathInfo($pathInfo)
    {
        $this->_pathInfo = $pathInfo;
    }

    /**
     * Prepare theme
     */
    public function prepareTheme()
    {
        $this->getResponse()->setTheme(new \erdiko\core\Theme($this->getThemeName()));
    }

    /**
     * Set the theme name in the response object
     * 
     * @param string $name, the name/id of the theme

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

     */
    public function setThemeName($name)
    {
        $this->getResponse()->setThemeName($name);
    }

    /**
     * Set the theme name in both the response and the theme objects
     * 
     * @param string $name, the name/id of the theme

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

     */
    public function setTheme($name)
    {
        $this->getResponse()->setThemeName($name);
        $this->getResponse()->getTheme()->setName($name);
    }

    /**
     * Get the theme name
     *
     * @return string $name
     */
    public function getThemeName()
    {
        return $this->getResponse()->getThemeName();
    }

    /**
     * Set the theme template used to render the page
     * @param string $template
     */
    public function setThemeTemplate($template)
    {
        $this->getResponse()->setThemeTemplate($template);
    }

    /**
     * Get Response object
     *
     * @return ResponseObject
     */
    public function getResponse()
    {
        return $this->_response;
    }

    /**
     * Send
     */
    final public function send()
    {
        echo $this->getResponse()->render();
    }

    /**
     * Set Response key/value data
     * formerly called, setResponseDataValue()
     *
     * @param string $key
     * @param mixed $value
     */
    public function setResponseKeyValue($key, $value)
    {
        $this->getResponse()->setKeyValue($key, $value);
    }

    /**
     * Get Response data value
     *
     * @param string $key
     */
    public function getResponseKeyValue($key)
    {
        return $this->getResponse()->getKeyValue($key);
    }

    /**
     * Add page title text to current page
     *
     * @param string $title
     */
    public function setPageTitle($title)
    {
        $this->getResponse()->getTheme()->setPageTitle($title);
    }

    /**
     * Set page content title to be themed in the view
     *
     * @param string $title
     */
    public function setBodyTitle($title)
    {
        $this->getResponse()->getTheme()->setBodyTitle($title);
        $this->_title = $title;
    }

    /**
     * Get page content title to be themed in a layout or view
     *
     * @param string $title

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

     */
    public function getBodyTitle()
    {
        return $this->getResponse()->getTheme()->getBodyTitle();
    }

    /**
     * Set both the title (header) and page title (body) at the same time
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->setBodyTitle($title);
        $this->setPageTitle($title);
    }

    /**
     * Set both the title (header) and page title (body) at the same time
     * @param string $title

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

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

    /**
     * Set the response content
     *
     * @param string $content
     */
    public function setContent($content)
    {
        $this->getResponse()->setContent($content);

$content is of type string, but the function expects a object<erdiko\core\Container>.

    }

    /**
     * Add/append html text to the response content
     *
     * @param string @content
     */
    public function appendContent($content)
    {
        $this->getResponse()->appendContent($content);
    }

    /**
     *  Autoaction
     *
     * @param string $var
     * @param string $httpMethod
     */
    protected function _autoaction($var, $httpMethod = 'get')
    {
        $method = $this->urlToActionName($var, $httpMethod);
        if (method_exists($this, $method)) {
            return $this->$method();
        } else {
            ToroHook::fire('404', array(
                "error" => "Controller ".get_class($this)." does not contain $method action",
                "path_info" => $this->_pathInfo ));
        }
    }

    /**
     * Call back for preg_replace in urlToActionName
     */
    private function _replaceActionName($parts)
    {
        return strtoupper($parts[1]);
    }

    /**
     * Modify the action name coming from the URL into proper action name
     * @param string $name: The raw controller action name

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

     * @return string
     */
    public function urlToActionName($name, $httpMethod)
    {
        // convert to camelcase if there are dashes
        $function = preg_replace_callback("/\-(.)/", array($this, '_replaceActionName'), $name);

        return $httpMethod.ucfirst($function);
    }
    
    /**
     * Load a view with the given data
     *
     * @param string $viewName
     * @param array $data
     * @return string $html, view contents
     */
    public function getView($viewName, $data = null, $templateRootFolder = null)

This method seems to be duplicated in your project.

    {
        $view = new \erdiko\core\View($viewName, $data);

        if ($templateRootFolder != null) {
            $view->setTemplateRootFolder($templateRootFolder);
        }

        return $view;
    }

    /**
     * Add a view from the current theme with the given data
     *
     * @param mixed $view, can be a string (view name) or object (view object)

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

     * @param array $data
     * @return string $html, view contents
     */
    public function addView($view, $data = null)
    {
        if(!is_object($view))
            $view = new \erdiko\core\View($view, $data);
        if($data != null)
            $view->setData($data);
        
        $this->appendContent($view->toHtml());
    }

    /**
     * Load a layout with the given data
     *
     * @param string $layoutName
     * @param array $data
     * @return string $html, layout contents
     */
    public function getLayout($layoutName, $data = null, $templateRootFolder = null)
    {
        $layout = new \erdiko\core\Layout($layoutName, $data, $this->getThemeName());
        $layout->setTitle($this->getBodyTitle());

        if ($templateRootFolder != null) {
            $layout->setViewRootFolder($templateRootFolder);
            $layout->setTemplateRootFolder($templateRootFolder);
        }

        return  $layout->toHtml();
    }

    /**
     * Redirect to another url
     * @param string $url
     */
    public function redirect($url)
    {
        header("Location: $url");
        exit;

The method redirect() contains an exit expression.

    }

    /**
     * Add Meta tags to the page
     *
     * @param string $name, html meta name (e.g. 'description' or 'keywords')

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

     * @param string $content
     */
    public function addMeta($name, $content)
    {
        $this->getResponse()->getTheme()->addMeta($name, $content);
    }

    /**
     * Set multiple meta fields at once
     * @param array $meta
     */
    public function setMeta($meta)
    {
        foreach($meta as $name => $content)
            $this->getResponse()->getTheme()->addMeta($name, $content);
    }

    /**
     * Add Css includes to the page
     *
     * @param string $name
     * @param string $file
     * @param int $order
     * @param int $active
     */
    public function addCss($name, $file, $order = 10, $active = 1)
    {
       $this->getResponse()
            ->getTheme()
            ->addCss($name, $file, $order,$active);
    }

    /**
     * Add Css includes to the page
     *
     * @param string $name
     * @param string $file
     * @param int $order
     * @param int $active
     */
    public function addJs($name, $file, $order = 10, $active = 1)
    {
        $this->getResponse()
            ->getTheme()
            ->addJs($name, $file, $order,$active);
    }
    
    /**
     * Magic method experiments
     */
      
    /**
     * Get a value
     */
    public function __get($key)
    {
        return $this->getResponseKeyValue($key);
    }
  
    /**
     * Set a value
     */
    public function __set($key, $value)
    {
        return $this->setResponseKeyValue($key, $value);
    }


    /**
     *
     *
     * Code below is deprecated, do not use
     * @todo Should be deleted, refactored or moved!
     *
     *
     */


    /**
     * Add phpToJs variable to be set on the current page
     *
     * @param mixed $key
     * @param mixed $value
     */
    public function addPhpToJs($key, $value)
    {
        if (is_bool($value)) {
            $value = $value ? "true" : "false";
        } elseif (is_string($value)) {
            $value = "\"$value\"";
        } elseif (is_array($value)) {
            $value = json_encode($value);
        } elseif (is_object($value) && method_exists($value, "toArray")) {
            $value = json_encode($value->toArray());
        } else {
            throw new \Exception("Can not translate a parameter from PHP to JS\n".print_r($value, true));
        }

        $this->_themeExtras['phpToJs'][$key] = $value;

The property _themeExtras does not exist on object<erdiko\core\Controller>. Since you implemented __get, maybe consider adding a @property annotation.

    }
}