Jaxon\Request\Handler\RequestHandler

Complexity

Total Complexity

18

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	_processRequest()	0	19	5
A	__construct()	0	8	1
B	processRequest()	0	45	7
A	canProcessRequest()	0	33	5

<?php

/**
 * RequestHandler.php - Jaxon RequestPlugin Handler
 *
 * This class processes an incoming jaxon request.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Jared White

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author J. Max Wilson

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Joseph Woolley

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Steffen Konerow

Content of the @author tag must be in the form "Display Name <username@example.com>"

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White  & J. Max Wilson

@copyright tag must contain a year and the name of the copyright holder

 * @copyright 2016 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Request\Handler;

use Jaxon\Di\Container;
use Jaxon\Exception\RequestException;
use Jaxon\Plugin\Manager\PluginManager;
use Jaxon\Plugin\RequestHandlerInterface;
use Jaxon\Plugin\Response\DataBag\DataBagPlugin;
use Jaxon\Request\Upload\UploadHandlerInterface;
use Jaxon\Response\Manager\ResponseManager;

use Exception;

class RequestHandler

Missing doc comment for class RequestHandler

{
    /**
     * @var Container
     */
    private $di;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * The plugin manager.
     *
     * @var PluginManager
     */
    private $xPluginManager;

    /**
     * The response manager.
     *
     * @var ResponseManager
     */
    private $xResponseManager;

    /**
     * The callbacks to run while processing the request
     *
     * @var CallbackManager
     */
    private $xCallbackManager;

    /**
     * @var UploadHandlerInterface
     */
    private $xUploadHandler;

    /**
     * The data bag response plugin
     *
     * @var DataBagPlugin
     */
    private $xDataBagPlugin;

    /**
     * The request plugin that is able to process the current request
     *
     * @var RequestHandlerInterface
     */
    private $xRequestPlugin = null;

    /**
     * The constructor
     *
     * @param Container $di

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param PluginManager $xPluginManager

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param ResponseManager $xResponseManager

Missing parameter comment

     * @param CallbackManager $xCallbackManager

Missing parameter comment

     * @param DataBagPlugin $xDataBagPlugin

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     */
    public function __construct(Container $di, PluginManager $xPluginManager, ResponseManager $xResponseManager,

Expected 2 blank lines before function; 1 found

        CallbackManager $xCallbackManager, DataBagPlugin $xDataBagPlugin)
    {
        $this->di = $di;

Equals sign not aligned with surrounding assignments; expected 15 spaces but found 1 space

        $this->xPluginManager = $xPluginManager;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $this->xResponseManager = $xResponseManager;
        $this->xCallbackManager = $xCallbackManager;
        $this->xDataBagPlugin = $xDataBagPlugin;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

    }

Expected 2 blank lines after function; 1 found

    /**
     * Check if the current request can be processed
     *
     * Calls each of the request plugins and determines if the current request can be processed by one of them.
     *
     * @return bool
     */
    public function canProcessRequest(): bool
    {
        $this->xUploadHandler = $this->di->getUploadHandler();

        // Return true if the request plugin was already found
        if($this->xRequestPlugin !== null)
        {
            return true;
        }

        // The HTTP request
        $xRequest = $this->di->getRequest();
        // Find a plugin to process the request
        foreach($this->xPluginManager->getRequestHandlers() as $sClassName)
        {
            if($sClassName::canProcessRequest($xRequest))
            {
                $this->xRequestPlugin = $this->di->g($sClassName);
                $this->xRequestPlugin->setTarget($xRequest);
                return true;
            }
        }

        // Check if the upload plugin is enabled
        if($this->xUploadHandler === null)
        {
            return false;
        }

        // If no other plugin than the upload plugin can process the request,
        // then it is an HTTP (not ajax) upload request
        $this->xUploadHandler->isHttpUpload();
        return $this->xUploadHandler->canProcessRequest($xRequest);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Process the current request and handle errors and exceptions.
     *
     * @return void
     * @throws RequestException
     */
    private function _processRequest()
    {
        // The HTTP request
        $xRequest = $this->di->getRequest();
        // Process uploaded files, if the upload plugin is enabled
        if($this->xUploadHandler !== null && $this->xUploadHandler->canProcessRequest($xRequest))
        {
            $this->xUploadHandler->processRequest($xRequest);
        }
        // Process the request
        if(($this->xRequestPlugin))
        {
            $xResponse = $this->xRequestPlugin->processRequest();
            if(($xResponse))
            {
                $this->xResponseManager->append($xResponse);
            }
            // Process the databag
            $this->xDataBagPlugin->writeCommand();
        }
    }

Expected 2 blank lines after function; 1 found

    /**
     * Process the current request.
     *
     * Calls each of the request plugins to request that they process the current request.
     * If any plugin processes the request, it will return true.
     *
     * @return void
     * @throws RequestException
     */
    public function processRequest()
    {
        // Check if there is a plugin to process this request
        if(!$this->canProcessRequest())
        {
            return;
        }

        try
        {
            $bEndRequest = false;
            // Handle before processing event
            if(($this->xRequestPlugin))
            {
                $this->xCallbackManager->onBefore($this->xRequestPlugin->getTarget(), $bEndRequest);
            }
            if($bEndRequest)
            {
                return;
            }

            $this->_processRequest();

            // Handle after processing event
            if(($this->xRequestPlugin))
            {
                $this->xCallbackManager->onAfter($this->xRequestPlugin->getTarget(), $bEndRequest);
            }
        }
        // An exception was thrown while processing the request.
        // The request missed the corresponding handler function,
        // or an error occurred while attempting to execute the handler.
        catch(RequestException $e)
        {
            $this->xResponseManager->error($e->getMessage());
            $this->xCallbackManager->onInvalid($e);
        }
        catch(Exception $e)
        {
            $this->xResponseManager->error($e->getMessage());
            $this->xCallbackManager->onError($e);
        }

        // Print the debug messages
        $this->xResponseManager->printDebug();
    }

Expected 2 blank lines after function; 0 found

}