EntityReferenceSupportedNewEntitiesConstraintValidator.php

Same filename and directory in other branches
  1. 9 core/modules/workspaces/src/Plugin/Validation/Constraint/EntityReferenceSupportedNewEntitiesConstraintValidator.php
  2. 8.9.x core/modules/workspaces/src/Plugin/Validation/Constraint/EntityReferenceSupportedNewEntitiesConstraintValidator.php
  3. 10 core/modules/workspaces/src/Plugin/Validation/Constraint/EntityReferenceSupportedNewEntitiesConstraintValidator.php

Namespace

Drupal\workspaces\Plugin\Validation\Constraint

File

core/modules/workspaces/src/Plugin/Validation/Constraint/EntityReferenceSupportedNewEntitiesConstraintValidator.php

View source
<?php

namespace Drupal\workspaces\Plugin\Validation\Constraint;

use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\workspaces\WorkspaceInformationInterface;
use Drupal\workspaces\WorkspaceManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

/**
 * Checks if new entities created for entity reference fields are supported.
 */
class EntityReferenceSupportedNewEntitiesConstraintValidator extends ConstraintValidator implements ContainerInjectionInterface {
    
    /**
     * The workspace manager.
     *
     * @var \Drupal\workspaces\WorkspaceManagerInterface
     */
    protected $workspaceManager;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The workspace information service.
     *
     * @var \Drupal\workspaces\WorkspaceInformationInterface
     */
    protected $workspaceInfo;
    
    /**
     * Creates a new EntityReferenceSupportedNewEntitiesConstraintValidator instance.
     */
    public function __construct(WorkspaceManagerInterface $workspaceManager, EntityTypeManagerInterface $entityTypeManager, WorkspaceInformationInterface $workspace_information) {
        $this->workspaceManager = $workspaceManager;
        $this->entityTypeManager = $entityTypeManager;
        $this->workspaceInfo = $workspace_information;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('workspaces.manager'), $container->get('entity_type.manager'), $container->get('workspaces.information'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate($value, Constraint $constraint) : void {
        // The validator should run only if we are in a active workspace context.
        if (!$this->workspaceManager
            ->hasActiveWorkspace()) {
            return;
        }
        $target_entity_type_id = $value->getFieldDefinition()
            ->getFieldStorageDefinition()
            ->getSetting('target_type');
        $target_entity_type = $this->entityTypeManager
            ->getDefinition($target_entity_type_id);
        if ($value->hasNewEntity() && !$this->workspaceInfo
            ->isEntityTypeSupported($target_entity_type)) {
            $this->context
                ->addViolation($constraint->message, [
                '%collection_label' => $target_entity_type->getCollectionLabel(),
            ]);
        }
    }

}

Classes

Title Deprecated Summary
EntityReferenceSupportedNewEntitiesConstraintValidator Checks if new entities created for entity reference fields are supported.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.