Romm\Formz\Middleware\Items\AbstractMiddleware

Complexity

Total Complexity

15

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	initialize()	0	6	1
A	initializeMiddleware()	0	3	1
A	stopPropagation()	0	4	1
A	forward()	0	11	1
A	redirect()	0	19	1
A	getFormObject()	0	4	1
A	getResult()	0	4	1
A	getRequest()	0	4	1
A	getArguments()	0	4	1
A	getSettings()	0	4	1
A	getPriority()	0	4	1
A	getBoundSignalName()	0	12	3

<?php
/*
 * 2017 Romain CANON <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 FormZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\Formz\Middleware\Items;

use Romm\Formz\Error\FormResult;
use Romm\Formz\Exceptions\EntryNotFoundException;
use Romm\Formz\Form\FormObject;
use Romm\Formz\Middleware\Exception\RedirectException;
use Romm\Formz\Middleware\Exception\StopPropagationException;
use Romm\Formz\Middleware\MiddlewareInterface;
use Romm\Formz\Middleware\Signal\MiddlewareSignal;
use Romm\Formz\Middleware\State\StateMiddlewareDependencyTrait;
use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
use TYPO3\CMS\Extbase\Mvc\Web\Request;

abstract class AbstractMiddleware implements MiddlewareInterface
{
    use StateMiddlewareDependencyTrait;

    /**
     * @param array $options
     */
    public function __construct(array $options = [])
    {
    }

    /**
     * @todo
     */
    final public function initialize()
    {
        // @todo add options handling

        $this->initializeMiddleware();
    }

    /**
     * @todo
     */
    protected function initializeMiddleware()
    {
    }

    /**
     * @todo
     */
    final protected function stopPropagation()
    {
        throw new StopPropagationException;
    }

    /**
     * @todo
     *
     * @param string $actionName
     * @param string $controllerName
     * @param string $extensionName
     * @param array  $arguments
     */
    final protected function forward($actionName, $controllerName = null, $extensionName = null, array $arguments = [])
    {
        $request = $this->getRequest();

        $request->setControllerActionName($actionName);
        $request->setControllerName($controllerName);
        $request->setControllerExtensionName($extensionName);
        $request->setArguments($arguments);

        $this->stopPropagation();
    }

    /**
     * @todo
     *
     * @param string $actionName
     * @param string $controllerName
     * @param string $extensionName
     * @param array  $arguments
     * @param string $pageUid
     * @param int    $delay
     * @param int    $statusCode
     * @throws RedirectException
     */
    final protected function redirect(
        $actionName,
        $controllerName = null,
        $extensionName = null,
        array $arguments = null,
        $pageUid = null,
        $delay = 0,
        $statusCode = 303
    ) {
        throw new RedirectException(
            $actionName,
            $controllerName,
            $extensionName,
            $arguments,
            $pageUid,
            $delay,
            $statusCode
        );
    }

    /**
     * @return FormObject
     */
    final protected function getFormObject()
    {
        return $this->state->getFormObject();
    }

    /**
     * @return FormResult
     */
    final protected function getResult()
    {
        return $this->state->getResult();
    }

    /**
     * @return Request
     */
    final protected function getRequest()
    {
        return $this->state->getRequest();
    }

    /**
     * @return Arguments
     */
    final protected function getArguments()
    {
        return $this->state->getArguments();
    }

    /**
     * @return array
     */
    final protected function getSettings()
    {
        return $this->state->getSettings();
    }

    /**
     * @return int
     */
    public function getPriority()
    {
        return 0;
    }

    /**
     * Returns the name of the signal on which this middleware is bound.
     *
     * @return string
     * @throws EntryNotFoundException
     */
    final public function getBoundSignalName()
    {
        $interfaces = class_implements($this);

        foreach ($interfaces as $interface) {
            if (in_array(MiddlewareSignal::class, class_implements($interface))) {
                return $interface;
            }
        }

        throw new EntryNotFoundException('@todo'); // @todo
    }
}