3 namespace Drupal\Core\Entity\Plugin\Validation\Constraint;
5 use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
6 use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface;
7 use Drupal\Core\Entity\EntityReferenceSelection\SelectionWithAutocreateInterface;
8 use Drupal\Core\Entity\EntityTypeManagerInterface;
9 use Symfony\Component\DependencyInjection\ContainerInterface;
10 use Symfony\Component\Validator\Constraint;
11 use Symfony\Component\Validator\ConstraintValidator;
14 * Checks if referenced entities are valid.
16 class ValidReferenceConstraintValidator extends ConstraintValidator implements ContainerInjectionInterface {
19 * The selection plugin manager.
21 * @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface
23 protected $selectionManager;
26 * The entity type manager.
28 * @var \Drupal\Core\Entity\EntityTypeManagerInterface
30 protected $entityTypeManager;
33 * Constructs a ValidReferenceConstraintValidator object.
35 * @param \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface $selection_manager
36 * The selection plugin manager.
37 * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
38 * The entity type manager.
40 public function __construct(SelectionPluginManagerInterface $selection_manager, EntityTypeManagerInterface $entity_type_manager) {
41 $this->selectionManager = $selection_manager;
42 $this->entityTypeManager = $entity_type_manager;
48 public static function create(ContainerInterface $container) {
50 $container->get('plugin.manager.entity_reference_selection'),
51 $container->get('entity_type.manager')
58 public function validate($value, Constraint $constraint) {
59 /** @var \Drupal\Core\Field\FieldItemListInterface $value */
60 /** @var ValidReferenceConstraint $constraint */
65 // Collect new entities and IDs of existing entities across the field items.
68 foreach ($value as $delta => $item) {
69 $target_id = $item->target_id;
70 // We don't use a regular NotNull constraint for the target_id property as
71 // NULL is allowed if the entity property contains an unsaved entity.
72 // @see \Drupal\Core\TypedData\DataReferenceTargetDefinition::getConstraints()
73 if (!$item->isEmpty() && $target_id === NULL) {
74 if (!$item->entity->isNew()) {
75 $this->context->buildViolation($constraint->nullMessage)
76 ->atPath((string) $delta)
80 $new_entities[$delta] = $item->entity;
83 // '0' or NULL are considered valid empty references.
84 if (!empty($target_id)) {
85 $target_ids[$delta] = $target_id;
89 // Early opt-out if nothing to validate.
90 if (!$new_entities && !$target_ids) {
94 /** @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $handler * */
95 $handler = $this->selectionManager->getSelectionHandler($value->getFieldDefinition());
96 $target_type_id = $value->getFieldDefinition()->getSetting('target_type');
98 // Add violations on deltas with a new entity that is not valid.
100 if ($handler instanceof SelectionWithAutocreateInterface) {
101 $valid_new_entities = $handler->validateReferenceableNewEntities($new_entities);
102 $invalid_new_entities = array_diff_key($new_entities, $valid_new_entities);
105 // If the selection handler does not support referencing newly created
106 // entities, all of them should be invalidated.
107 $invalid_new_entities = $new_entities;
110 foreach ($invalid_new_entities as $delta => $entity) {
111 $this->context->buildViolation($constraint->invalidAutocreateMessage)
112 ->setParameter('%type', $target_type_id)
113 ->setParameter('%label', $entity->label())
114 ->atPath((string) $delta . '.entity')
115 ->setInvalidValue($entity)
120 // Add violations on deltas with a target_id that is not valid.
122 $valid_target_ids = $handler->validateReferenceableEntities($target_ids);
123 if ($invalid_target_ids = array_diff($target_ids, $valid_target_ids)) {
124 // For accuracy of the error message, differentiate non-referenceable
125 // and non-existent entities.
126 $target_type = $this->entityTypeManager->getDefinition($target_type_id);
127 $existing_ids = $this->entityTypeManager->getStorage($target_type_id)->getQuery()
128 ->condition($target_type->getKey('id'), $invalid_target_ids, 'IN')
130 foreach ($invalid_target_ids as $delta => $target_id) {
131 $message = in_array($target_id, $existing_ids) ? $constraint->message : $constraint->nonExistingMessage;
132 $this->context->buildViolation($message)
133 ->setParameter('%type', $target_type_id)
134 ->setParameter('%id', $target_id)
135 ->atPath((string) $delta . '.target_id')
136 ->setInvalidValue($target_id)