Adjust Neos.Flow Validation subcontext

Bernhard Schmitt · mficzel · commit 25d723e47a7f · 2025-10-27T16:20:21.000+01:00
diff --git a/Neos.Flow/Classes/Validation/Validator/AbstractCompositeValidator.php b/Neos.Flow/Classes/Validation/Validator/AbstractCompositeValidator.php
@@ -24,29 +24,29 @@ abstract class AbstractCompositeValidator implements ObjectValidatorInterface, \
     /**
      * This contains the supported options, their default values and descriptions.
      *
-     * @var array
+     * @var array<mixed>
      */
     protected $supportedOptions = [];
 
     /**
-     * @var array
+     * @var array<mixed>
      */
     protected $options = [];
 
     /**
-     * @var \SplObjectStorage
+     * @var \SplObjectStorage<ValidatorInterface,mixed>
      */
     protected $validators;
 
     /**
-     * @var \SplObjectStorage
+     * @var \SplObjectStorage<object,mixed>
      */
     protected $validatedInstancesContainer;
 
     /**
      * Constructs the composite validator and sets validation options
      *
-     * @param array $options Options for the validator
+     * @param array<mixed> $options Options for the validator
      * @api
      * @throws InvalidValidationOptionsException
      */
@@ -84,7 +84,7 @@ function ($value) {
     /**
      * Allows to set a container to keep track of validated instances.
      *
-     * @param \SplObjectStorage $validatedInstancesContainer A container to keep track of validated instances
+     * @param \SplObjectStorage<object,mixed> $validatedInstancesContainer A container to keep track of validated instances
      * @return void
      * @api
      */
@@ -102,7 +102,7 @@ public function setValidatedInstancesContainer(\SplObjectStorage $validatedInsta
      */
     public function addValidator(ValidatorInterface $validator)
     {
-        if ($validator instanceof ObjectValidatorInterface && isset($this->validatedInstancesContainer)) {
+        if ($validator instanceof ObjectValidatorInterface) {
             $validator->setValidatedInstancesContainer($this->validatedInstancesContainer);
         }
         $this->validators->attach($validator);
@@ -115,7 +115,7 @@ public function addValidator(ValidatorInterface $validator)
      * @throws NoSuchValidatorException
      * @api
      */
-    public function removeValidator(ValidatorInterface $validator)
+    public function removeValidator(ValidatorInterface $validator): void
     {
         if (!$this->validators->contains($validator)) {
             throw new NoSuchValidatorException('Cannot remove validator because its not in the conjunction.', 1207020177);
@@ -137,7 +137,7 @@ public function count(): int
     /**
      * Returns the child validators of this Composite Validator
      *
-     * @return \SplObjectStorage
+     * @return \SplObjectStorage<ValidatorInterface,mixed>
      */
     public function getValidators()
     {
@@ -147,7 +147,7 @@ public function getValidators()
     /**
      * Returns the options for this validator
      *
-     * @return array
+     * @return array<mixed>
      */
     public function getOptions()
     {
diff --git a/Neos.Flow/Classes/Validation/Validator/AbstractValidator.php b/Neos.Flow/Classes/Validation/Validator/AbstractValidator.php
@@ -41,17 +41,17 @@ abstract class AbstractValidator implements ValidatorInterface
      * 2 => type
      * 3 => required (boolean, optional)
      *
-     * @var array
+     * @var array<mixed>
      */
     protected $supportedOptions = [];
 
     /**
-     * @var array
+     * @var array<mixed>
      */
     protected $options = [];
 
     /**
-     * @var ErrorResult
+     * @var ErrorResult|null
      */
     private $result;
 
@@ -63,7 +63,7 @@ abstract class AbstractValidator implements ValidatorInterface
     /**
      * Constructs the validator and sets validation options
      *
-     * @param array $options Options for the validator
+     * @param array<mixed> $options Options for the validator
      * @throws InvalidValidationOptionsException if unsupported options are found
      * @api
      */
@@ -117,7 +117,7 @@ protected function pushResult()
     /**
      * Pop and return the current Result from the stack and make $this->result point to the last Result again.
      * @since Flow 4.3
-     * @return ErrorResult
+     * @return ErrorResult|null
      */
     protected function popResult()
     {
@@ -143,7 +143,7 @@ protected function getResult()
      * the Error Messages object which occurred.
      *
      * @param mixed $value The value that should be validated
-     * @return ErrorResult
+     * @return ErrorResult|null
      * @throws InvalidValidationOptionsException
      * @api
      */
@@ -171,19 +171,22 @@ abstract protected function isValid($value);
      *
      * @param string $message The error message
      * @param integer $code The error code (a unix timestamp)
-     * @param array $arguments Arguments to be replaced in message
+     * @param array<mixed> $arguments Arguments to be replaced in message
      * @return void
      * @api
      */
     protected function addError($message, $code, array $arguments = [])
     {
+        if ($this->result === null) {
+            $this->result = new ErrorResult();
+        }
         $this->result->addError(new ValidationError($message, $code, $arguments));
     }
 
     /**
      * Returns the options of this validator
      *
-     * @return array
+     * @return array<mixed>
      */
     public function getOptions()
     {
diff --git a/Neos.Flow/Classes/Validation/Validator/BooleanValueValidator.php b/Neos.Flow/Classes/Validation/Validator/BooleanValueValidator.php
@@ -22,7 +22,7 @@
 class BooleanValueValidator extends AbstractValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'expectedValue' => [true, 'The expected boolean value', 'boolean']
diff --git a/Neos.Flow/Classes/Validation/Validator/CollectionValidator.php b/Neos.Flow/Classes/Validation/Validator/CollectionValidator.php
@@ -22,7 +22,7 @@
 class CollectionValidator extends GenericObjectValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'elementValidator' => [null, 'The validator type to use for the collection elements', 'string'],
@@ -52,7 +52,7 @@ protected function isValid($value)
     {
         if ($value instanceof \Doctrine\Common\Collections\AbstractLazyCollection && !$value->isInitialized()) {
             return;
-        } elseif ((is_object($value) && !TypeHandling::isCollectionType(get_class($value))) && !is_array($value)) {
+        } elseif (is_object($value) && !TypeHandling::isCollectionType(get_class($value))) {
             $this->addError('The given subject was not a collection.', 1317204797);
             return;
         } elseif (is_object($value) && $this->isValidatedAlready($value)) {
@@ -75,7 +75,9 @@ protected function isValid($value)
                 $collectionElementValidator->setValidatedInstancesContainer($this->validatedInstancesContainer);
             }
 
-            $this->getResult()->forProperty($index)->merge($collectionElementValidator->validate($collectionElement));
+            if ($this->getResult() && $collectionElementValidator) {
+                $this->getResult()->forProperty($index)->merge($collectionElementValidator->validate($collectionElement));
+            }
         }
     }
 }
diff --git a/Neos.Flow/Classes/Validation/Validator/ConjunctionValidator.php b/Neos.Flow/Classes/Validation/Validator/ConjunctionValidator.php
@@ -25,7 +25,7 @@ class ConjunctionValidator extends AbstractCompositeValidator
      * Every validator has to be valid, to make the whole conjunction valid.
      *
      * @param mixed $value The value that should be validated
-     * @return ErrorResult
+     * @return ErrorResult|null
      * @api
      */
     public function validate($value)
diff --git a/Neos.Flow/Classes/Validation/Validator/CountValidator.php b/Neos.Flow/Classes/Validation/Validator/CountValidator.php
@@ -20,7 +20,7 @@
 class CountValidator extends AbstractValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'minimum' => [0, 'The minimum count to accept', 'integer'],
diff --git a/Neos.Flow/Classes/Validation/Validator/DateTimeRangeValidator.php b/Neos.Flow/Classes/Validation/Validator/DateTimeRangeValidator.php
@@ -21,7 +21,7 @@
 class DateTimeRangeValidator extends AbstractValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'latestDate' => [null, 'The latest date to accept', 'string'],
diff --git a/Neos.Flow/Classes/Validation/Validator/DateTimeValidator.php b/Neos.Flow/Classes/Validation/Validator/DateTimeValidator.php
@@ -23,7 +23,7 @@
 class DateTimeValidator extends AbstractValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'locale' => [null, 'The locale to use for date parsing', 'string|Locale'],
diff --git a/Neos.Flow/Classes/Validation/Validator/DisjunctionValidator.php b/Neos.Flow/Classes/Validation/Validator/DisjunctionValidator.php
@@ -28,7 +28,7 @@ class DisjunctionValidator extends AbstractCompositeValidator
      * Errors are only returned if all validators failed.
      *
      * @param mixed $value The value that should be validated
-     * @return ErrorResult
+     * @return ErrorResult|null
      * @api
      */
     public function validate($value)
diff --git a/Neos.Flow/Classes/Validation/Validator/EmailAddressValidator.php b/Neos.Flow/Classes/Validation/Validator/EmailAddressValidator.php
@@ -27,7 +27,7 @@
 class EmailAddressValidator extends AbstractValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'strict' => [false, 'Whether to fail validation on RFC warnings', 'bool'],
diff --git a/Neos.Flow/Classes/Validation/Validator/FileExtensionValidator.php b/Neos.Flow/Classes/Validation/Validator/FileExtensionValidator.php
@@ -31,7 +31,7 @@ class FileExtensionValidator extends AbstractValidator
      * 2 => type
      * 3 => required (boolean, optional)
      *
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'allowedExtensions' => [[], 'Array of allowed file extensions', 'array', true]
@@ -58,9 +58,9 @@ protected function isValid($value)
             return;
         }
 
-        $fileExtension =  pathinfo((string)$filename, PATHINFO_EXTENSION);
+        $fileExtension = pathinfo((string)$filename, PATHINFO_EXTENSION);
 
-        if ($fileExtension === null || $fileExtension === '') {
+        if ($fileExtension === '') {
             $this->addError('The file has no file extension.', 1677934932);
             return;
         }
diff --git a/Neos.Flow/Classes/Validation/Validator/FileSizeValidator.php b/Neos.Flow/Classes/Validation/Validator/FileSizeValidator.php
@@ -31,7 +31,7 @@ class FileSizeValidator extends AbstractValidator
      * 2 => type
      * 3 => required (boolean, optional)
      *
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'minimum' => [null, 'Minimum allowed filesize in bytes', 'integer', false],
diff --git a/Neos.Flow/Classes/Validation/Validator/GenericObjectValidator.php b/Neos.Flow/Classes/Validation/Validator/GenericObjectValidator.php
@@ -23,26 +23,26 @@
 class GenericObjectValidator extends AbstractValidator implements ObjectValidatorInterface
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'skipUnInitializedProxies' => [false, 'Whether proxies not yet initialized should be skipped during validation', 'boolean']
     ];
 
     /**
-     * @var array
+     * @var array<string,\SplObjectStorage<ValidatorInterface,mixed>>
      */
     protected $propertyValidators = [];
 
     /**
-     * @var \SplObjectStorage
+     * @var \SplObjectStorage<object,mixed>
      */
     protected $validatedInstancesContainer;
 
     /**
      * Allows to set a container to keep track of validated instances.
      *
-     * @param \SplObjectStorage $validatedInstancesContainer A container to keep track of validated instances
+     * @param \SplObjectStorage<object,mixed> $validatedInstancesContainer A container to keep track of validated instances
      * @return void
      * @api
      */
@@ -77,16 +77,17 @@ protected function isValid($object)
             $propertyValue = $this->getPropertyValue($object, $propertyName);
             $result = $this->checkProperty($propertyValue, $validators);
             if ($result !== null) {
-                $this->getResult()->forProperty($propertyName)->merge($result);
+                if ($this->getResult()) {
+                    $this->getResult()->forProperty($propertyName)->merge($result);
+                }
             }
         }
     }
 
     /**
-     * @param $object
      * @return boolean
      */
-    protected function isUninitializedProxy($object)
+    protected function isUninitializedProxy(object $object)
     {
         return ($object instanceof DoctrineProxy && $object->__isInitialized() === false);
     }
@@ -132,7 +133,7 @@ protected function getPropertyValue($object, $propertyName)
      * found errors to the $messages object.
      *
      * @param mixed $value The value to be validated
-     * @param array $validators The validators to be called on the value
+     * @param array<ValidatorInterface>|\SplObjectStorage<ValidatorInterface,mixed> $validators The validators to be called on the value
      * @return NULL|ErrorResult
      */
     protected function checkProperty($value, $validators)
@@ -162,24 +163,31 @@ protected function checkProperty($value, $validators)
      * @return void
      * @api
      */
-    public function addPropertyValidator($propertyName, ValidatorInterface $validator)
+    public function addPropertyValidator(string $propertyName, ValidatorInterface $validator)
     {
         if (!isset($this->propertyValidators[$propertyName])) {
-            $this->propertyValidators[$propertyName] = new \SplObjectStorage();
+            /** @var \SplObjectStorage<ValidatorInterface,mixed> $storage */
+            $storage = new \SplObjectStorage();
+            $this->propertyValidators[$propertyName] = $storage;
         }
         $this->propertyValidators[$propertyName]->attach($validator);
     }
 
     /**
      * Returns all property validators - or only validators of the specified property
      *
-     * @param string $propertyName Name of the property to return validators for
-     * @return array An array of validators
+     * @param ?string $propertyName Name of the property to return validators for
+     * @return ($propertyName is null ? array<string,\SplObjectStorage<ValidatorInterface,mixed>> : \SplObjectStorage<ValidatorInterface,mixed>)
      */
-    public function getPropertyValidators($propertyName = null)
+    public function getPropertyValidators(?string $propertyName = null)
     {
         if ($propertyName !== null) {
-            return $this->propertyValidators[$propertyName] ?? [];
+            $propertyValidators = $this->propertyValidators[$propertyName] ?? null;
+            if (!$propertyValidators) {
+                /** @var \SplObjectStorage<ValidatorInterface,mixed> $propertyValidators */
+                $propertyValidators = new \SplObjectStorage();
+            }
+            return $propertyValidators;
         }
         return $this->propertyValidators;
     }
diff --git a/Neos.Flow/Classes/Validation/Validator/MediaTypeValidator.php b/Neos.Flow/Classes/Validation/Validator/MediaTypeValidator.php
@@ -32,7 +32,7 @@ class MediaTypeValidator extends AbstractValidator
      * 2 => type
      * 3 => required (boolean, optional)
      *
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'allowedTypes' => [[], 'Array of allowed media ranges', 'array', true],
diff --git a/Neos.Flow/Classes/Validation/Validator/NumberRangeValidator.php b/Neos.Flow/Classes/Validation/Validator/NumberRangeValidator.php
@@ -20,7 +20,7 @@
 class NumberRangeValidator extends AbstractValidator
 {
     /**
-     * @var array
+     * @var array<string,mixed>
      */
     protected $supportedOptions = [
         'minimum' => [0, 'The minimum value to accept', 'integer'],
diff --git a/Neos.Flow/Classes/Validation/Validator/NumberValidator.php b/Neos.Flow/Classes/Validation/Validator/NumberValidator.php
diff --git a/Neos.Flow/Classes/Validation/Validator/ObjectValidatorInterface.php b/Neos.Flow/Classes/Validation/Validator/ObjectValidatorInterface.php
diff --git a/Neos.Flow/Classes/Validation/Validator/RegularExpressionValidator.php b/Neos.Flow/Classes/Validation/Validator/RegularExpressionValidator.php
diff --git a/Neos.Flow/Classes/Validation/Validator/StringLengthValidator.php b/Neos.Flow/Classes/Validation/Validator/StringLengthValidator.php
diff --git a/Neos.Flow/Classes/Validation/Validator/UniqueEntityValidator.php b/Neos.Flow/Classes/Validation/Validator/UniqueEntityValidator.php
diff --git a/Neos.Flow/Classes/Validation/Validator/ValidatorInterface.php b/Neos.Flow/Classes/Validation/Validator/ValidatorInterface.php
diff --git a/Neos.Flow/Classes/Validation/ValidatorResolver.php b/Neos.Flow/Classes/Validation/ValidatorResolver.php

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`class BooleanValueValidator extends AbstractValidator`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`		`- * @var array`
	`25`	`+ * @var array<string,mixed>`
`26`	`26`	`*/`
`27`	`27`	`protected $supportedOptions = [`
`28`	`28`	`'expectedValue' => [true, 'The expected boolean value', 'boolean']`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class ConjunctionValidator extends AbstractCompositeValidator`
`25`	`25`	`* Every validator has to be valid, to make the whole conjunction valid.`
`26`	`26`	`*`
`27`	`27`	`* @param mixed $value The value that should be validated`
`28`		`- * @return ErrorResult`
	`28`	`+ * @return ErrorResult\|null`
`29`	`29`	`* @api`
`30`	`30`	`*/`
`31`	`31`	`public function validate($value)`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`class CountValidator extends AbstractValidator`
`21`	`21`	`{`
`22`	`22`	`/**`
`23`		`- * @var array`
	`23`	`+ * @var array<string,mixed>`
`24`	`24`	`*/`
`25`	`25`	`protected $supportedOptions = [`
`26`	`26`	`'minimum' => [0, 'The minimum count to accept', 'integer'],`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`class DateTimeRangeValidator extends AbstractValidator`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * @var array`
	`24`	`+ * @var array<string,mixed>`
`25`	`25`	`*/`
`26`	`26`	`protected $supportedOptions = [`
`27`	`27`	`'latestDate' => [null, 'The latest date to accept', 'string'],`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`class DateTimeValidator extends AbstractValidator`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`		`- * @var array`
	`26`	`+ * @var array<string,mixed>`
`27`	`27`	`*/`
`28`	`28`	`protected $supportedOptions = [`
`29`	`29`	`'locale' => [null, 'The locale to use for date parsing', 'string\|Locale'],`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class DisjunctionValidator extends AbstractCompositeValidator`
`28`	`28`	`* Errors are only returned if all validators failed.`
`29`	`29`	`*`
`30`	`30`	`* @param mixed $value The value that should be validated`
`31`		`- * @return ErrorResult`
	`31`	`+ * @return ErrorResult\|null`
`32`	`32`	`* @api`
`33`	`33`	`*/`
`34`	`34`	`public function validate($value)`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`class EmailAddressValidator extends AbstractValidator`
`28`	`28`	`{`
`29`	`29`	`/**`
`30`		`- * @var array`
	`30`	`+ * @var array<string,mixed>`
`31`	`31`	`*/`
`32`	`32`	`protected $supportedOptions = [`
`33`	`33`	`'strict' => [false, 'Whether to fail validation on RFC warnings', 'bool'],`