You are here

class UserRNGSelection in RNG - Events and Registrations 3.x

Same name and namespace in other branches
  1. 8.2 src/Plugin/EntityReferenceSelection/UserRNGSelection.php \Drupal\rng\Plugin\EntityReferenceSelection\UserRNGSelection
  2. 8 src/Plugin/EntityReferenceSelection/UserRNGSelection.php \Drupal\rng\Plugin\EntityReferenceSelection\UserRNGSelection

Provides selection for user entities when registering.

Plugin annotation


@EntityReferenceSelection(
  id = "rng:register:user",
  label = @Translation("User selection"),
  entity_types = {"user"},
  group = "rng_register",
  weight = 10
)

Hierarchy

Expanded class hierarchy of UserRNGSelection

File

src/Plugin/EntityReferenceSelection/UserRNGSelection.php, line 19

Namespace

Drupal\rng\Plugin\EntityReferenceSelection
View source
class UserRNGSelection extends RNGSelectionBase {
  use RuleGrantsOperationTrait;

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery($match = NULL, $match_operator = 'CONTAINS') {
    $query = parent::buildEntityQuery($match, $match_operator);

    // User entity.
    if (isset($match)) {
      $query
        ->condition('name', $match, $match_operator);
    }

    // Only show un-blocked users.
    $query
      ->condition('status', 1);

    // Remove anonymous user:
    $query
      ->condition($this->entityType
      ->getKey('id'), '0', '<>');

    // Event access rules.
    $condition_count = 0;
    $rules = $this->eventMeta
      ->getRules('rng_event.register', TRUE);
    foreach ($rules as $rule) {
      if ($this
        ->ruleGrantsOperation($rule, 'create')) {
        foreach ($rule
          ->getConditions() as $condition_storage) {

          // Do not use condition if it cannot alter query.
          $condition = $condition_storage
            ->createInstance();
          if ($condition instanceof RNGConditionInterface) {
            $condition_count++;
            $condition
              ->alterQuery($query);
          }
        }
      }
    }

    // Cancel the query if there are no conditions.
    if (!$condition_count) {
      $query
        ->condition($this->entityType
        ->getKey('id'), NULL, 'IS NULL');
      return $query;
    }

    // Apply proxy registration permissions for the current user.
    $proxy_count = 0;

    // If user can register `authenticated` users:
    $all_users = FALSE;
    $group = $query
      ->orConditionGroup();

    // Self.
    if ($this->currentUser
      ->isAuthenticated()) {
      if ($this->currentUser
        ->hasPermission('rng register self')) {
        $proxy_count++;
        $group
          ->condition($this->entityType
          ->getKey('id'), $this->currentUser
          ->id(), '=');
      }
    }
    foreach (user_roles(TRUE) as $role) {
      $role_id = $role
        ->id();
      if ($this->currentUser
        ->hasPermission("rng register role {$role_id}")) {
        if ($role_id == 'authenticated') {
          $all_users = TRUE;
          break;
        }
        else {
          $proxy_count++;
          $group
            ->condition('roles', $role_id, '=');
        }
      }
    }
    if ($all_users) {

      // Do not add any conditions.
    }
    elseif ($proxy_count) {
      $query
        ->condition($group);
    }
    else {

      // Cancel the query:
      $query
        ->condition($this->entityType
        ->getKey('id'), NULL, 'IS NULL');
    }
    return $query;
  }

}

Members

Namesort descending 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::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
RuleGrantsOperationTrait::ruleGrantsOperation protected function Checks if any operation actions on a rule grant $operation access.
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.
UserRNGSelection::buildEntityQuery protected function Builds an EntityQuery to get referenceable entities. Overrides RNGSelectionBase::buildEntityQuery