RequestHandlerResolver.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010 Jochen Rau <jochen.rau@typoplanet.de>
 *  All rights reserved
 *
 *  This class is a backport of the corresponding class of FLOW3.
 *  All credits go to the v5 team.
 *
 *  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 2 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!
 ***************************************************************/

/**
 * Analyzes the raw request and delivers a request handler which can handle it.
 */
class Tx_Extbase_MVC_RequestHandlerResolver {

    /**
     * @var Tx_Extbase_Object_ObjectManagerInterface
     */
    protected $objectManager;

    /**
     * @var Tx_Extbase_Reflection_ReflectionService
     */
    protected $reflectionService;

    /**
     * @var Tx_Extbase_Configuration_ConfigurationManagerInterface
     */
    protected $configurationManager;

    /**
     * Injects the object manager
     *
     * @param Tx_Extbase_Object_ObjectManagerInterface $objectManager A reference to the object manager
     * @return void
     */
    public function injectObjectManager(Tx_Extbase_Object_ObjectManagerInterface $objectManager) {
        $this->objectManager = $objectManager;
    }

    /**
     * Injects the reflection service
     *
     * @param Tx_Extbase_Reflection_Service $reflectionService
     * @return void
     */
    public function injectReflectionService(Tx_Extbase_Reflection_Service $reflectionService) {
        $this->reflectionService = $reflectionService;
    }

    /**
     * Injects the configuration manager
     *
     * @param Tx_Extbase_Configuration_ConfigurationManagerInterface $configurationManager
     * @return void
     */
    public function injectConfigurationManager(Tx_Extbase_Configuration_ConfigurationManagerInterface $configurationManager) {
        $this->configurationManager = $configurationManager;
    }

    /**
     * Analyzes the raw request and tries to find a request handler which can handle
     * it. If none is found, an exception is thrown.
     *
     * @return Tx_Extbase_MVC_RequestHandler A request handler
     * @throws Tx_Extbase_MVC_Exception
     */
    public function resolveRequestHandler() {
        $availableRequestHandlerClassNames = $this->getRegisteredRequestHandlerClassNames();

        $suitableRequestHandlers = array();
        foreach ($availableRequestHandlerClassNames as $requestHandlerClassName) {
            $requestHandler = $this->objectManager->get($requestHandlerClassName);
            if ($requestHandler->canHandleRequest()) {
                $priority = $requestHandler->getPriority();
                if (isset($suitableRequestHandlers[$priority])) throw new Tx_Extbase_MVC_Exception('More than one request handler with the same priority can handle the request, but only one handler may be active at a time!', 1176475350);
                $suitableRequestHandlers[$priority] = $requestHandler;
            }
        }
        if (count($suitableRequestHandlers) === 0) throw new Tx_Extbase_MVC_Exception('No suitable request handler found.', 1205414233);
        ksort($suitableRequestHandlers);
        return array_pop($suitableRequestHandlers);
    }

    /**
     * Returns a list of all registered request handlers.
     *
     * @return array
     */
    public function getRegisteredRequestHandlerClassNames() {
        $settings = $this->configurationManager->getConfiguration(Tx_Extbase_Configuration_ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
        return is_array($settings['mvc']['requestHandlers']) ? $settings['mvc']['requestHandlers'] : array();
    }
}
?>