GenericObjectValidator.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Validation\Validator;

class GenericObjectValidator extends AbstractValidator implements ObjectValidatorInterface {

    protected $propertyValidators = array();

    public function validate($value) {
        $this->result = new \TYPO3\CMS\Extbase\Error\Result();
        if ($this->acceptsEmptyValues === FALSE || $this->isEmpty($value) === FALSE) {
            if (!is_object($value)) {
                $this->addError('Object expected, %1$s given.', 1241099149, array(gettype($value)));
            } elseif ($this->isValidatedAlready($value) === FALSE) {
                $this->isValid($value);
            }
        }

        return $this->result;
    }

    protected function getPropertyValue($object, $propertyName) {
        // TODO: add support for lazy loading proxies, if needed
        if (\TYPO3\CMS\Extbase\Reflection\ObjectAccess::isPropertyGettable($object, $propertyName)) {
            return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getProperty($object, $propertyName);
        } else {
            return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getProperty($object, $propertyName, TRUE);
        }
    }

    protected function checkProperty($value, $validators, $propertyName) {
        $result = NULL;
        foreach ($validators as $validator) {
            if ($validator instanceof ObjectValidatorInterface) {
                $validator->setValidatedInstancesContainer($this->validatedInstancesContainer);
            }
            $currentResult = $validator->validate($value);
            if ($currentResult->hasMessages()) {
                if ($result == NULL) {
                    $result = $currentResult;
                } else {
                    $result->merge($currentResult);
                }
            }
        }
        if ($result != NULL) {
            $this->result->forProperty($propertyName)->merge($result);
        }
    }

    public function isValid($object) {
        if ($this->configurationManager->isFeatureEnabled('rewrittenPropertyMapper')) {
            foreach ($this->propertyValidators as $propertyName => $validators) {
                $propertyValue = $this->getPropertyValue($object, $propertyName);
                $this->checkProperty($propertyValue, $validators, $propertyName);
            }

            return;
        } else {
            /* @deprecated since Extbase 1.4.0, will be removed two versions after Extbase 6.1 */
            if (!is_object($object)) {
                $this->addError(
                    $this->translateErrorMessage(
                        'validator.genericobject.noobject',
                        'extbase'
                    ), 1241099148);

                return FALSE;
            }
            $result = TRUE;
            foreach (array_keys($this->propertyValidators) as $propertyName) {
                if ($this->isPropertyValid($object, $propertyName) === FALSE) {
                    $result = FALSE;
                }
            }

            return $result;
        }
    }

    public function canValidate($object) {
        return is_object($object);
    }

    public function isPropertyValid($object, $propertyName) {
        if (!is_object($object)) {
            throw new \InvalidArgumentException('Object expected, ' . gettype($object) . ' given.', 1241099149);
        }
        if (!isset($this->propertyValidators[$propertyName])) {
            return TRUE;
        }
        $result = TRUE;
        foreach ($this->propertyValidators[$propertyName] as $validator) {
            $validator->isValid(\TYPO3\CMS\Extbase\Reflection\ObjectAccess::getProperty($object, $propertyName));
            if (count($validator->getErrors()) > 0) {
                $this->addErrorsForProperty($validator->getErrors(), $propertyName);
                $result = FALSE;
            }
        }
        return $result;
    }

    protected function addErrorsForProperty($errors, $propertyName) {
        if (!isset($this->errors[$propertyName])) {
            $this->errors[$propertyName] = new \TYPO3\CMS\Extbase\Validation\PropertyError($propertyName);
        }
        $this->errors[$propertyName]->addErrors($errors);
    }

    public function addPropertyValidator($propertyName, \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator) {
        if (!isset($this->propertyValidators[$propertyName])) {
            $this->propertyValidators[$propertyName] = new \SplObjectStorage();
        }
        $this->propertyValidators[$propertyName]->attach($validator);
    }

    protected function isValidatedAlready($object) {
        if ($this->validatedInstancesContainer === NULL) {
            $this->validatedInstancesContainer = new \SplObjectStorage();
        }
        if ($this->validatedInstancesContainer->contains($object)) {
            return TRUE;
        } else {
            $this->validatedInstancesContainer->attach($object);

            return FALSE;
        }
    }

    public function getPropertyValidators($propertyName = NULL) {
        if ($propertyName !== NULL) {
            return (isset($this->propertyValidators[$propertyName])) ? $this->propertyValidators[$propertyName] : array();
        } else {
            return $this->propertyValidators;
        }
    }

    protected $configurationManager;

    public function injectConfigurationManager(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager) {
        // @todo: remove configuration manager once the old property mapper is removed
        $this->configurationManager = $configurationManager;
    }

    protected $validatedInstancesContainer;

    public function setValidatedInstancesContainer(\SplObjectStorage $validatedInstancesContainer) {
        $this->validatedInstancesContainer = $validatedInstancesContainer;
    }
}