Aoe\Restler\System\Restler\AbstractExceptionHandler

Complexity

Total Complexity

80

Size/Duplication

Total Lines	382
Duplicated Lines	0 %

Test Coverage

Coverage

94.34%

Importance

Changes	1
Bugs	0	Features	1

78 Methods

Rating	Name	Duplication	Size	Complexity
A	handle906()	0	3	1
A	handle449()	0	3	1
A	__construct()	0	3	1
A	handle904()	0	3	1
A	handle901()	0	3	1
A	handle409()	0	3	1
A	handle429()	0	3	1
A	handle202()	0	3	1
A	handle428()	0	3	1
A	handle201()	0	3	1
A	handle405()	0	3	1
A	handle431()	0	3	1
A	handle509()	0	3	1
A	handle401()	0	3	1
A	handle410()	0	3	1
A	handle503()	0	3	1
A	handle414()	0	3	1
A	handle504()	0	3	1
A	handle413()	0	3	1
A	handle408()	0	3	1
A	handle507()	0	3	1
A	handle207()	0	3	1
A	handle430()	0	3	1
A	handle308()	0	3	1
A	handle100()	0	3	1
A	handle421()	0	3	1
A	handle305()	0	3	1
A	handle423()	0	3	1
A	handle205()	0	3	1
A	handle400()	0	3	1
A	handle406()	0	3	1
A	handle304()	0	3	1
A	handle303()	0	3	1
A	handle950()	0	3	1
A	handle416()	0	3	1
A	handle102()	0	3	1
A	handle905()	0	3	1
A	handle420()	0	3	1
A	handle203()	0	3	1
A	handle302()	0	3	1
A	handle451()	0	3	1
A	handle902()	0	3	1
A	handle508()	0	3	1
A	handle417()	0	3	1
A	handle206()	0	3	1
A	handle425()	0	3	1
A	handle501()	0	3	1
A	handle424()	0	3	1
A	handle510()	0	3	1
A	handle412()	0	3	1
A	handle903()	0	3	1
A	handle101()	0	3	1
A	handle418()	0	3	1
A	handle226()	0	3	1
A	handle301()	0	3	1
A	handle506()	0	3	1
A	handle505()	0	3	1
A	handle502()	0	3	1
A	handle402()	0	3	1
A	handle204()	0	3	1
A	handle208()	0	3	1
A	handle403()	0	3	1
A	handle404()	0	3	1
A	handle900()	0	3	1
A	handle300()	0	3	1
A	handle407()	0	3	1
A	handle415()	0	3	1
A	handle500()	0	3	1
A	handle426()	0	3	1
A	handle306()	0	3	1
A	handle444()	0	3	1
A	handle907()	0	3	1
A	getRestler()	0	3	1
A	handle200()	0	3	1
A	handle411()	0	3	1
A	handle307()	0	3	1
A	handle422()	0	3	1
A	getRestlerException()	0	6	3

<?php
namespace Aoe\Restler\System\Restler;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2015 AOE GmbH <dev@aoe.com>
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use Aoe\Restler\Configuration\ExtensionConfiguration;
use Luracast\Restler\RestException;
use Luracast\Restler\Restler;
use Luracast\Restler\Scope;

/**
 * This abstract class can be used to call ONE central method,
 * which handles ALL exceptions (the current HTTP-Status-Code doesn't matter)!
 *
 * @package Restler
 */
abstract class AbstractExceptionHandler
{
    /**
     * This object can be used, to check the Extension-Configuration (maybe we want to
     * handle an exception in different ways - based on the Extension-Configuration)
     *
     * @var ExtensionConfiguration
     */
    protected $extensionConfiguration;

    /**
     * @param ExtensionConfiguration $extensionConfiguration
     */
    public function __construct(ExtensionConfiguration $extensionConfiguration)
    {
        $this->extensionConfiguration = $extensionConfiguration;
    }


    /**
     * handle HTTP-Status-Codes of type 1xx
     */
    public function handle100()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle101()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle102()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }


    /**
     * handle HTTP-Status-Codes of type 2xx
     */
    public function handle200()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle201()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle202()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle203()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle204()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle205()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle206()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle207()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle208()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle226()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }


    /**
     * handle HTTP-Status-Codes of type 3xx
     */
    public function handle300()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle301()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle302()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle303()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle304()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle305()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle306()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle307()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle308()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }


    /**
     * handle HTTP-Status-Codes of type 4xx
     */
    public function handle400()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle401()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle402()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle403()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle404()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle405()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle406()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle407()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle408()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle409()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle410()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle411()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle412()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle413()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle414()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle415()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle416()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle417()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle418()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle420()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle421()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle422()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle423()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle424()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle425()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle426()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle428()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle429()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle430()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle431()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle444()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle449()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle451()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }

    /**
     * handle HTTP-Status-Codes of type 5xx
     */
    public function handle500()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle501()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle502()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle503()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle504()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle505()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle506()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle507()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle508()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle509()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle510()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }


    /**
     * handle HTTP-Status-Codes of type 9xx
     */
    public function handle900()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle901()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle902()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle903()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle904()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle905()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle906()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle907()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }
    public function handle950()
    {
        return $this->handleException($this->getRestlerException(func_get_args()), $this->getRestler());
    }

    /**
     * This is the right place, where we can handle exceptions, which were thrown in REST-API's!
     *
     * The return value (boolean) describes, if restler should display an error as output:
     * TRUE means:  restler should NOT display an error as output (so, we must do that)
     * FALSE means: restler should dislay an error as output
     *
     * @param RestException $exception
     * @param Restler $restler
     * @return boolean
     */
    abstract protected function handleException(RestException $exception, Restler $restler);

    /**
     * This method must be protected - otherwise we can't test this class in unittests
     *
     * @return Restler
     */
    protected function getRestler()
    {
        return Scope::get('Restler');
    }

    /**
     * This method must be protected - otherwise we can't test this class in unittests
     *
     * @param array $exceptionHandlerArgs
     * @return RestException
     */
    protected function getRestlerException(array $exceptionHandlerArgs = [])
    {
        if (count($exceptionHandlerArgs) > 0 && $exceptionHandlerArgs[0] instanceof RestException) {
            return $exceptionHandlerArgs[0];
        }
        return $this->getRestler()->exception;
    }
}