class GroupContentCardinalityValidator in Group 2.0.x

Checks the amount of times a single content entity can be added to a group.

Hierarchy

• class \Drupal\group\Plugin\Validation\Constraint\GroupContentCardinalityValidator extends \Symfony\Component\Validator\ConstraintValidator implements ContainerInjectionInterface

File

src/Plugin/Validation/Constraint/GroupContentCardinalityValidator.php, line 14

Namespace

Drupal\group\Plugin\Validation\Constraint

class GroupContentCardinalityValidator extends ConstraintValidator implements ContainerInjectionInterface {

  /**
   * Type-hinting in parent Symfony class is off, let's fix that.
   *
   * @var \Symfony\Component\Validator\Context\ExecutionContextInterface
   */
  protected $context;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a GroupContentCardinalityValidator object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function validate($group_content, Constraint $constraint) {

    /** @var \Drupal\group\Entity\GroupContentInterface $group_content */

    /** @var \Drupal\group\Plugin\Validation\Constraint\GroupContentCardinality $constraint */
    if (!isset($group_content)) {
      return;
    }

    // Only run our checks if a group was referenced.
    if (!($group = $group_content
      ->getGroup())) {
      return;
    }

    // Only run our checks if an entity was referenced.
    if (!($entity = $group_content
      ->getEntity())) {
      return;
    }

    // Get the plugin for the group content entity.
    $plugin = $group_content
      ->getRelationPlugin();

    // Get the cardinality settings from the plugin.
    $group_cardinality = $plugin
      ->getGroupCardinality();
    $entity_cardinality = $plugin
      ->getEntityCardinality();

    // Exit early if both cardinalities are set to unlimited.
    if ($group_cardinality <= 0 && $entity_cardinality <= 0) {
      return;
    }

    // Get the entity_id field label for error messages.
    $field_name = $group_content
      ->getFieldDefinition('entity_id')
      ->getLabel();

    // Enforce the group cardinality if it's not set to unlimited.
    if ($group_cardinality > 0) {

      // Get the group content entities for this piece of content.
      $properties = [
        'type' => $plugin
          ->getContentTypeConfigId(),
        'entity_id' => $entity
          ->id(),
      ];
      $group_instances = $this->entityTypeManager
        ->getStorage('group_content')
        ->loadByProperties($properties);

      // Get the groups this content entity already belongs to, not counting
      // the current group towards the limit.
      $group_ids = [];
      foreach ($group_instances as $instance) {

        /** @var \Drupal\group\Entity\GroupContentInterface $instance */
        if ($instance
          ->getGroup()
          ->id() != $group
          ->id()) {
          $group_ids[] = $instance
            ->getGroup()
            ->id();
        }
      }
      $group_count = count(array_unique($group_ids));

      // Raise a violation if the content has reached the cardinality limit.
      if ($group_count >= $group_cardinality) {
        $this->context
          ->buildViolation($constraint->groupMessage)
          ->setParameter('@field', $field_name)
          ->setParameter('%content', $entity
          ->label())
          ->atPath('entity_id.0')
          ->addViolation();
      }
    }

    // Enforce the entity cardinality if it's not set to unlimited.
    if ($entity_cardinality > 0) {

      // Get the current instances of this content entity in the group.
      $entity_instances = $group
        ->getContentByEntityId($plugin
        ->getPluginId(), $entity
        ->id());
      $entity_count = count($entity_instances);

      // If the current group content entity has an ID, exclude that one.
      if ($group_content_id = $group_content
        ->id()) {
        foreach ($entity_instances as $instance) {

          /** @var \Drupal\group\Entity\GroupContentInterface $instance */
          if ($instance
            ->id() == $group_content_id) {
            $entity_count--;
            break;
          }
        }
      }

      // Raise a violation if the content has reached the cardinality limit.
      if ($entity_count >= $entity_cardinality) {
        $this->context
          ->buildViolation($constraint->entityMessage)
          ->setParameter('@field', $field_name)
          ->setParameter('%content', $entity
          ->label())
          ->setParameter('%group', $group
          ->label())
          ->atPath('entity_id.0')
          ->addViolation();
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GroupContentCardinalityValidator::$context	protected	property	Type-hinting in parent Symfony class is off, let's fix that.
GroupContentCardinalityValidator::$entityTypeManager	protected	property	The entity type manager.
GroupContentCardinalityValidator::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
GroupContentCardinalityValidator::validate	public	function
GroupContentCardinalityValidator::__construct	public	function	Constructs a GroupContentCardinalityValidator object.