class RNGSelectionBase in RNG - Events and Registrations 3.x

Base RNG selection plugin.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase implements ConfigurableInterface, DependentPluginInterface, SelectionInterface
      • class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection implements SelectionWithAutocreateInterface, ContainerFactoryPluginInterface
        • class \Drupal\rng\Plugin\EntityReferenceSelection\RNGSelectionBase

File

src/Plugin/EntityReferenceSelection/RNGSelectionBase.php, line 21

Namespace

Drupal\rng\Plugin\EntityReferenceSelection

class RNGSelectionBase extends DefaultSelection {

  /**
   * The condition plugin manager.
   *
   * @var \Drupal\Core\Condition\ConditionManager
   */
  protected $conditionManager;

  /**
   * @var \Drupal\Core\Entity\EntityTypeInterface|null
   */
  protected $entityType;

  /**
   * @var \Drupal\rng\EventMetaInterface|null
   */
  protected $eventMeta;

  /**
   * Constructs a new RegisterIdentityContactSelection object.
   *
   * {@inheritdoc}
   *
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   * @param \Drupal\Core\Condition\ConditionManager $condition_manager
   *   The condition plugin manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, AccountInterface $current_user, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, EntityRepositoryInterface $entity_repository, EventManagerInterface $event_manager, ConditionManager $condition_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $module_handler, $current_user, $entity_field_manager, $entity_type_bundle_info, $entity_repository);
    if (isset($this->configuration['handler_settings']['event_entity_type'], $this->configuration['handler_settings']['event_entity_id'])) {
      $event = $this->entityTypeManager
        ->getStorage($this->configuration['handler_settings']['event_entity_type'])
        ->load($this->configuration['handler_settings']['event_entity_id']);
      $this->eventMeta = $event_manager
        ->getMeta($event);
    }
    else {
      throw new \Exception('RNG selection handler requires event context.');
    }
    $this->conditionManager = $condition_manager;
    $this->entityType = $this->entityTypeManager
      ->getDefinition($this->configuration['target_type']);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('module_handler'), $container
      ->get('current_user'), $container
      ->get('entity_field.manager'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('entity.repository'), $container
      ->get('rng.event_manager'), $container
      ->get('plugin.manager.condition'));
  }

  /**
   * Removes existing registered identities from the query.
   *
   * @param \Drupal\Core\Entity\Query\QueryInterface $query
   *   The entity query to modify.
   */
  protected function removeDuplicateRegistrants(QueryInterface &$query) {
    if (!$this->eventMeta
      ->duplicateRegistrantsAllowed()) {
      $entity_ids = [];
      $registrants = $this->eventMeta
        ->getRegistrants($this->entityType
        ->id());
      foreach ($registrants as $registrant) {
        $entity_ids[] = $registrant
          ->getIdentityId()['entity_id'];
      }
      if ($entity_ids) {
        $query
          ->condition($this->entityType
          ->getKey('id'), $entity_ids, 'NOT IN');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery($match = NULL, $match_operator = 'CONTAINS') {
    $query = parent::buildEntityQuery($match, $match_operator);
    $query
      ->addTag('rng_register');
    $this
      ->removeDuplicateRegistrants($query);
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultSelection::$currentUser	protected	property	The current user.
DefaultSelection::$entityFieldManager	protected	property	The entity field manager service.
DefaultSelection::$entityRepository	protected	property	The entity repository.
DefaultSelection::$entityTypeBundleInfo	public	property	Entity type bundle info service.
DefaultSelection::$entityTypeManager	protected	property	The entity type manager service.
DefaultSelection::$moduleHandler	protected	property	The module handler service.
DefaultSelection::buildConfigurationForm	public	function	Form constructor. Overrides SelectionPluginBase::buildConfigurationForm	3
DefaultSelection::countReferenceableEntities	public	function	Counts entities that are referenceable. Overrides SelectionInterface::countReferenceableEntities	2
DefaultSelection::createNewEntity	public	function	Creates a new entity object that can be used as a valid reference. Overrides SelectionWithAutocreateInterface::createNewEntity	6
DefaultSelection::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides SelectionPluginBase::defaultConfiguration	3
DefaultSelection::elementValidateFilter	public static	function	Form element validation handler; Filters the #value property of an element.
DefaultSelection::getReferenceableEntities	public	function	Gets the list of referenceable entities. Overrides SelectionInterface::getReferenceableEntities	3
DefaultSelection::reAlterQuery	protected	function	Helper method: Passes a query to the alteration system again.
DefaultSelection::validateConfigurationForm	public	function	Form validation handler. Overrides SelectionPluginBase::validateConfigurationForm
DefaultSelection::validateReferenceableEntities	public	function	Validates which existing entities can be referenced. Overrides SelectionInterface::validateReferenceableEntities
DefaultSelection::validateReferenceableNewEntities	public	function	Validates which newly created entities can be referenced. Overrides SelectionWithAutocreateInterface::validateReferenceableNewEntities	6
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RNGSelectionBase::$conditionManager	protected	property	The condition plugin manager.
RNGSelectionBase::$entityType	protected	property
RNGSelectionBase::$eventMeta	protected	property
RNGSelectionBase::buildEntityQuery	protected	function	Builds an EntityQuery to get referenceable entities. Overrides DefaultSelection::buildEntityQuery	1
RNGSelectionBase::create	public static	function	Creates an instance of the plugin. Overrides DefaultSelection::create
RNGSelectionBase::removeDuplicateRegistrants	protected	function	Removes existing registered identities from the query.
RNGSelectionBase::__construct	public	function	Constructs a new RegisterIdentityContactSelection object. Overrides DefaultSelection::__construct
SelectionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SelectionPluginBase::entityQueryAlter	public	function	Allows the selection to alter the SelectQuery generated by EntityFieldQuery. Overrides SelectionInterface::entityQueryAlter	2
SelectionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SelectionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SelectionPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.