Romm\Formz\Middleware\Items\InjectForm\InjectFormMiddleware

Complexity

Total Complexity

4

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getPriority()	0	4	1
B	process()	0	33	2
A	getAllowedSignals()	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\Items\InjectForm;

use Romm\Formz\Core\Core;
use Romm\Formz\Middleware\Items\OnBeginMiddleware;
use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;

/**
 * This middleware takes care of creating new form instances, based on the
 * arguments of the current request.
 *
 * It is based on the controller action of the current context: each argument
 * that is not found in the request, and has a form type (class that implements
 * `FormInterface`) gets injected with an empty form instance.
 *
 * The goal is to provide a form instance to the controller in every case, so
 * the developer can manipulate it easily, for instance by pre-setting values.
 */
class InjectFormMiddleware extends OnBeginMiddleware implements SendsMiddlewareSignal
{
    /**
     * @see InjectFormMiddleware
     */
    protected function process()
    {
        $this->beforeSignal()->dispatch();

        $formClassName = $this->getFormObject()->getClassName();
        $formName = $this->getFormObject()->getName();

        if (false === $this->getRequest()->hasArgument($formName)) {
            /*
             * Creating an empty instance of the form.
             */
            $form = Core::get()->getObjectManager()->getEmptyObject($formClassName);

            /*
             * The request argument with the name of the form is filled with the
             * new form instance.
             */
            $this->getRequest()->setArgument($formName, $form);

            /*
             * The form instance is injected in the form object, for further
             * usage.
             */
            $this->getFormObject()->setForm($form);

            /*
             * The after-signal should be dispatched only if the form was
             * actually injected in the request, otherwise the other middlewares
             * should not be called.
             */
            $this->afterSignal()->dispatch();
        }
    }

    /**
     * @return int
     */
    public function getPriority()
    {
        return self::PRIORITY_INJECT_FORM;
    }

    /**
     * @return array
     */
    public function getAllowedSignals()
    {
        return [InjectFormSignal::class];
    }
}