RecursiveValidator.php 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <?php
  2. namespace Drupal\Core\TypedData\Validation;
  3. use Drupal\Core\TypedData\TypedDataInterface;
  4. use Drupal\Core\TypedData\TypedDataManagerInterface;
  5. use Symfony\Component\Validator\ConstraintValidatorFactoryInterface;
  6. use Symfony\Component\Validator\Context\ExecutionContextFactoryInterface;
  7. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  8. use Symfony\Component\Validator\Validator\ValidatorInterface;
  9. /**
  10. * Defines a recursive validator for Typed Data.
  11. *
  12. * The difference to \Symfony\Component\Validator\Validator\RecursiveValidator
  13. * is that we just allow to validate typed data objects.
  14. */
  15. class RecursiveValidator implements ValidatorInterface {
  16. /**
  17. * @var \Symfony\Component\Validator\Context\ExecutionContextFactoryInterface
  18. */
  19. protected $contextFactory;
  20. /**
  21. * @var \Symfony\Component\Validator\ConstraintValidatorFactoryInterface
  22. */
  23. protected $constraintValidatorFactory;
  24. /**
  25. * @var \Drupal\Core\TypedData\TypedDataManager
  26. */
  27. protected $typedDataManager;
  28. /**
  29. * Creates a new validator.
  30. *
  31. * @param \Symfony\Component\Validator\Context\ExecutionContextFactoryInterface $context_factory
  32. * The factory for creating new contexts.
  33. * @param \Symfony\Component\Validator\ConstraintValidatorFactoryInterface $validator_factory
  34. * The constraint validator factory.
  35. * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
  36. * The typed data manager.
  37. */
  38. public function __construct(ExecutionContextFactoryInterface $context_factory, ConstraintValidatorFactoryInterface $validator_factory, TypedDataManagerInterface $typed_data_manager) {
  39. $this->contextFactory = $context_factory;
  40. $this->constraintValidatorFactory = $validator_factory;
  41. $this->typedDataManager = $typed_data_manager;
  42. }
  43. /**
  44. * {@inheritdoc}
  45. */
  46. public function startContext($root = NULL) {
  47. return new RecursiveContextualValidator($this->contextFactory->createContext($this, $root), $this, $this->constraintValidatorFactory, $this->typedDataManager);
  48. }
  49. /**
  50. * {@inheritdoc}
  51. */
  52. public function inContext(ExecutionContextInterface $context) {
  53. return new RecursiveContextualValidator($context, $this, $this->constraintValidatorFactory, $this->typedDataManager);
  54. }
  55. /**
  56. * {@inheritdoc}
  57. *
  58. * @param \Drupal\Core\TypedData\TypedDataInterface $typed_data
  59. * A typed data object containing the value to validate.
  60. */
  61. public function getMetadataFor($typed_data) {
  62. if (!$typed_data instanceof TypedDataInterface) {
  63. throw new \InvalidArgumentException('The passed value must be a typed data object.');
  64. }
  65. return new TypedDataMetadata($typed_data);
  66. }
  67. /**
  68. * {@inheritdoc}
  69. */
  70. public function hasMetadataFor($value) {
  71. return $value instanceof TypedDataInterface;
  72. }
  73. /**
  74. * {@inheritdoc}
  75. */
  76. public function validate($value, $constraints = NULL, $groups = NULL) {
  77. return $this->startContext($value)
  78. ->validate($value, $constraints, $groups)
  79. ->getViolations();
  80. }
  81. /**
  82. * {@inheritdoc}
  83. */
  84. public function validateProperty($object, $propertyName, $groups = NULL) {
  85. return $this->startContext($object)
  86. ->validateProperty($object, $propertyName, $groups)
  87. ->getViolations();
  88. }
  89. /**
  90. * {@inheritdoc}
  91. */
  92. public function validatePropertyValue($objectOrClass, $propertyName, $value, $groups = NULL) {
  93. // Just passing a class name is not supported.
  94. if (!is_object($objectOrClass)) {
  95. throw new \LogicException('Typed data validation does not support passing the class name only.');
  96. }
  97. return $this->startContext($objectOrClass)
  98. ->validatePropertyValue($objectOrClass, $propertyName, $value, $groups)
  99. ->getViolations();
  100. }
  101. }