MaglLegacyApplication\Controller\LegacyController

Complexity

Total Complexity

23

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

75.38%

Importance

Changes	22
Bugs	6	Features	3

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
D	setGetVariables()	0	37	10
D	indexAction()	0	44	9
A	runScript()	0	19	3

<?php

/**
 * @author Matthias Glaub <magl@magl.net>
 * @license http://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
 */

namespace MaglLegacyApplication\Controller;

use MaglLegacyApplication\Application\MaglLegacy;
use MaglLegacyApplication\Options\LegacyControllerOptions;
use Zend\Http\Response;
use Zend\Mvc\Controller\AbstractActionController;

class LegacyController extends AbstractActionController
{

    /**
     *
     * @var LegacyControllerOptions
     */
    private $options;

    /**
     *
     * @var MaglLegacy
     */
    private $legacy;

    public function __construct(LegacyControllerOptions $options, MaglLegacy $legacy)
    {
        $this->options = $options;
        $this->legacy = $legacy;
    }

    public function indexAction()
    {
        $docRoots = $this->options->getDocRoots();
        foreach($docRoots as $key => $docRoot) {

Expected 1 space after FOREACH keyword; 0 found

            $docRoots[$key] = rtrim(getcwd() . '/' . $docRoot);
        }

        $scriptName = $this->params('script');

        if (empty($scriptName)) {
            $path = $this->params(('path')) ? $this->params('path') : '';
            foreach ($this->options->getIndexFiles() as $indexFile) {
                foreach($docRoots as $docRoot) {

Expected 1 space after FOREACH keyword; 0 found

                    if (is_file($docRoot . '/' . $path . $indexFile)) {
                        $this->legacy->setLegacyScriptName($path . $indexFile);
                        return $this->runScript($docRoot . '/' . $path . $indexFile);
                    }
                }
            }
        }


        $scriptUri = '/' . ltrim($scriptName, '/'); // force leading '/'
        foreach($docRoots as $docRoot) {

Expected 1 space after FOREACH keyword; 0 found

            $legacyScriptFilename = $docRoot . $scriptUri;
            if(is_file($legacyScriptFilename)) {

Expected 1 space after IF keyword; 0 found

                //inform the application about the used script
                $this->legacy->setLegacyScriptName($scriptUri);

                //inject get and request variables
                $this->setGetVariables();

                return $this->runScript($legacyScriptFilename);
            }
        }

        // if we're here, the file doesn't really exist and we do not know what to do
        $response = $this->getResponse();

        /* @var $response Response */ //<-- this one for netbeans (WHY, NetBeans, WHY??)
        /** @var Response $response */ // <-- this one for other IDEs and code analyzers :)
        $response->setStatusCode(404);
        return $response;

The return type of return $response; (Zend\Stdlib\ResponseInterface) is incompatible with the return type of the parent method Zend\Mvc\Controller\AbstractActionController::indexAction of type Zend\View\Model\ViewModel.

    }

    private function setGetVariables()
    {
        $globals_options = $this->options->getGlobals();

        // if we should not set any global vars, we can return safely
        if (!$globals_options['get'] && !$globals_options['request']) {
            return;
        }

        // check if $_GET is used at all (ini - variables_order ?)
        // check if $_GET is written to $_REQUEST (ini - variables_order / request_order)
        // depending on request_order, check if $_REQUEST is already written and decide if we are allowed to override

        $request_order = ini_get('request_order');

        if ($request_order === false) {
            $request_order = ini_get('variables_order');
        }

        $get_prio = stripos($request_order, 'g');
        $post_prio = stripos($request_order, 'p');

        $forceOverrideRequest = $get_prio > $post_prio;

        $routeParams = $this->getEvent()->getRouteMatch()->getParams();

        foreach ($routeParams as $paramName => $paramValue) {

Blank line found at start of control structure

            if ($globals_options['get'] && !isset($_GET[$paramName])) {
                $_GET[$paramName] = $paramValue;
            }

            if ($globals_options['request'] && ($forceOverrideRequest || !isset($_REQUEST[$paramName]))) {
                $_REQUEST[$paramName] = $paramValue;
            }
        }
    }

    private function runScript($scriptFileName)
    {
        $this->legacy->setLegacyScriptFilename($scriptFileName);

        ob_start();
        include $scriptFileName;
        $output = ob_get_clean();

        $result = $this->getEventManager()->trigger(MaglLegacy::EVENT_SHORT_CIRCUIT_RESPONSE, $this);
        if ($result->stopped()) {
            if($this->options->getPrependOutputBufferToResponse()) {

Expected 1 space after IF keyword; 0 found

                $result->last()->setContent($output . $result->last()->getContent());
            }
            return $result->last();
        }

        $this->getResponse()->setContent($output);
        return $this->getResponse();
    }
}