csphere\core\router\Controller

Complexity

Total Complexity

19

Size/Duplication

Total Lines	212
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	3
B	execute()	0	32	4
B	target()	0	29	3
B	_search()	0	24	2
B	parseRequestAction()	0	52	7

<?php

/**
 * Find and execute the best solution for a request
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Router
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\router;

/**
 * Class controller knows best what to do with the request
 *
 * @category  Core
 * @package   Router
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

class Controller
{
    /**
     * Store plugin with target to use
     **/
    private $_target = '';

    /**
     * Store if the target is a box
     **/
    private $_box = false;

    /**
     * Store if the request expects a json object
     **/
    private $_xhr = false;

    /**
     * Creates a new router for executing a destination
     *
     * @param boolean $search Set this to true to auto discover the target
     *
     * @return \csphere\core\router\Controller
     **/

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

There must be no blank lines after the function comment

    public function __construct($search = false)
    {
        // Check for xhr mode that needs a json object
        $xhr = \csphere\core\http\Input::get('get', 'xhr');

        if ($xhr == 1) {

            $this->_xhr = true;
        }

        // Check if search is enabled
        if ($search == true) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $this->_search();
        }
    }

    /**
     * Execute the target plugin target
     *
     * @param boolean $skip Whether to skip target execution
     *
     * @return void
     **/

There must be no blank lines after the function comment

    public function execute($skip = false)
    {
        // Check if response was already send
        $status = \csphere\core\http\Response::status();

        if ($status === false) {

            // If skip is true the view was already filled with content
            if ($skip === false) {

                \csphere\core\router\Sandbox::light($this->_target);
            }

            // Get content from view
            $loader  = \csphere\core\service\Locator::get();
            $view    = $loader->load('view');
            $content = $view->assemble($this->_xhr, $this->_box);

            // Tell response whether to use compression
            $zlib = false;

            if ($skip == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

                $zlib = (boolean)$view->getOption('zlib');
            }

            \csphere\core\http\Response::compression($zlib);

            // Send content to response
            \csphere\core\http\Response::send($content);
        }
    }

    /**
     * Gets a target action or box of a plugin
     *
     * @param string $plugin Plugin name
     * @param string $action Action name
     *
     * @return string
     **/

There must be no blank lines after the function comment

    public function target($plugin, $action)
    {
        $checks = new \csphere\core\plugins\Checks($plugin);
        $checks->setRoute($action);

        // Keep initial action while allowing changes to it
        $new_action = $action;

        // Fallback if action does not exist
        if ($checks->existance() == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $new_action = 'dispatch';
            $checks->setRoute($new_action);

            // Reset fallback if no plugin dispatcher was found
            if ($checks->existance() == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

                $new_action = $action;
                $checks->setRoute($new_action);
            }
        }

        // Inform template engine about the target
        \csphere\core\template\Hooks::route($plugin, $new_action);

        $target = $checks->result();

        return $target;
    }

    /**
     * Gets a target action or box of a plugin
     *
     * @return string
     **/

There must be no blank lines after the function comment

    private function _search()
    {

        $request=self::parseRequestAction();

        $plugin=$request['plugin'];
        $action=$request['action'];
        $box=$request['box'];

        // Fetch defaults if no plugin is given
        if (!empty($box)) {

            $this->_box = true;

            // Special case for box requests
            $checks = new \csphere\core\plugins\Checks($plugin);
            $checks->setRoute($box, true);

The call to Checks::setRoute() has too many arguments starting with true.

            $this->_target = $checks->result();

        } else {

            $this->_target = $this->target($plugin, $action);
        }
    }

    /**
     * Get the current requested plugin, action and box
     *
     * @return array
     */

There must be no blank lines after the function comment

    public static function parseRequestAction()
    {
        $box    = \csphere\core\http\Input::get('get', 'box');
        $plugin = \csphere\core\http\Input::get('get', 'plugin');
        $action = \csphere\core\http\Input::get('get', 'action');

        $request=[
            'plugin'=>'',
            'action'=>'',
            'box'=>''
        ];

        // Read config file
        $conf   = new \csphere\core\init\Config();
        $config = $conf->get();

        // Check for favicon requests
        if ($plugin == 'favicon.ico') {
            $plugin = '';
        }

        if (empty($config['default']['action'])) {
            $config['default']['action']="list";
        }
        
        if (empty($plugin)) {

            if (empty($config['default']['plugin'])) {
                $config['default']['plugin']="default";
            }

            $request['plugin']=$config['default']['plugin'];

            $request['action']=$config['default']['action'];


        } elseif (!empty($box)) {
            $request['plugin']=$plugin;
            $request['box']=$box;
        } else {

            $request['plugin']=$plugin;

            if (empty($action)) {
                $request['action']=$config['default']['action'];
            } else {
                $request['action']=$action;
            }
        }

        return $request;
    }
}