Romm\Formz\Middleware\State\MiddlewareState

Complexity

Total Complexity

25

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	7

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getRequest()	0	4	1
A	run()	0	10	1
A	__construct()	0	10	2
A	getMiddlewaresBoundToSignal()	0	8	2
B	getSignalSortedMiddlewares()	0	23	5
A	getFilteredMiddlewares()	0	14	4
A	sortMiddlewaresListByPriority()	0	15	3
A	getFormObject()	0	4	1
A	getResult()	0	8	2
A	getRequestArguments()	0	4	1
A	getSettings()	0	4	1
A	inSingleFieldValidationContext()	0	4	1
A	activateSingleFieldValidationContext()	0	4	1

<?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\State;

use Romm\Formz\Controller\ControllerState;
use Romm\Formz\Error\FormResult;
use Romm\Formz\Form\FormObject;
use Romm\Formz\Middleware\Item\Begin\BeginMiddleware;
use Romm\Formz\Middleware\Item\End\EndMiddleware;
use Romm\Formz\Middleware\MiddlewareInterface;
use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
use TYPO3\CMS\Extbase\Mvc\Web\Request;

/**
 * @todo: loop on middlewares and detect which ones are using signals that wont
 * be processed. This should probably be a validator put on:
 *      \Romm\Formz\Configuration\Form\Form::$middlewares
 */
class MiddlewareState
{
    /**
     * @var MiddlewareInterface[]
     */
    protected $list = [];

    /**
     * @var FormObject
     */
    protected $formObject;

    /**
     * @var ControllerState
     */
    protected $controllerState;

    /**
     * @var FormResult
     */
    protected $result;

    /**
     * @see getSignalSortedMiddlewares()
     *
     * @var array
     */
    protected $signalSortedMiddlewares = [];

    /**
     * This context is activated when the request is validating a single field
     * and not the whole form. In this case, special behaviours may occur, and
     * the state instance should be aware of it.
     *
     * @see \Romm\Formz\Middleware\State\RemoveFromSingleFieldValidationContext
     *
     * @var bool
     */
    protected $singleFieldValidationContext = false;

    /**
     * @param FormObject      $formObject
     * @param ControllerState $controllerState
     */
    public function __construct(FormObject $formObject, ControllerState $controllerState)
    {
        $this->formObject = $formObject;
        $this->controllerState = $controllerState;

        foreach ($this->formObject->getConfiguration()->getMiddlewares() as $middleware) {
            $middleware->bindMiddlewareState($this);
            $middleware->initialize();
        }
    }

    /**
     * Will run and process trough every middleware registered for the current
     * form object.
     */
    public function run()
    {
        $beginMiddleware = new BeginMiddleware;
        $beginMiddleware->bindMiddlewareState($this);
        $beginMiddleware->execute();

        $endMiddleware = new EndMiddleware;
        $endMiddleware->bindMiddlewareState($this);
        $endMiddleware->execute();
    }

    /**
     * Returns the sorted list of middlewares bound to the given signal name.
     *
     * @param string $signalName
     * @return array
     */
    public function getMiddlewaresBoundToSignal($signalName)
    {
        $signalSortedMiddlewares = $this->getSignalSortedMiddlewares();

        return (isset($signalSortedMiddlewares[$signalName]))
            ? $signalSortedMiddlewares[$signalName]
            : [];
    }

    /**
     * Returns a sorted list of the registered middlewares: the first level is
     * the signal used by the group, and the second level is the group of
     * middlewares, sorted by descendant priority of each middleware.
     *
     * @return array
     */
    protected function getSignalSortedMiddlewares()
    {
        if (empty($this->signalSortedMiddlewares)) {
            $this->signalSortedMiddlewares = [];
            $middlewareList = [];

            foreach ($this->getFilteredMiddlewares() as $middleware) {
                $signal = $middleware->getBoundSignalName();

                if (false === isset($middlewareList[$signal])) {
                    $middlewareList[$signal] = [];
                }

                $middlewareList[$signal][] = $middleware;
            }

            foreach ($middlewareList as $key => $list) {
                $this->signalSortedMiddlewares[$key] = $this->sortMiddlewaresListByPriority($list);
            }
        }

        return $this->signalSortedMiddlewares;
    }

    /**
     * @return MiddlewareInterface[]
     */
    protected function getFilteredMiddlewares()
    {
        $middlewares = $this->formObject->getConfiguration()->getMiddlewares();

        if ($this->inSingleFieldValidationContext()) {
            foreach ($middlewares as $key => $middleware) {
                if ($middleware instanceof RemoveFromSingleFieldValidationContext) {
                    unset($middlewares[$key]);
                }
            }
        }

        return $middlewares;
    }

    /**
     * Will sort and return a middlewares list based on the priority of each
     * middleware. The middlewares with the highest priority will be placed at
     * the top of the list.
     *
     * @param array $list
     * @return array
     */
    private function sortMiddlewaresListByPriority(array $list)
    {
        usort($list, function (MiddlewareInterface $a, MiddlewareInterface $b) {
            $priorityA = (int)$a->getPriority();
            $priorityB = (int)$b->getPriority();

            if ($priorityA === $priorityB) {
                return 0;
            }

            return $priorityA < $priorityB ? 1 : -1;
        });

        return $list;
    }

    /**
     * @return FormObject
     */
    public function getFormObject()
    {
        return $this->formObject;
    }

    /**
     * @return FormResult
     */
    public function getResult()
    {
        if (null === $this->result) {
            $this->result = new FormResult;
        }

        return $this->result;
    }

    /**
     * @return Request
     */
    public function getRequest()
    {
        return $this->controllerState->getRequest();
    }

    /**
     * @return Arguments
     */
    public function getRequestArguments()
    {
        return $this->controllerState->getRequestArguments();
    }

    /**
     * @return array
     */
    public function getSettings()
    {
        return $this->controllerState->getSettings();
    }

    /**
     * @see $singleFieldValidationContext
     *
     * @return bool
     */
    public function inSingleFieldValidationContext()
    {
        return $this->singleFieldValidationContext;
    }

    /**
     * @see $singleFieldValidationContext
     */
    public function activateSingleFieldValidationContext()
    {
        $this->singleFieldValidationContext = true;
    }
}