Skip to content
This repository has been archived by the owner on Mar 1, 2023. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'remotes/origin/feature/version-2' into …
Browse files Browse the repository at this point in the history
…feature/middleware

# Conflicts:
#	Classes/Exceptions/EntryNotFoundException.php
#	Classes/Validation/Validator/AbstractValidator.php
#	Classes/Validation/Validator/Form/AbstractFormValidator.php
#	Classes/Validation/Validator/Form/FormValidatorExecutor.php
#	Tests/Unit/Validation/Validator/Form/FormValidatorExecutorTest.php
  • Loading branch information
romm committed Aug 28, 2017
1 parent 45b9921 commit e11f5b6
Show file tree
Hide file tree
Showing 21 changed files with 66 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
namespace Romm\Formz\Condition\Processor\DataObject;

use Romm\Formz\Form\FormInterface;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;

class PhpConditionDataObject
{
Expand Down
3 changes: 2 additions & 1 deletion Classes/Form/FormObject/FormObjectProxy.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
use Romm\Formz\Form\FormInterface;
use Romm\Formz\Form\FormObject\Service\FormObjectRequestData;
use Romm\Formz\Service\HashService;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class FormObjectProxy
{
Expand Down Expand Up @@ -114,7 +115,7 @@ public function formWasValidated()
public function getFormResult()
{
if (null === $this->formResult) {
$this->formResult = new FormResult;
$this->formResult = GeneralUtility::makeInstance(FormResult::class);
}

return $this->formResult;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* http://www.gnu.org/licenses/gpl-3.0.html
*/

namespace Romm\Formz\Validation\Validator\Form;
namespace Romm\Formz\Validation\Form;

use Romm\Formz\Core\Core;
use Romm\Formz\Error\FormResult;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* http://www.gnu.org/licenses/gpl-3.0.html
*/

namespace Romm\Formz\Validation\Validator\Form;
namespace Romm\Formz\Validation\Form;

use Romm\Formz\Behaviours\BehavioursManager;
use Romm\Formz\Condition\Processor\ConditionProcessor;
Expand Down
2 changes: 2 additions & 0 deletions Classes/Validation/Validator/Form/DefaultFormValidator.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace Romm\Formz\Validation\Validator\Form;

use Romm\Formz\Validation\Form\AbstractFormValidator;

/**
* This is a default form validator, with no particular functionality.
*
Expand Down
2 changes: 1 addition & 1 deletion Documentation/04-DeveloperManual/PHP/FormValidator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ You can find below an example of a form validator.
<?php
namespace MyVendor\MyExtension\Validation\Validator\Form;
use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
use Romm\Formz\Validation\Form\AbstractFormValidator;
use MyVendor\MyExtension\Utility\SimulationUtility;
use MyVendor\MyExtension\Form\SimulationForm
Expand Down
2 changes: 1 addition & 1 deletion Documentation/04-DeveloperManual/PHP/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To create a form, you will have to use the following classes:

- :ref:`developerManual-php-formValidator`

:php:`Romm\Formz\Validation\Validator\Form\AbstractFormValidator` — must be inherited by your form validator.
:php:`Romm\Formz\Validation\Form\AbstractFormValidator` — must be inherited by your form validator.

- :ref:`developerManual-php-validator`

Expand Down
4 changes: 2 additions & 2 deletions Documentation/07-CheatSheets/PhpCheatSheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Controller
Form validator
--------------

* Must inherit :php:`Romm\Formz\Validation\Validator\Form\AbstractFormValidator` (see line 10);
* Must inherit :php:`Romm\Formz\Validation\Form\AbstractFormValidator` (see line 10);
* Can manipulate :php:`$this->result`, for instance to add errors (see line 65).
* Can override the methods :php:`beforeValidationProcess()` and :php:`afterValidationProcess()`, which are called before and after the validation process (see lines 24 & 58);
* Can call dynamic methods at the end of a field validation: :php:`*Validated` where ``*`` is the field name in lowerCamelCase (see line 43);
Expand All @@ -119,7 +119,7 @@ Form validator
<?php
namespace MyVendor\MyExtension\Validation\Validator\Form;
use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
use Romm\Formz\Validation\Form\AbstractFormValidator;
use MyVendor\MyExtension\Utility\SimulationUtility;
use MyVendor\MyExtension\Utility\SessionUtility;
use MyVendor\MyExtension\Utility\GeographyUtility;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.. include:: ../../../Includes.txt

================================================
Breaking: Move form validation classes namespace
================================================

Description
===========

The classes used for the form validation have been moved into the `Validation/Form` folder, as they are not proper validator classes. Only the
`DefaultFormValidator` class remains at its place.

This is an effort to clean up the files structure and make the whole application architecture more consistent.

Impact
======

The class :php:`\Romm\Formz\Validation\Validator\Form\AbstractFormValidator` has been moved to :php:`\Romm\Formz\Validation\Form\AbstractFormValidator`, meaning form validators that do extend this class must change the used namespace.

**Example:**

.. code-block:: php
:linenos:
:emphasize-lines: 4,13
// OLD:
namespace Vendor\MyExtension\Validation\Validator\Form;
use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
class MyCustomFormValidator extends AbstractFormValidator
{
}
// NEW:
namespace Vendor\MyExtension\Validation\Validator\Form;
use Romm\Formz\Validation\Form\AbstractFormValidator;
class MyCustomFormValidator extends AbstractFormValidator
{
}
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Vous retrouverez ci-dessous un exemple de validateur de formulaire.
<?php
namespace MyVendor\MyExtension\Validation\Validator\Form;
use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
use Romm\Formz\Validation\Form\AbstractFormValidator;
use MyVendor\MyExtension\Utility\SimulationUtility;
use MyVendor\MyExtension\Form\SimulationForm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Pour installer un formulaire, vous serez amené à utiliser les classes suivante

- :ref:`developerManual-php-formValidator`

:php:`Romm\Formz\Validation\Validator\Form\AbstractFormValidator` — devra être héritée par le validateur de votre formulaire.
:php:`Romm\Formz\Validation\Form\AbstractFormValidator` — devra être héritée par le validateur de votre formulaire.

- :ref:`developerManual-php-validator`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Contrôleur
Validateur de formulaire
------------------------

* Doit hériter de :php:`Romm\Formz\Validation\Validator\Form\AbstractFormValidator` (cf. ligne 10) ;
* Doit hériter de :php:`Romm\Formz\Validation\Form\AbstractFormValidator` (cf. ligne 10) ;
* Peut manipuler :php:`$this->result` à la volée, par exemple pour rajouter des erreurs (cf. ligne 65) ;
* Peut surcharger les méthodes :php:`beforeValidationProcess()` et :php:`afterValidationProcess()`, appelées respectivement avant et après le processus de validation (cf. lignes 24 & 58) ;
* Peut appeler des méthodes dynamiques à chaque fin de validation d'un champ : :php:`*Validated` où ``*`` représente le nom du champ en lowerCamelCase (cf. ligne 43) ;
Expand All @@ -119,7 +119,7 @@ Validateur de formulaire
<?php
namespace MyVendor\MyExtension\Validation\Validator\Form;
use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
use Romm\Formz\Validation\Form\AbstractFormValidator;
use MyVendor\MyExtension\Utility\SimulationUtility;
use MyVendor\MyExtension\Utility\SessionUtility;
use MyVendor\MyExtension\Utility\GeographyUtility;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
namespace Romm\Formz\Tests\Fixture\Validation\Validator\Form;

use Romm\Formz\Validation\Validator\Form\AbstractFormValidator;
use Romm\Formz\Validation\Form\AbstractFormValidator;

class DummyFormValidator extends AbstractFormValidator
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public function checkLocalizationIsInitializedCorrectly()
$field = $assetHandlerFactory->getFormObject()->getDefinition()->getField('foo');
$validator = $field->addValidator('validation-name', RequiredValidator::class);

/** @var LocalizationJavaScriptAssetHandler|\PHPUnit_Framework_MockObject_MockObject $assetHandler */
/** @var LocalizationJavaScriptAssetHandler|\PHPUnit_Framework_MockObject_MockObject $assetHandler */
$assetHandler = $this->getMockBuilder(LocalizationJavaScriptAssetHandler::class)
->setMethods(['handleRealTranslations', 'handleTranslationsBinding'])
->setConstructorArgs([$assetHandlerFactory])
Expand Down
2 changes: 1 addition & 1 deletion Tests/Unit/Condition/Items/FieldHasErrorConditionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use Romm\Formz\Error\Error;
use Romm\Formz\Error\FormResult;
use Romm\Formz\Tests\Fixture\Form\DefaultForm;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Validator\RequiredValidator;

class FieldHasErrorConditionTest extends AbstractConditionItemUnitTest
Expand Down
2 changes: 1 addition & 1 deletion Tests/Unit/Condition/Items/FieldHasValueConditionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use Romm\Formz\Condition\Items\FieldHasValueCondition;
use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
use Romm\Formz\Tests\Fixture\Form\DefaultForm;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;

class FieldHasValueConditionTest extends AbstractConditionItemUnitTest
{
Expand Down
2 changes: 1 addition & 1 deletion Tests/Unit/Condition/Items/FieldIsEmptyConditionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
use Romm\Formz\Condition\Items\FieldIsEmptyCondition;
use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
use Romm\Formz\Tests\Fixture\Form\DefaultForm;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;

class FieldIsEmptyConditionTest extends AbstractConditionItemUnitTest
{
Expand Down
2 changes: 1 addition & 1 deletion Tests/Unit/Condition/Items/FieldIsValidConditionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
use Romm\Formz\Error\Error;
use Romm\Formz\Error\FormResult;
use Romm\Formz\Tests\Fixture\Form\DefaultForm;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;

class FieldIsValidConditionTest extends AbstractConditionItemUnitTest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
use Romm\Formz\Form\FormInterface;
use Romm\Formz\Tests\Unit\AbstractUnitTest;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;

class PhpConditionDataObjectTest extends AbstractUnitTest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
use Romm\Formz\Tests\Fixture\Form\DefaultForm;
use Romm\Formz\Tests\Fixture\Validation\Validator\Form\DummyFormValidator;
use Romm\Formz\Tests\Unit\AbstractUnitTest;
use Romm\Formz\Validation\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Validator\Form\DefaultFormValidator;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;

class AbstractFormValidatorTest extends AbstractUnitTest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use Romm\Formz\Tests\Fixture\Form\DefaultForm;
use Romm\Formz\Tests\Unit\AbstractUnitTest;
use Romm\Formz\Validation\Validator\Form\DataObject\FormValidatorDataObject;
use Romm\Formz\Validation\Validator\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Form\FormValidatorExecutor;
use Romm\Formz\Validation\Validator\RequiredValidator;

class FormValidatorExecutorTest extends AbstractUnitTest
Expand Down

0 comments on commit e11f5b6

Please sign in to comment.