diff --git a/Classes/AssetHandler/JavaScript/FieldsValidationJavaScriptAssetHandler.php b/Classes/AssetHandler/JavaScript/FieldsValidationJavaScriptAssetHandler.php index 8defa71..61a5260 100644 --- a/Classes/AssetHandler/JavaScript/FieldsValidationJavaScriptAssetHandler.php +++ b/Classes/AssetHandler/JavaScript/FieldsValidationJavaScriptAssetHandler.php @@ -18,7 +18,7 @@ use Romm\Formz\Form\Definition\Field\Validation\Validator; use Romm\Formz\Service\ArrayService; use Romm\Formz\Service\ValidatorService; -use Romm\Formz\Validation\Validator\AbstractValidator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\Utility\GeneralUtility; /** @@ -81,7 +81,7 @@ protected function processField($field) foreach ($field->getValidators() as $validator) { $validatorClassName = $validator->getClassName(); - if (in_array(AbstractValidator::class, class_parents($validatorClassName))) { + if (in_array(AbstractFieldValidator::class, class_parents($validatorClassName))) { $javaScriptCode[] = (string)$this->getInlineJavaScriptValidatorCode($field, $validator); } } @@ -175,8 +175,8 @@ public function getJavaScriptValidationFiles() foreach ($field->getValidators() as $validator) { $validatorClassName = $validator->getClassName(); - if (in_array(AbstractValidator::class, class_parents($validatorClassName))) { - /** @var AbstractValidator $validatorClassName */ + if (in_array(AbstractFieldValidator::class, class_parents($validatorClassName))) { + /** @var AbstractFieldValidator $validatorClassName */ $this->javaScriptValidationFiles = array_merge($this->javaScriptValidationFiles, $validatorClassName::getJavaScriptValidationFiles()); } } diff --git a/Classes/Controller/AjaxValidationController.php b/Classes/Controller/AjaxValidationController.php index c422dca..488953f 100644 --- a/Classes/Controller/AjaxValidationController.php +++ b/Classes/Controller/AjaxValidationController.php @@ -29,7 +29,7 @@ use Romm\Formz\Service\ContextService; use Romm\Formz\Service\ExtensionService; use Romm\Formz\Service\MessageService; -use Romm\Formz\Validation\DataObject\ValidatorDataObject; +use Romm\Formz\Validation\Field\DataObject\ValidatorDataObject; use TYPO3\CMS\Core\Utility\GeneralUtility; use TYPO3\CMS\Extbase\Error\Error; use TYPO3\CMS\Extbase\Mvc\Controller\ActionController; diff --git a/Classes/Exceptions/EntryNotFoundException.php b/Classes/Exceptions/EntryNotFoundException.php index 346af3d..fefcf40 100644 --- a/Classes/Exceptions/EntryNotFoundException.php +++ b/Classes/Exceptions/EntryNotFoundException.php @@ -23,7 +23,7 @@ use Romm\Formz\Form\FormInterface; use Romm\Formz\Form\FormObject\FormObject; use Romm\Formz\Form\FormObject\FormObjectFactory; -use Romm\Formz\Validation\Validator\AbstractValidator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use Romm\Formz\ViewHelpers\ClassViewHelper; use Romm\Formz\ViewHelpers\FieldViewHelper; use Romm\Formz\ViewHelpers\FormatMessageViewHelper; @@ -337,11 +337,11 @@ final public static function ajaxControllerFieldNotFound($fieldName, FormObject /** * @code 1455272659 * - * @param string $key - * @param AbstractValidator $validator + * @param string $key + * @param AbstractFieldValidator $validator * @return self */ - final public static function errorKeyNotFoundForValidator($key, AbstractValidator $validator) + final public static function errorKeyNotFoundForValidator($key, AbstractFieldValidator $validator) { /** @var self $exception */ $exception = self::getNewExceptionInstance( diff --git a/Classes/Service/ValidatorService.php b/Classes/Service/ValidatorService.php index 4714322..4b6c3d5 100644 --- a/Classes/Service/ValidatorService.php +++ b/Classes/Service/ValidatorService.php @@ -15,7 +15,7 @@ use Romm\Formz\Form\Definition\Field\Validation\Validator; use Romm\Formz\Service\Traits\SelfInstantiateTrait; -use Romm\Formz\Validation\Validator\AbstractValidator as FormzAbstractValidator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\SingletonInterface; use TYPO3\CMS\Core\Utility\ArrayUtility; use TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator; @@ -87,7 +87,7 @@ protected function getValidatorData(Validator $validator) 'acceptsEmptyValues' => $validatorProperties['acceptsEmptyValues'] ]; - if (in_array(FormzAbstractValidator::class, class_parents($validatorClassName))) { + if (in_array(AbstractFieldValidator::class, class_parents($validatorClassName))) { $validatorData['formzValidator'] = true; $validatorData['supportedMessages'] = $validatorProperties['supportedMessages']; $validatorData['supportsAllMessages'] = $validatorProperties['supportsAllMessages']; diff --git a/Classes/Validation/Validator/AbstractValidator.php b/Classes/Validation/Field/AbstractFieldValidator.php similarity index 96% rename from Classes/Validation/Validator/AbstractValidator.php rename to Classes/Validation/Field/AbstractFieldValidator.php index 654a117..9024e20 100644 --- a/Classes/Validation/Validator/AbstractValidator.php +++ b/Classes/Validation/Field/AbstractFieldValidator.php @@ -11,7 +11,7 @@ * http://www.gnu.org/licenses/gpl-3.0.html */ -namespace Romm\Formz\Validation\Validator; +namespace Romm\Formz\Validation\Field; use Romm\Formz\Error\Error; use Romm\Formz\Error\Notice; @@ -20,9 +20,10 @@ use Romm\Formz\Form\FormInterface; use Romm\Formz\Service\MessageService; use Romm\Formz\Service\ValidatorService; -use Romm\Formz\Validation\DataObject\ValidatorDataObject; +use Romm\Formz\Validation\Field\DataObject\ValidatorDataObject; +use TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator; -abstract class AbstractValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator +abstract class AbstractFieldValidator extends AbstractValidator { /** diff --git a/Classes/Validation/DataObject/ValidatorDataObject.php b/Classes/Validation/Field/DataObject/ValidatorDataObject.php similarity index 95% rename from Classes/Validation/DataObject/ValidatorDataObject.php rename to Classes/Validation/Field/DataObject/ValidatorDataObject.php index 706dfb9..01ceae6 100644 --- a/Classes/Validation/DataObject/ValidatorDataObject.php +++ b/Classes/Validation/Field/DataObject/ValidatorDataObject.php @@ -11,7 +11,7 @@ * http://www.gnu.org/licenses/gpl-3.0.html */ -namespace Romm\Formz\Validation\DataObject; +namespace Romm\Formz\Validation\Field\DataObject; use Romm\Formz\Form\Definition\Field\Validation\Validator; use Romm\Formz\Form\FormObject\FormObject; diff --git a/Classes/Validation/Validator/BetweenNumbersValidator.php b/Classes/Validation/Validator/BetweenNumbersValidator.php index 3b15739..dd3bf38 100644 --- a/Classes/Validation/Validator/BetweenNumbersValidator.php +++ b/Classes/Validation/Validator/BetweenNumbersValidator.php @@ -13,9 +13,10 @@ namespace Romm\Formz\Validation\Validator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\Utility\MathUtility; -class BetweenNumbersValidator extends AbstractValidator +class BetweenNumbersValidator extends AbstractFieldValidator { const OPTION_MINIMUM = 'minimum'; const OPTION_MAXIMUM = 'maximum'; diff --git a/Classes/Validation/Validator/ContainsValuesValidator.php b/Classes/Validation/Validator/ContainsValuesValidator.php index e2a2a16..6b5a4c5 100644 --- a/Classes/Validation/Validator/ContainsValuesValidator.php +++ b/Classes/Validation/Validator/ContainsValuesValidator.php @@ -13,9 +13,10 @@ namespace Romm\Formz\Validation\Validator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\Utility\GeneralUtility; -class ContainsValuesValidator extends AbstractValidator +class ContainsValuesValidator extends AbstractFieldValidator { const OPTION_VALUES = 'values'; diff --git a/Classes/Validation/Validator/EmailValidator.php b/Classes/Validation/Validator/EmailValidator.php index 1d92d3e..35acbf3 100644 --- a/Classes/Validation/Validator/EmailValidator.php +++ b/Classes/Validation/Validator/EmailValidator.php @@ -13,9 +13,10 @@ namespace Romm\Formz\Validation\Validator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\Utility\GeneralUtility; -class EmailValidator extends AbstractValidator +class EmailValidator extends AbstractFieldValidator { const MESSAGE_DEFAULT = 'default'; diff --git a/Classes/Validation/Validator/EqualsToFieldValidator.php b/Classes/Validation/Validator/EqualsToFieldValidator.php index bdc83c5..2f70cc6 100644 --- a/Classes/Validation/Validator/EqualsToFieldValidator.php +++ b/Classes/Validation/Validator/EqualsToFieldValidator.php @@ -14,9 +14,10 @@ namespace Romm\Formz\Validation\Validator; use Romm\Formz\Exceptions\EntryNotFoundException; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Extbase\Reflection\ObjectAccess; -class EqualsToFieldValidator extends AbstractValidator +class EqualsToFieldValidator extends AbstractFieldValidator { const OPTION_FIELD = 'field'; diff --git a/Classes/Validation/Validator/Form/FormValidatorExecutor.php b/Classes/Validation/Validator/Form/FormValidatorExecutor.php index 4733c4b..13eb4c8 100644 --- a/Classes/Validation/Validator/Form/FormValidatorExecutor.php +++ b/Classes/Validation/Validator/Form/FormValidatorExecutor.php @@ -23,8 +23,8 @@ use Romm\Formz\Form\Definition\Field\Validation\Validator; use Romm\Formz\Form\FormObject\FormObject; use Romm\Formz\Service\MessageService; -use Romm\Formz\Validation\DataObject\ValidatorDataObject; -use Romm\Formz\Validation\Validator\AbstractValidator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; +use Romm\Formz\Validation\Field\DataObject\ValidatorDataObject; use TYPO3\CMS\Core\Utility\GeneralUtility; use TYPO3\CMS\Extbase\Error\Result; use TYPO3\CMS\Extbase\Reflection\ObjectAccess; @@ -222,7 +222,7 @@ protected function processFieldValidator(Field $field, Validator $validator) $validatorResult = $validatorInstance->validate($fieldValue); $validatorResult = MessageService::get()->sanitizeValidatorResult($validatorResult, $validator->getName()); - if ($validatorInstance instanceof AbstractValidator + if ($validatorInstance instanceof AbstractFieldValidator && false === empty($validationData = $validatorInstance->getValidationData()) ) { $this->validationData[$fieldName] = ($this->validationData[$fieldName]) ?: []; diff --git a/Classes/Validation/Validator/IsIntegerValidator.php b/Classes/Validation/Validator/IsIntegerValidator.php index 04ea581..4da0a11 100644 --- a/Classes/Validation/Validator/IsIntegerValidator.php +++ b/Classes/Validation/Validator/IsIntegerValidator.php @@ -13,9 +13,10 @@ namespace Romm\Formz\Validation\Validator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\Utility\MathUtility; -class IsIntegerValidator extends AbstractValidator +class IsIntegerValidator extends AbstractFieldValidator { const MESSAGE_DEFAULT = 'default'; diff --git a/Classes/Validation/Validator/NumberLengthValidator.php b/Classes/Validation/Validator/NumberLengthValidator.php index 274272c..19585a7 100644 --- a/Classes/Validation/Validator/NumberLengthValidator.php +++ b/Classes/Validation/Validator/NumberLengthValidator.php @@ -13,9 +13,10 @@ namespace Romm\Formz\Validation\Validator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; use TYPO3\CMS\Core\Utility\MathUtility; -class NumberLengthValidator extends AbstractValidator +class NumberLengthValidator extends AbstractFieldValidator { const OPTION_MINIMUM = 'minimum'; const OPTION_MAXIMUM = 'maximum'; diff --git a/Classes/Validation/Validator/RegexValidator.php b/Classes/Validation/Validator/RegexValidator.php index deee9b3..b59138a 100644 --- a/Classes/Validation/Validator/RegexValidator.php +++ b/Classes/Validation/Validator/RegexValidator.php @@ -13,7 +13,9 @@ namespace Romm\Formz\Validation\Validator; -class RegexValidator extends AbstractValidator +use Romm\Formz\Validation\Field\AbstractFieldValidator; + +class RegexValidator extends AbstractFieldValidator { const MESSAGE_DEFAULT = 'default'; diff --git a/Classes/Validation/Validator/RequiredValidator.php b/Classes/Validation/Validator/RequiredValidator.php index 9b9d4f8..c88898e 100644 --- a/Classes/Validation/Validator/RequiredValidator.php +++ b/Classes/Validation/Validator/RequiredValidator.php @@ -13,7 +13,9 @@ namespace Romm\Formz\Validation\Validator; -class RequiredValidator extends AbstractValidator +use Romm\Formz\Validation\Field\AbstractFieldValidator; + +class RequiredValidator extends AbstractFieldValidator { const MESSAGE_DEFAULT = 'default'; diff --git a/Classes/Validation/Validator/StringLengthValidator.php b/Classes/Validation/Validator/StringLengthValidator.php index db4f996..5508e3a 100644 --- a/Classes/Validation/Validator/StringLengthValidator.php +++ b/Classes/Validation/Validator/StringLengthValidator.php @@ -13,7 +13,9 @@ namespace Romm\Formz\Validation\Validator; -class StringLengthValidator extends AbstractValidator +use Romm\Formz\Validation\Field\AbstractFieldValidator; + +class StringLengthValidator extends AbstractFieldValidator { const OPTION_MINIMUM = 'minimum'; const OPTION_MAXIMUM = 'maximum'; diff --git a/Documentation/04-DeveloperManual/PHP/Index.rst b/Documentation/04-DeveloperManual/PHP/Index.rst index 0f166b0..c31ceba 100644 --- a/Documentation/04-DeveloperManual/PHP/Index.rst +++ b/Documentation/04-DeveloperManual/PHP/Index.rst @@ -21,7 +21,7 @@ To create a form, you will have to use the following classes: - :ref:`developerManual-php-validator` - :php:`Romm\Formz\Validation\Validator\AbstractValidator` — must be inherited by your validators. + :php:`Romm\Formz\Validation\Field\AbstractFieldValidator` — must be inherited by your validators. - :ref:`developerManual-php-behaviour` diff --git a/Documentation/04-DeveloperManual/PHP/Validator.rst b/Documentation/04-DeveloperManual/PHP/Validator.rst index 23c2c29..490850a 100644 --- a/Documentation/04-DeveloperManual/PHP/Validator.rst +++ b/Documentation/04-DeveloperManual/PHP/Validator.rst @@ -9,7 +9,7 @@ Validators are used to check the values of the fields submitted with a form. The To configure the usable validators in the forms configuration, read the chapter “:ref:`usersManual-typoScript-configurationValidators`”. -You have the possibility to create your own validators depending on your needs; make sure that they inherit ``Romm\Formz\Validation\Validator\AbstractValidator``, and use correctly the functions from the API. +You have the possibility to create your own validators depending on your needs; make sure that they inherit ``Romm\Formz\Validation\Field\AbstractFieldValidator``, and use correctly the functions from the API. API ^^^ @@ -214,7 +214,7 @@ You can find below a validator example. 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]) diff --git a/Tests/Unit/Validation/Validator/AbstractValidatorTest.php b/Tests/Unit/Validation/Validator/AbstractValidatorTest.php index 6a71ae6..685236a 100644 --- a/Tests/Unit/Validation/Validator/AbstractValidatorTest.php +++ b/Tests/Unit/Validation/Validator/AbstractValidatorTest.php @@ -6,7 +6,7 @@ use Romm\Formz\Tests\Fixture\Form\DefaultForm; use Romm\Formz\Tests\Fixture\Validation\Validator\DummyValidator; use Romm\Formz\Tests\Unit\AbstractUnitTest; -use Romm\Formz\Validation\DataObject\ValidatorDataObject; +use Romm\Formz\Validation\Field\DataObject\ValidatorDataObject; use TYPO3\CMS\Extbase\Error\Result; class AbstractValidatorTest extends AbstractUnitTest diff --git a/Tests/Unit/Validation/Validator/AbstractValidatorUnitTest.php b/Tests/Unit/Validation/Validator/AbstractValidatorUnitTest.php index f5dba90..ed4f601 100644 --- a/Tests/Unit/Validation/Validator/AbstractValidatorUnitTest.php +++ b/Tests/Unit/Validation/Validator/AbstractValidatorUnitTest.php @@ -7,8 +7,8 @@ use Romm\Formz\Tests\Fixture\Form\DefaultForm; use Romm\Formz\Tests\Fixture\Validation\Validator\DummyValidator; use Romm\Formz\Tests\Unit\AbstractUnitTest; -use Romm\Formz\Validation\DataObject\ValidatorDataObject; -use Romm\Formz\Validation\Validator\AbstractValidator; +use Romm\Formz\Validation\Field\AbstractFieldValidator; +use Romm\Formz\Validation\Field\DataObject\ValidatorDataObject; use TYPO3\CMS\Extbase\Error\Result; abstract class AbstractValidatorUnitTest extends AbstractUnitTest @@ -64,7 +64,7 @@ protected function validateValidator($value, array $options, array $errors = [], * @param string $className * @param array $options * @param array $methods - * @return \PHPUnit_Framework_MockObject_MockObject|AbstractValidator + * @return \PHPUnit_Framework_MockObject_MockObject|AbstractFieldValidator */ protected function getValidatorInstance($className, array $options = [], array $methods = []) { diff --git a/Tests/Unit/Validation/Validator/DataObject/ValidatorDataObjectTest.php b/Tests/Unit/Validation/Validator/DataObject/ValidatorDataObjectTest.php index 85cb2f5..5038844 100644 --- a/Tests/Unit/Validation/Validator/DataObject/ValidatorDataObjectTest.php +++ b/Tests/Unit/Validation/Validator/DataObject/ValidatorDataObjectTest.php @@ -5,7 +5,7 @@ use Romm\Formz\Form\FormObject\FormObject; use Romm\Formz\Tests\Fixture\Validation\Validator\DummyValidator; use Romm\Formz\Tests\Unit\AbstractUnitTest; -use Romm\Formz\Validation\DataObject\ValidatorDataObject; +use Romm\Formz\Validation\Field\DataObject\ValidatorDataObject; class ValidatorDataObjectTest extends AbstractUnitTest {