class BlockedUsers in Open Social 8

Ignores blocked users in index and queries.

Makes sure blocked users are no longer indexed AND also filters out blocked users from queries.

Plugin annotation

@SearchApiProcessor(
  id = "blocked_users",
  label = @Translation("Skip Blocked users"),
  description = @Translation("Makes sure that blocked users are not added to the index."),
  stages = {
    "alter_items" = 0,
    "preprocess_query" = -30,
  },
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
      • class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
        • class \Drupal\search_api\Plugin\IndexPluginBase implements IndexPluginInterface
          • class \Drupal\search_api\Processor\ProcessorPluginBase implements ProcessorInterface
            • class \Drupal\social_search\Plugin\search_api\processor\BlockedUsers

File

modules/social_features/social_search/src/Plugin/search_api/processor/BlockedUsers.php, line 27

Namespace

Drupal\social_search\Plugin\search_api\processor

class BlockedUsers extends ProcessorPluginBase {

  /**
   * {@inheritdoc}
   */
  public static function supportsIndex(IndexInterface $index) {
    $entity_types = [
      'profile',
    ];
    foreach ($index
      ->getDatasources() as $datasource) {
      if (in_array($datasource
        ->getEntityTypeId(), $entity_types)) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function alterIndexedItems(array &$items) {
    foreach ($items as $item_id => $item) {
      $object = $item
        ->getOriginalObject()
        ->getValue();
      if ($object instanceof ProfileInterface) {

        // Profile ownedId is the userId.
        if ($object
          ->getOwner()
          ->isBlocked() === TRUE) {
          unset($items[$item_id]);
        }
      }
      elseif ($object instanceof UserInterface) {
        if ($object
          ->isBlocked() === TRUE) {
          unset($items[$item_id]);
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preprocessSearchQuery(QueryInterface $query) {
    if (!$query
      ->getOption('search_api_bypass_access')) {

      // Add a condition to filter out users through the status field.
      $conditions = $query
        ->createConditionGroup('AND');
      $conditions
        ->addCondition('user_status', 0, '<>');

      // Add the conditions.
      $query
        ->addConditionGroup($conditions);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockedUsers::alterIndexedItems	public	function	Alter the items to be indexed. Overrides ProcessorPluginBase::alterIndexedItems
BlockedUsers::preprocessSearchQuery	public	function	Preprocesses a search query. Overrides ProcessorPluginBase::preprocessSearchQuery
BlockedUsers::supportsIndex	public static	function	Checks whether this processor is applicable for a certain index. Overrides ProcessorPluginBase::supportsIndex
ConfigurablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
ConfigurablePluginBase::calculatePluginDependencies Deprecated	protected	function	Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	11
ConfigurablePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription	public	function	Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated	protected	function	Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label	public	function	Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated	protected	function	Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval	5
ConfigurablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	3
ConfigurablePluginBase::themeHandler Deprecated	protected	function	Wraps the theme handler.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
IndexPluginBase::$index	protected	property	The index this processor is configured for.
IndexPluginBase::getIndex	public	function	Retrieves the index this plugin is configured for. Overrides IndexPluginInterface::getIndex
IndexPluginBase::setIndex	public	function	Sets the index this plugin is configured for. Overrides IndexPluginInterface::setIndex
IndexPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct	2
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.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler. Aliased as: traitModuleHandler	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler. Aliased as: traitThemeHandler	1
ProcessorInterface::STAGE_ADD_PROPERTIES		constant	Processing stage: add properties.
ProcessorInterface::STAGE_ALTER_ITEMS		constant	Processing stage: alter indexed items.
ProcessorInterface::STAGE_POSTPROCESS_QUERY		constant	Processing stage: postprocess query.
ProcessorInterface::STAGE_PREPROCESS_INDEX		constant	Processing stage: preprocess index.
ProcessorInterface::STAGE_PREPROCESS_QUERY		constant	Processing stage: preprocess query.
ProcessorInterface::STAGE_PRE_INDEX_SAVE		constant	Processing stage: preprocess index.
ProcessorPluginBase::$fieldsHelper	protected	property	The fields helper.	1
ProcessorPluginBase::addFieldValues	public	function	Adds the values of properties defined by this processor to the item. Overrides ProcessorInterface::addFieldValues	8
ProcessorPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ConfigurablePluginBase::create	8
ProcessorPluginBase::ensureField	protected	function	Ensures that a field with certain properties is indexed on the index.
ProcessorPluginBase::findField	protected	function	Finds a certain field in the index.
ProcessorPluginBase::getFieldsHelper	public	function	Retrieves the fields helper.	1
ProcessorPluginBase::getPropertyDefinitions	public	function	Retrieves the properties this processor defines for the given datasource. Overrides ProcessorInterface::getPropertyDefinitions	8
ProcessorPluginBase::getWeight	public	function	Returns the weight for a specific processing stage. Overrides ProcessorInterface::getWeight
ProcessorPluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginBase::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::postprocessSearchResults	public	function	Postprocess search results before they are returned by the query. Overrides ProcessorInterface::postprocessSearchResults	2
ProcessorPluginBase::preIndexSave	public	function	Preprocesses the search index entity before it is saved. Overrides ProcessorInterface::preIndexSave	5
ProcessorPluginBase::preprocessIndexItems	public	function	Preprocesses search items for indexing. Overrides ProcessorInterface::preprocessIndexItems	5
ProcessorPluginBase::requiresReindexing	public	function	Determines whether re-indexing is required after a settings change. Overrides ProcessorInterface::requiresReindexing
ProcessorPluginBase::setFieldsHelper	public	function	Sets the fields helper.	1
ProcessorPluginBase::setWeight	public	function	Sets the weight for a specific processing stage. Overrides ProcessorInterface::setWeight
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage	2
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.