class UserSelection in Open Social 8.9

Provides specific access control for the user entity type.

Plugin annotation

@EntityReferenceSelection(
  id = "social:user",
  label = @Translation("Social user selection"),
  entity_types = {"user"},
  group = "social",
  weight = 1
)

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, ConfigurablePluginInterface, DependentPluginInterface, SelectionInterface
      • class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection implements SelectionWithAutocreateInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait
        • class \Drupal\user\Plugin\EntityReferenceSelection\UserSelection
          • class \Drupal\social_profile\Plugin\EntityReferenceSelection\UserSelection uses SocialProfileTrait

1 file declares its use of UserSelection

UserSelection.php in modules/social_features/social_private_message/src/Plugin/EntityReferenceSelection/UserSelection.php

File

modules/social_features/social_profile/src/Plugin/EntityReferenceSelection/UserSelection.php, line 19

Namespace

Drupal\social_profile\Plugin\EntityReferenceSelection

class UserSelection extends UserSelectionBase {
  use SocialProfileTrait;

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration['include_anonymous'] = FALSE;
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function validateReferenceableEntities(array $ids) {
    $result = [];
    if ($ids) {
      $target_type = $this->configuration['target_type'];
      $entity_type = $this->entityTypeManager
        ->getDefinition($target_type);
      $query = $this
        ->buildEntityQuery(NULL, 'CONTAINS', $ids);
      $result = $query
        ->condition($entity_type
        ->getKey('id'), $ids, 'IN')
        ->execute();
    }
    return $result;
  }

  /**
   * Builds an EntityQuery to get referenceable entities.
   *
   * @param string|null $match
   *   (Optional) Text to match the label against. Defaults to NULL.
   * @param string $match_operator
   *   (Optional) The operation the matching should be done with. Defaults
   *   to "CONTAINS".
   * @param array $ids
   *   (Optional) $ids that are coming from an earlier request.
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   The EntityQuery object with the basic conditions and sorting applied to
   *   it.
   */
  protected function buildEntityQuery($match = NULL, $match_operator = 'CONTAINS', array $ids = []) {

    // If an earlier request already had the ids don't query them again.
    if (empty($ids)) {
      $config_factory = \Drupal::service('config.factory');
      $config = $config_factory
        ->get('mentions.settings');
      $suggestion_format = $config
        ->get('suggestions_format');
      $suggestion_amount = $config
        ->get('suggestions_amount');
      $ids = $this
        ->getUserIdsFromName($match, $suggestion_amount, $suggestion_format);
    }

    // Add the ability to search users also by mail.
    if (empty($ids) && $this->currentUser
      ->hasPermission('view profile email')) {
      $query = parent::buildEntityQuery(NULL, $match_operator);
      $query
        ->condition('mail', $match, $match_operator);
      $ids = $query
        ->execute();
    }
    if (empty($ids)) {
      return parent::buildEntityQuery($match, $match_operator);
    }
    $query = parent::buildEntityQuery(NULL, $match_operator);
    $query
      ->condition('uid', $ids, 'IN');
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultSelection::$currentUser	protected	property	The current user.
DefaultSelection::$deprecatedProperties	protected	property
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::countReferenceableEntities	public	function	Counts entities that are referenceable. Overrides SelectionInterface::countReferenceableEntities	2
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
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
SelectionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SelectionPluginBase::ensureBackwardCompatibilityConfiguration	protected	function	Ensures a backward compatibility level configuration.
SelectionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SelectionPluginBase::resolveBackwardCompatibilityConfiguration	protected	function	Moves the backward compatibility level configurations in the right place.
SelectionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SelectionPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
SocialProfileTrait::addNickname	private	function	Add Nickname.
SocialProfileTrait::endQuery	private	function	End a Social Profile Mention Query.
SocialProfileTrait::getUserIdsFromName	public	function	Get a list of account IDs whose account names begin with the given string.
SocialProfileTrait::sortQuery	private	function	Sorts the query.
SocialProfileTrait::startQuery	private	function	Start a Social Profile Mention Query.
SocialProfileTrait::useFullName	private	function	Check if can use the full name for the search.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
UserSelection::$connection	protected	property	The database connection.
UserSelection::buildConfigurationForm	public	function	Form constructor. Overrides DefaultSelection::buildConfigurationForm
UserSelection::buildEntityQuery	protected	function	Builds an EntityQuery to get referenceable entities. Overrides UserSelection::buildEntityQuery	1
UserSelection::create	public static	function	Creates an instance of the plugin. Overrides DefaultSelection::create
UserSelection::createNewEntity	public	function	Creates a new entity object that can be used as a valid reference. Overrides DefaultSelection::createNewEntity
UserSelection::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides UserSelection::defaultConfiguration
UserSelection::entityQueryAlter	public	function	Allows the selection to alter the SelectQuery generated by EntityFieldQuery. Overrides SelectionPluginBase::entityQueryAlter
UserSelection::validateReferenceableEntities	public	function	Validates which existing entities can be referenced. Overrides DefaultSelection::validateReferenceableEntities
UserSelection::validateReferenceableNewEntities	public	function	Validates which newly created entities can be referenced. Overrides DefaultSelection::validateReferenceableNewEntities
UserSelection::__construct	public	function	Constructs a new UserSelection object. Overrides DefaultSelection::__construct