[!!!][TASK] Rename form configuration to form definition

The whole configuration objects representing all form properties have been moved and renamed to `definition`, as this word better represents what the objects actually are and do. This commit is part of a bigger plan to refactor the form objects handling, that will result in an easier way to manipulate the forms during the runtime.
romm · Apr 24, 2017 · cae979b · cae979b
1 parent a353c5f
commit cae979b
Show file tree

Hide file tree

Showing 95 changed files with 252 additions and 252 deletions.
diff --git a/Classes/AssetHandler/Css/FieldsActivationCssAssetHandler.php b/Classes/AssetHandler/Css/FieldsActivationCssAssetHandler.php
@@ -15,7 +15,7 @@
 
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
 use Romm\Formz\Condition\Parser\ConditionTree;
-use Romm\Formz\Configuration\Form\Field\Field;
+use Romm\Formz\Form\Definition\Field\Field;
 
 /**
  * This asset handler generates the CSS code which will automatically hide
@@ -37,7 +37,7 @@ class FieldsActivationCssAssetHandler extends AbstractAssetHandler
     public function getFieldsActivationCss()
     {
         $cssBlocks = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
 
         foreach ($formConfiguration->getFields() as $field) {
             $formName = $this->getFormObject()->getName();

diff --git a/Classes/AssetHandler/Css/MessageContainerDisplayCssAssetHandler.php b/Classes/AssetHandler/Css/MessageContainerDisplayCssAssetHandler.php
@@ -31,7 +31,7 @@ class MessageContainerDisplayCssAssetHandler extends AbstractAssetHandler
     public function getErrorContainerDisplayCss()
     {
         $cssBlocks = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
 
         foreach ($formConfiguration->getFields() as $fieldName => $field) {
             $formName = $this->getFormObject()->getName();

diff --git a/Classes/AssetHandler/Html/DataAttributesAssetHandler.php b/Classes/AssetHandler/Html/DataAttributesAssetHandler.php
@@ -52,7 +52,7 @@ public function getFieldsValuesDataAttributes(FormResult $formResult)
         $formObject = $this->getFormObject();
         $formInstance = $formObject->getForm();
 
-        foreach ($formObject->getConfiguration()->getFields() as $field) {
+        foreach ($formObject->getDefinition()->getFields() as $field) {
             $fieldName = $field->getName();
 
             if (false === $formResult->fieldIsDeactivated($field)) {
@@ -83,7 +83,7 @@ public function getFieldsValuesDataAttributes(FormResult $formResult)
     public function getFieldsMessagesDataAttributes()
     {
         $result = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
         $formResult = $this->getFormObject()->getFormResult();
 
         foreach ($formResult->getSubResults() as $fieldName => $fieldResult) {
@@ -165,7 +165,7 @@ protected function addFieldMessageDataAttribute($fieldName, array $messages, $ty
     public function getFieldsValidDataAttributes()
     {
         $result = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
         $formResult = $this->getFormObject()->getFormResult();
 
         foreach ($formConfiguration->getFields() as $field) {

diff --git a/Classes/AssetHandler/JavaScript/FieldsActivationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FieldsActivationJavaScriptAssetHandler.php
@@ -15,7 +15,7 @@
 
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
 use Romm\Formz\Condition\Parser\ConditionTree;
-use Romm\Formz\Configuration\Form\Field\Field;
+use Romm\Formz\Form\Definition\Field\Field;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
@@ -34,7 +34,7 @@ class FieldsActivationJavaScriptAssetHandler extends AbstractAssetHandler
     public function getFieldsActivationJavaScriptCode()
     {
         $javaScriptBlocks = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
 
         foreach ($formConfiguration->getFields() as $field) {
             $fieldConditionExpression = [];

diff --git a/Classes/AssetHandler/JavaScript/FieldsValidationActivationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FieldsValidationActivationJavaScriptAssetHandler.php
@@ -15,7 +15,7 @@
 
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
 use Romm\Formz\Condition\Parser\ConditionTree;
-use Romm\Formz\Configuration\Form\Field\Validation\Validation;
+use Romm\Formz\Form\Definition\Field\Validation\Validation;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
@@ -34,7 +34,7 @@ class FieldsValidationActivationJavaScriptAssetHandler extends AbstractAssetHand
     public function getFieldsValidationActivationJavaScriptCode()
     {
         $javaScriptBlocks = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
 
         foreach ($formConfiguration->getFields() as $field) {
             foreach ($field->getValidation() as $validation) {

diff --git a/Classes/AssetHandler/JavaScript/FieldsValidationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FieldsValidationJavaScriptAssetHandler.php
@@ -14,8 +14,8 @@
 namespace Romm\Formz\AssetHandler\JavaScript;
 
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
-use Romm\Formz\Configuration\Form\Field\Field;
-use Romm\Formz\Configuration\Form\Field\Validation\Validation;
+use Romm\Formz\Form\Definition\Field\Field;
+use Romm\Formz\Form\Definition\Field\Validation\Validation;
 use Romm\Formz\Service\ArrayService;
 use Romm\Formz\Service\ValidatorService;
 use Romm\Formz\Validation\Validator\AbstractValidator;
@@ -44,7 +44,7 @@ class FieldsValidationJavaScriptAssetHandler extends AbstractAssetHandler
     public function getJavaScriptCode()
     {
         $fieldsJavaScriptCode = [];
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
 
         foreach ($formConfiguration->getFields() as $field) {
             $fieldsJavaScriptCode[] = $this->processField($field);
@@ -171,7 +171,7 @@ public function getJavaScriptValidationFiles()
         if (null === $this->javaScriptValidationFiles) {
             $this->javaScriptValidationFiles = [];
 
-            $formConfiguration = $this->getFormObject()->getConfiguration();
+            $formConfiguration = $this->getFormObject()->getDefinition();
 
             foreach ($formConfiguration->getFields() as $field) {
                 foreach ($field->getValidation() as $validationConfiguration) {

diff --git a/Classes/AssetHandler/JavaScript/FormInitializationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FormInitializationJavaScriptAssetHandler.php
@@ -61,7 +61,7 @@ protected function handleFormConfiguration($formConfiguration)
      */
     protected function getFormConfiguration()
     {
-        $formConfigurationArray = $this->getFormObject()->getConfiguration()->toArray();
+        $formConfigurationArray = $this->getFormObject()->getDefinition()->toArray();
         $this->removeFieldsValidationConfiguration($formConfigurationArray)
             ->addClassNameProperty($formConfigurationArray);
 

diff --git a/Classes/AssetHandler/JavaScript/FormRequestDataJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FormRequestDataJavaScriptAssetHandler.php
@@ -14,7 +14,7 @@
 namespace Romm\Formz\AssetHandler\JavaScript;
 
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
-use Romm\Formz\Configuration\Form\Field\Field;
+use Romm\Formz\Form\Definition\Field\Field;
 use Romm\Formz\Error\FormzMessageInterface;
 use Romm\Formz\Service\ArrayService;
 use Romm\Formz\Service\MessageService;
@@ -100,7 +100,7 @@ protected function getFieldsExistingMessages()
         if ($formObject->formWasSubmitted()
             && $formObject->hasFormResult()
         ) {
-            foreach ($this->getFormObject()->getConfiguration()->getFields() as $field) {
+            foreach ($this->getFormObject()->getDefinition()->getFields() as $field) {
                 $fieldsMessages[$field->getName()] = $this->getSingleFieldExistingMessages($field);
             }
         }

diff --git a/Classes/AssetHandler/JavaScript/FormzConfigurationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FormzConfigurationJavaScriptAssetHandler.php
@@ -30,7 +30,7 @@ class FormzConfigurationJavaScriptAssetHandler extends AbstractAssetHandler
     public function getJavaScriptFileName()
     {
         $hash = sha1($this->getFormObject()
-            ->getConfiguration()
+            ->getDefinition()
             ->getRootConfiguration()
             ->getHash());
 
@@ -70,7 +70,7 @@ protected function handleFormzConfiguration($formzConfiguration)
     protected function getFormzConfiguration()
     {
         $rootConfigurationArray = $this->getFormObject()
-            ->getConfiguration()
+            ->getDefinition()
             ->getRootConfiguration()
             ->toArray();
 

diff --git a/Classes/AssetHandler/JavaScript/FormzLocalizationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FormzLocalizationJavaScriptAssetHandler.php
@@ -14,7 +14,7 @@
 namespace Romm\Formz\AssetHandler\JavaScript;
 
 use Romm\Formz\AssetHandler\AbstractAssetHandler;
-use Romm\Formz\Configuration\Form\Field\Field;
+use Romm\Formz\Form\Definition\Field\Field;
 use Romm\Formz\Service\ArrayService;
 use Romm\Formz\Service\HashService;
 use Romm\Formz\Service\MessageService;
@@ -109,7 +109,7 @@ public function getTranslationKeysForFieldValidation(Field $field, $validationNa
      */
     public function injectTranslationsForFormFieldsValidation()
     {
-        $formConfiguration = $this->getFormObject()->getConfiguration();
+        $formConfiguration = $this->getFormObject()->getDefinition();
 
         foreach ($formConfiguration->getFields() as $field) {
             $this->storeTranslationsForFieldValidation($field);

diff --git a/Classes/Behaviours/BehavioursManager.php b/Classes/Behaviours/BehavioursManager.php
@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Behaviours;
 
-use Romm\Formz\Configuration\Form\Form;
+use Romm\Formz\Form\Definition\FormDefinition;
 use Romm\Formz\Form\FormObject;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
@@ -35,11 +35,11 @@ class BehavioursManager implements SingletonInterface
      * in `$formProperties`, the behaviours are applied and the value is
      * changed.
      *
-     * @param array $formProperties    Properties values of the submitted form.
-     * @param Form  $formConfiguration Configuration object of the form.
+     * @param array          $formProperties    Properties values of the submitted form.
+     * @param FormDefinition $formConfiguration Configuration object of the form.
      * @return array
      */
-    public function applyBehaviourOnPropertiesArray(array $formProperties, Form $formConfiguration)
+    public function applyBehaviourOnPropertiesArray(array $formProperties, FormDefinition $formConfiguration)
     {
         foreach ($formConfiguration->getFields() as $fieldName => $field) {
             if (true === isset($formProperties[$fieldName])) {
@@ -67,7 +67,7 @@ public function applyBehaviourOnFormInstance(FormObject $formObject)
         if ($formObject->hasForm()) {
             $formInstance = $formObject->getForm();
 
-            foreach ($formObject->getConfiguration()->getFields() as $fieldName => $field) {
+            foreach ($formObject->getDefinition()->getFields() as $fieldName => $field) {
                 if (ObjectAccess::isPropertyGettable($formInstance, $fieldName)
                     && ObjectAccess::isPropertySettable($formInstance, $fieldName)
                 ) {

diff --git a/Classes/Condition/Exceptions/InvalidConditionException.php b/Classes/Condition/Exceptions/InvalidConditionException.php
@@ -13,8 +13,8 @@
 
 namespace Romm\Formz\Condition\Exceptions;
 
-use Romm\Formz\Configuration\Form\Field\Field;
-use Romm\Formz\Configuration\Form\Field\Validation\Validation;
+use Romm\Formz\Form\Definition\Field\Field;
+use Romm\Formz\Form\Definition\Field\Validation\Validation;
 use Romm\Formz\Exceptions\FormzException;
 
 class InvalidConditionException extends FormzException

diff --git a/Classes/Condition/Items/AbstractConditionItem.php b/Classes/Condition/Items/AbstractConditionItem.php
@@ -16,9 +16,9 @@
 use Romm\ConfigurationObject\Traits\ConfigurationObject\MagicMethodsTrait;
 use Romm\Formz\Condition\Exceptions\InvalidConditionException;
 use Romm\Formz\Condition\Parser\Node\ConditionNode;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
-use Romm\Formz\Configuration\Form\Field\Field;
-use Romm\Formz\Configuration\Form\Field\Validation\Validation;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Field;
+use Romm\Formz\Form\Definition\Field\Validation\Validation;
 use Romm\Formz\Form\FormObject;
 use Romm\Formz\Service\ArrayService;
 

diff --git a/Classes/Condition/Items/ConditionItemInterface.php b/Classes/Condition/Items/ConditionItemInterface.php
@@ -16,7 +16,7 @@
 use Romm\Formz\Condition\Exceptions\InvalidConditionException;
 use Romm\Formz\Condition\Parser\Node\ConditionNode;
 use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
 use Romm\Formz\Form\FormObject;
 
 interface ConditionItemInterface

diff --git a/Classes/Condition/Items/FieldHasErrorCondition.php b/Classes/Condition/Items/FieldHasErrorCondition.php
@@ -84,7 +84,7 @@ public function getPhpResult(PhpConditionDataObject $dataObject)
     {
         $flag = false;
         $formValidator = $dataObject->getFormValidator();
-        $field = $this->formObject->getConfiguration()->getField($this->fieldName);
+        $field = $this->formObject->getDefinition()->getField($this->fieldName);
         $formValidator->validateField($field);
         $result = $formValidator->getResult()->forProperty($this->fieldName);
 
@@ -108,7 +108,7 @@ public function getPhpResult(PhpConditionDataObject $dataObject)
      */
     protected function checkConditionConfiguration()
     {
-        $configuration = $this->formObject->getConfiguration();
+        $configuration = $this->formObject->getDefinition();
 
         if (false === $configuration->hasField($this->fieldName)) {
             throw InvalidConditionException::conditionFieldHasErrorFieldNotFound($this->fieldName);

diff --git a/Classes/Condition/Items/FieldHasValueCondition.php b/Classes/Condition/Items/FieldHasValueCondition.php
@@ -86,7 +86,7 @@ public function getPhpResult(PhpConditionDataObject $dataObject)
      */
     protected function checkConditionConfiguration()
     {
-        $configuration = $this->formObject->getConfiguration();
+        $configuration = $this->formObject->getDefinition();
 
         if (false === $configuration->hasField($this->fieldName)) {
             throw InvalidConditionException::conditionFieldHasValueFieldNotFound($this->fieldName);

diff --git a/Classes/Condition/Items/FieldIsEmptyCondition.php b/Classes/Condition/Items/FieldIsEmptyCondition.php
@@ -73,7 +73,7 @@ public function getPhpResult(PhpConditionDataObject $dataObject)
      */
     protected function checkConditionConfiguration()
     {
-        $configuration = $this->formObject->getConfiguration();
+        $configuration = $this->formObject->getDefinition();
 
         if (false === $configuration->hasField($this->fieldName)) {
             throw InvalidConditionException::conditionFieldIsEmptyFieldNotFound($this->fieldName);

diff --git a/Classes/Condition/Items/FieldIsValidCondition.php b/Classes/Condition/Items/FieldIsValidCondition.php
@@ -61,7 +61,7 @@ public function getJavaScriptResult()
     public function getPhpResult(PhpConditionDataObject $dataObject)
     {
         $formValidator = $dataObject->getFormValidator();
-        $field = $this->formObject->getConfiguration()->getField($this->fieldName);
+        $field = $this->formObject->getDefinition()->getField($this->fieldName);
         $formValidator->validateField($field);
         $result = $formValidator->getResult();
 
@@ -76,7 +76,7 @@ public function getPhpResult(PhpConditionDataObject $dataObject)
      */
     protected function checkConditionConfiguration()
     {
-        $configuration = $this->formObject->getConfiguration();
+        $configuration = $this->formObject->getDefinition();
 
         if (false === $configuration->hasField($this->fieldName)) {
             throw InvalidConditionException::conditionFieldIsValidFieldNotFound($this->fieldName);

diff --git a/Classes/Condition/Parser/ConditionParser.php b/Classes/Condition/Parser/ConditionParser.php
@@ -18,8 +18,8 @@
 use Romm\Formz\Condition\Parser\Node\ConditionNode;
 use Romm\Formz\Condition\Parser\Node\NodeInterface;
 use Romm\Formz\Condition\Parser\Node\NullNode;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
-use Romm\Formz\Configuration\Form\Field\Activation\EmptyActivation;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Activation\EmptyActivation;
 use Romm\Formz\Service\Traits\SelfInstantiateTrait;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;

diff --git a/Classes/Condition/Parser/ConditionParserFactory.php b/Classes/Condition/Parser/ConditionParserFactory.php
@@ -13,7 +13,7 @@
 
 namespace Romm\Formz\Condition\Parser;
 
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
 use Romm\Formz\Service\CacheService;
 use Romm\Formz\Service\HashService;
 use Romm\Formz\Service\Traits\SelfInstantiateTrait;

diff --git a/Classes/Condition/Parser/ConditionTree.php b/Classes/Condition/Parser/ConditionTree.php
@@ -17,7 +17,7 @@
 use Romm\Formz\Condition\Parser\Node\NodeInterface;
 use Romm\Formz\Condition\Processor\ConditionProcessor;
 use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
 use TYPO3\CMS\Extbase\Error\Result;
 
 /**

diff --git a/Classes/Condition/Parser/Node/ActivationDependencyAwareInterface.php b/Classes/Condition/Parser/Node/ActivationDependencyAwareInterface.php
@@ -14,7 +14,7 @@
 namespace Romm\Formz\Condition\Parser\Node;
 
 use Romm\Formz\Condition\Processor\ConditionProcessor;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
 
 interface ActivationDependencyAwareInterface
 {

diff --git a/Classes/Condition/Parser/Node/ConditionNode.php b/Classes/Condition/Parser/Node/ConditionNode.php
@@ -16,7 +16,7 @@
 use Romm\Formz\Condition\Items\ConditionItemInterface;
 use Romm\Formz\Condition\Processor\ConditionProcessor;
 use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
 
 /**
  * A condition node, which contains an instance of `ConditionItemInterface`.

diff --git a/Classes/Condition/Processor/ConditionProcessor.php b/Classes/Condition/Processor/ConditionProcessor.php
@@ -17,9 +17,9 @@
 use Romm\Formz\Condition\Parser\ConditionTree;
 use Romm\Formz\Condition\Parser\Node\ConditionNode;
 use Romm\Formz\Condition\Parser\Node\NodeInterface;
-use Romm\Formz\Configuration\Form\Field\Activation\ActivationInterface;
-use Romm\Formz\Configuration\Form\Field\Field;
-use Romm\Formz\Configuration\Form\Field\Validation\Validation;
+use Romm\Formz\Form\Definition\Field\Activation\ActivationInterface;
+use Romm\Formz\Form\Definition\Field\Field;
+use Romm\Formz\Form\Definition\Field\Validation\Validation;
 use Romm\Formz\Form\FormObject;
 
 class ConditionProcessor
@@ -100,7 +100,7 @@ public function getActivationConditionTreeForValidation(Validation $validation)
      */
     public function calculateAllTrees()
     {
-        $fields = $this->formObject->getConfiguration()->getFields();
+        $fields = $this->formObject->getDefinition()->getFields();
 
         foreach ($fields as $field) {
             $this->getActivationConditionTreeForField($field);

diff --git a/Classes/Configuration/Configuration.php b/Classes/Configuration/Configuration.php
@@ -19,7 +19,7 @@
 use Romm\ConfigurationObject\Service\ServiceInterface;
 use Romm\ConfigurationObject\Traits\ConfigurationObject\ArrayConversionTrait;
 use Romm\ConfigurationObject\Traits\ConfigurationObject\DefaultConfigurationObjectTrait;
-use Romm\Formz\Configuration\Form\Form;
+use Romm\Formz\Form\Definition\FormDefinition;
 use Romm\Formz\Configuration\Settings\Settings;
 use Romm\Formz\Configuration\View\View;
 use Romm\Formz\Exceptions\DuplicateEntryException;
@@ -101,7 +101,7 @@ public function addForm(FormObject $form)
             throw DuplicateEntryException::formWasAlreadyRegistered($form);
         }
 
-        $form->getConfiguration()->setParents([$this]);
+        $form->getDefinition()->setParents([$this]);
 
         $this->forms[$form->getClassName()][$form->getName()] = $form;
     }
@@ -119,7 +119,7 @@ public function hasForm($className, $name)
     /**
      * @param string $className
      * @param string $name
-     * @return null|Form
+     * @return null|FormDefinition
      */
     public function getForm($className, $name)
     {