[WIP] Middlewares

Classes/Domain/Middleware/Begin/BeginMiddleware.php

@@ -17,7 +17,7 @@
 use Romm\Formz\Form\FormObject\FormObjectFactory;
 use Romm\Formz\Middleware\Processor\MiddlewareProcessor;
 use Romm\Formz\Middleware\Signal\After;
-use Romm\Formz\Middleware\Signal\SignalObject;
+use Romm\Formz\Middleware\Signal\Element\SignalObject;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 final class BeginMiddleware

Classes/Domain/Middleware/Begin/BeginSignal.php

@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Domain\Middleware\Begin;
 
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
 
 interface BeginSignal extends MiddlewareSignalInterface
 {

Classes/Domain/Middleware/End/EndMiddleware.php

@@ -15,7 +15,7 @@
 
 use Romm\Formz\Middleware\Processor\MiddlewareProcessor;
 use Romm\Formz\Middleware\Signal\Before;
-use Romm\Formz\Middleware\Signal\SignalObject;
+use Romm\Formz\Middleware\Signal\Element\SignalObject;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 final class EndMiddleware

Classes/Domain/Middleware/End/EndSignal.php

@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Domain\Middleware\End;
 
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
 
 interface EndSignal extends MiddlewareSignalInterface
 {

Classes/Domain/Middleware/FieldValidation/FieldValidationSignal.php

@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Domain\Middleware\FieldValidation;
 
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
 
 interface FieldValidationSignal extends MiddlewareSignalInterface
 {

Classes/Domain/Middleware/FormInjection/FormInjectionMiddleware.php

@@ -14,10 +14,10 @@
 namespace Romm\Formz\Domain\Middleware\FormInjection;
 
 use Romm\Formz\Core\Core;
-use Romm\Formz\Middleware\Element\OnBeginMiddleware;
-use Romm\Formz\Middleware\Processor\PresetMiddlewareInterface;
+use Romm\Formz\Middleware\Application\OnBeginMiddleware;
+use Romm\Formz\Middleware\PresetMiddlewareInterface;
 use Romm\Formz\Middleware\Processor\RemoveFromSingleFieldValidationContext;
-use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
+use Romm\Formz\Middleware\Signal\SendsSignal;
 
 /**
  * This middleware takes care of creating new form instances, based on the
@@ -30,7 +30,7 @@
  * 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 FormInjectionMiddleware extends OnBeginMiddleware implements PresetMiddlewareInterface, SendsMiddlewareSignal, RemoveFromSingleFieldValidationContext
+class FormInjectionMiddleware extends OnBeginMiddleware implements PresetMiddlewareInterface, SendsSignal, RemoveFromSingleFieldValidationContext
 {
     /**
      * @var int

Classes/Domain/Middleware/FormInjection/FormInjectionSignal.php

@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Domain\Middleware\FormInjection;
 
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
 
 interface FormInjectionSignal extends MiddlewareSignalInterface
 {

Classes/Domain/Middleware/FormValidation/FormValidationMiddleware.php

@@ -17,10 +17,10 @@
 use Romm\Formz\Form\Definition\Field\Field;
 use Romm\Formz\Domain\Middleware\FieldValidation\FieldValidationArguments;
 use Romm\Formz\Domain\Middleware\FieldValidation\FieldValidationSignal;
-use Romm\Formz\Middleware\Element\OnBeginMiddleware;
-use Romm\Formz\Middleware\Processor\PresetMiddlewareInterface;
+use Romm\Formz\Middleware\Application\OnBeginMiddleware;
+use Romm\Formz\Middleware\PresetMiddlewareInterface;
 use Romm\Formz\Middleware\Processor\RemoveFromSingleFieldValidationContext;
-use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
+use Romm\Formz\Middleware\Signal\SendsSignal;
 use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
 
 /**
@@ -35,7 +35,7 @@
  *
  * @see \Romm\Formz\Middleware\Processor\RemoveFromSingleFieldValidationContext
  */
-class FormValidationMiddleware extends OnBeginMiddleware implements PresetMiddlewareInterface, SendsMiddlewareSignal, RemoveFromSingleFieldValidationContext
+class FormValidationMiddleware extends OnBeginMiddleware implements PresetMiddlewareInterface, SendsSignal, RemoveFromSingleFieldValidationContext
 {
     /**
      * @var \Romm\Formz\Domain\Middleware\FormValidation\FormValidationMiddlewareOption

Classes/Domain/Middleware/FormValidation/FormValidationSignal.php

@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Domain\Middleware\FormValidation;
 
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
 
 interface FormValidationSignal extends MiddlewareSignalInterface
 {

Classes/Exceptions/InvalidArgumentTypeException.php

@@ -16,7 +16,7 @@
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
 use Romm\Formz\Condition\Items\ConditionItemInterface;
 use Romm\Formz\Form\FormInterface;
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
+use Romm\Formz\Middleware\MiddlewareInterface;
 use Romm\Formz\Middleware\Option\OptionDefinitionInterface;
 use Romm\Formz\ViewHelpers\FieldViewHelper;
 use Romm\Formz\ViewHelpers\FormatMessageViewHelper;

Classes/Exceptions/InvalidArgumentValueException.php

@@ -14,7 +14,7 @@
 namespace Romm\Formz\Exceptions;
 
 use Romm\Formz\Form\FormInterface;
-use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
+use Romm\Formz\Middleware\Signal\SendsSignal;
 
 class InvalidArgumentValueException extends FormzException
 {
@@ -42,10 +42,10 @@ final public static function fieldViewHelperEmptyLayout()
     /**
      * @code 1490798201
      *
-     * @param SendsMiddlewareSignal $middleware
+     * @param SendsSignal $middleware
      * @return InvalidArgumentValueException
      */
-    final public static function signalNotAllowed(SendsMiddlewareSignal $middleware)
+    final public static function signalNotAllowed(SendsSignal $middleware)
     {
         /** @var self $exception */
         $exception = self::getNewExceptionInstance(

Classes/Exceptions/InvalidEntryException.php

@@ -13,8 +13,8 @@
 
 namespace Romm\Formz\Exceptions;
 
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
-use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
+use Romm\Formz\Middleware\MiddlewareInterface;
+use Romm\Formz\Middleware\Signal\SendsSignal;
 
 class InvalidEntryException extends FormzException
 {
@@ -51,7 +51,7 @@ final public static function middlewareNotSendingSignals(MiddlewareInterface $mi
         /** @var self $exception */
         $exception = self::getNewExceptionInstance(
             self::MIDDLEWARE_NOT_SENDING_SIGNALS,
-            [get_class($middleware), SendsMiddlewareSignal::class]
+            [get_class($middleware), SendsSignal::class]
         );
 
         return $exception;

Classes/Exceptions/MissingArgumentException.php

@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Exceptions;
 
-use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
+use Romm\Formz\Middleware\Signal\SendsSignal;
 
 class MissingArgumentException extends FormzException
 {
@@ -93,10 +93,10 @@ final public static function conditionConstructorArgumentMissing($conditionName,
     /**
      * @code 1490793826
      *
-     * @param SendsMiddlewareSignal $middleware
+     * @param SendsSignal $middleware
      * @return self
      */
-    final public static function signalNameArgumentMissing(SendsMiddlewareSignal $middleware)
+    final public static function signalNameArgumentMissing(SendsSignal $middleware)
     {
         /** @var self $exception */
         $exception = self::getNewExceptionInstance(

Classes/Exceptions/SignalNotFoundException.php

@@ -13,8 +13,8 @@
 
 namespace Romm\Formz\Exceptions;
 
-use Romm\Formz\Middleware\Element\AbstractMiddleware;
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Application\AbstractMiddleware;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
 
 class SignalNotFoundException extends FormzException
 {

Classes/Form/Definition/FormDefinition.php

@@ -29,7 +29,7 @@
 use Romm\Formz\Form\Definition\Middleware\PresetMiddlewares;
 use Romm\Formz\Form\Definition\Settings\FormSettings;
 use Romm\Formz\Middleware\MiddlewareFactory;
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
+use Romm\Formz\Middleware\MiddlewareInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 class FormDefinition extends AbstractFormDefinitionComponent implements ConfigurationObjectInterface, DataPreProcessorInterface
@@ -60,7 +60,7 @@ class FormDefinition extends AbstractFormDefinitionComponent implements Configur
     protected $presetMiddlewares;
 
     /**
-     * @var \Romm\Formz\Middleware\Element\MiddlewareInterface[]
+     * @var \Romm\Formz\Middleware\MiddlewareInterface[]
      * @mixedTypesResolver \Romm\Formz\Form\Definition\Middleware\MiddlewareResolver
      */
     protected $middlewares = [];

Classes/Form/Definition/Middleware/PresetMiddlewares.php

@@ -18,7 +18,7 @@
 use Romm\ConfigurationObject\Traits\ConfigurationObject\MagicMethodsTrait;
 use Romm\Formz\Domain\Middleware\FormInjection\FormInjectionMiddleware;
 use Romm\Formz\Domain\Middleware\FormValidation\FormValidationMiddleware;
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
+use Romm\Formz\Middleware\MiddlewareInterface;
 
 class PresetMiddlewares implements DataPreProcessorInterface
 {

Classes/Middleware/Element/AbstractMiddleware.php → Classes/Middleware/Application/AbstractMiddleware.php

@@ -11,7 +11,7 @@
  * http://www.gnu.org/licenses/gpl-3.0.html
  */
 
-namespace Romm\Formz\Middleware\Element;
+namespace Romm\Formz\Middleware\Application;
 
 use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessor;
 use Romm\ConfigurationObject\Service\Items\DataPreProcessor\DataPreProcessorInterface;
@@ -20,26 +20,27 @@
 use Romm\Formz\Exceptions\MissingArgumentException;
 use Romm\Formz\Exceptions\SignalNotFoundException;
 use Romm\Formz\Form\FormObject\FormObject;
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
+use Romm\Formz\Middleware\MiddlewareInterface;
 use Romm\Formz\Middleware\MiddlewareFactory;
 use Romm\Formz\Middleware\Option\OptionDefinitionInterface;
 use Romm\Formz\Middleware\Processor\MiddlewareProcessor;
 use Romm\Formz\Middleware\Request\Forward;
 use Romm\Formz\Middleware\Request\Redirect;
 use Romm\Formz\Middleware\Signal\After;
 use Romm\Formz\Middleware\Signal\Before;
-use Romm\Formz\Middleware\Signal\MiddlewareSignalInterface;
-use Romm\Formz\Middleware\Signal\SendsMiddlewareSignal;
-use Romm\Formz\Middleware\Signal\SignalObject;
+use Romm\Formz\Middleware\Signal\Element\MiddlewareSignalInterface;
+use Romm\Formz\Middleware\Signal\SendsSignal;
+use Romm\Formz\Middleware\Signal\Element\SignalObject;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
 use TYPO3\CMS\Extbase\Mvc\Web\Request;
 use TYPO3\CMS\Extbase\Reflection\ReflectionService;
 
 /**
- * Abstract class that must be extended by middlewares.
+ * Default abstraction layout that can be extended by middlewares. It contains
+ * basic implementation needed by a middleware to work properly.
  *
- * Child middleware must implement their own signals.
+ * The middleware class must still implement its own signals.
  */
 abstract class AbstractMiddleware implements MiddlewareInterface, DataPreProcessorInterface
 {
@@ -52,6 +53,8 @@ abstract class AbstractMiddleware implements MiddlewareInterface, DataPreProcess
      * This is the default option class, this property can be overridden in
      * children classes to be mapped to another option definition.
      *
+     * Please note that the full class name of the option must be written.
+     *
      * @var \Romm\Formz\Middleware\Option\DefaultOptionDefinition
      */
     protected $options;
@@ -100,7 +103,7 @@ protected function initializeMiddleware()
     }
 
     /**
-     * @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::beforeSignal()
+     * @see \Romm\Formz\Middleware\Signal\SendsSignal::beforeSignal()
      *
      * @param string $signal
      * @return SignalObject
@@ -111,7 +114,7 @@ final public function beforeSignal($signal = null)
     }
 
     /**
-     * @see \Romm\Formz\Middleware\Signal\SendsMiddlewareSignal::afterSignal()
+     * @see \Romm\Formz\Middleware\Signal\SendsSignal::afterSignal()
      *
      * @param string $signal
      * @return SignalObject
@@ -253,11 +256,11 @@ public static function dataPreProcessor(DataPreProcessor $processor)
      */
     private function getSignalObject($signal, $type)
     {
-        if (false === $this instanceof SendsMiddlewareSignal) {
+        if (false === $this instanceof SendsSignal) {
             throw InvalidEntryException::middlewareNotSendingSignals($this);
         }
 
-        /** @var SendsMiddlewareSignal $this */
+        /** @var SendsSignal $this */
         if (null === $signal) {
             if (count($this->getAllowedSignals()) > 1) {
                 throw MissingArgumentException::signalNameArgumentMissing($this);

Classes/Middleware/Element/DefaultMiddleware.php → Classes/Middleware/Application/DefaultMiddleware.php

@@ -11,7 +11,7 @@
  * http://www.gnu.org/licenses/gpl-3.0.html
  */
 
-namespace Romm\Formz\Middleware\Element;
+namespace Romm\Formz\Middleware\Application;
 
 use Romm\Formz\Middleware\Argument\Arguments;
 use Romm\Formz\Domain\Middleware\End\EndSignal;
@@ -24,8 +24,8 @@
  * the middleware processing.
  *
  * If you need the middleware to be called earlier, you can:
- * - @see \Romm\Formz\Middleware\Element\OnBeginMiddleware
- * - @see \Romm\Formz\Middleware\Element\AbstractMiddleware
+ * - @see \Romm\Formz\Middleware\Application\OnBeginMiddleware
+ * - @see \Romm\Formz\Middleware\Application\AbstractMiddleware
  */
 abstract class DefaultMiddleware extends AbstractMiddleware implements Before, EndSignal
 {

Classes/Middleware/Element/OnBeginMiddleware.php → Classes/Middleware/Application/OnBeginMiddleware.php

@@ -11,7 +11,7 @@
  * http://www.gnu.org/licenses/gpl-3.0.html
  */
 
-namespace Romm\Formz\Middleware\Element;
+namespace Romm\Formz\Middleware\Application;
 
 use Romm\Formz\Middleware\Argument\Arguments;
 use Romm\Formz\Domain\Middleware\Begin\BeginSignal;
@@ -24,8 +24,8 @@
  * of the middleware processing.
  *
  * If you need the middleware to be called later, you can:
- * - @see \Romm\Formz\Middleware\Element\DefaultMiddleware (called at the end)
- * - @see \Romm\Formz\Middleware\Element\AbstractMiddleware
+ * - @see \Romm\Formz\Middleware\Application\DefaultMiddleware (called at the end)
+ * - @see \Romm\Formz\Middleware\Application\AbstractMiddleware
  */
 abstract class OnBeginMiddleware extends AbstractMiddleware implements After, BeginSignal
 {

Classes/Middleware/MiddlewareFactory.php

@@ -16,7 +16,6 @@
 use Romm\Formz\Core\Core;
 use Romm\Formz\Exceptions\ClassNotFoundException;
 use Romm\Formz\Exceptions\InvalidArgumentTypeException;
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
 use Romm\Formz\Middleware\Option\OptionDefinitionInterface;
 use Romm\Formz\Service\Traits\ExtendedSelfInstantiateTrait;
 use TYPO3\CMS\Core\SingletonInterface;

Classes/Middleware/Element/MiddlewareInterface.php → Classes/Middleware/MiddlewareInterface.php

@@ -11,7 +11,7 @@
  * http://www.gnu.org/licenses/gpl-3.0.html
  */
 
-namespace Romm\Formz\Middleware\Element;
+namespace Romm\Formz\Middleware;
 
 use Romm\Formz\Middleware\Option\OptionDefinitionInterface;
 use Romm\Formz\Middleware\Processor\MiddlewareProcessor;

Classes/Middleware/Processor/PresetMiddlewareInterface.php → Classes/Middleware/PresetMiddlewareInterface.php

@@ -11,10 +11,11 @@
  * http://www.gnu.org/licenses/gpl-3.0.html
  */
 
-namespace Romm\Formz\Middleware\Processor;
+namespace Romm\Formz\Middleware;
 
 /**
- * This interface is implemented by all middlewares in FormZ core.
+ * This interface is implemented by middlewares in FormZ core. Do not use in
+ * your own projects!
  *
  * @internal
  */

Classes/Middleware/Processor/MiddlewareProcessor.php

@@ -17,7 +17,7 @@
 use Romm\Formz\Form\FormObject\FormObject;
 use Romm\Formz\Domain\Middleware\Begin\BeginMiddleware;
 use Romm\Formz\Domain\Middleware\End\EndMiddleware;
-use Romm\Formz\Middleware\Element\MiddlewareInterface;
+use Romm\Formz\Middleware\MiddlewareInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Mvc\Controller\Arguments;
 use TYPO3\CMS\Extbase\Mvc\Web\Request;

Classes/Middleware/Signal/After.php

@@ -18,6 +18,12 @@
 interface After
 {
     /**
+     * This method is called after the dispatching of the signal on which the
+     * middleware is bound. The main logic of the middleware will be implemented
+     * here.
+     *
+     * Arguments may be passed to the method, depending on the signal.
+     *
      * @param Arguments $arguments
      * @return void
      */