You are here

Home » API reference » Search API Sort Priority 8 » Role.php

class Role in Search API Sort Priority 8

Adds customized sort priority by Role.

Plugin annotation


@SearchApiProcessor(
  id = "role",
  label = @Translation("Sort Priority by Role"),
  description = @Translation("Sort Priority by Role."),
  stages = {
    "add_properties" = 20,
    "pre_index_save" = 0,
  },
  locked = false,
  hidden = false,
)

Hierarchy

Expanded class hierarchy of Role

1 string reference to 'Role'
Role::buildConfigurationForm in src/Plugin/search_api/processor/Role.php
Form constructor.

File

src/Plugin/search_api/processor/Role.php, line 34

Namespace

Drupal\search_api_sort_priority\Plugin\search_api\processor
View source 
class Role extends ProcessorPluginBase implements PluginFormInterface {
  use PluginFormTrait;
  protected $targetFieldId = 'role_weight';

  /**
   * Can only be enabled for an index that indexes user related entity.
   *
   * {@inheritdoc}
   */
  public static function supportsIndex(IndexInterface $index) {
    foreach ($index
      ->getDatasources() as $datasource) {
      if ($datasource
        ->getEntityTypeId() == 'node') {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getPropertyDefinitions(DatasourceInterface $datasource = NULL) {
    $properties = [];
    if (!$datasource) {
      $definition = [
        // TODO Come up with better label.
        'label' => $this
          ->t('Sort Priority by Role'),
        // TODO Come up with better description.
        'description' => $this
          ->t('Sort Priority by Role.'),
        'type' => 'integer',
        'processor_id' => $this
          ->getPluginId(),
        // This will be a hidden field,
        // not something a user can add/remove manually.
        'hidden' => TRUE,
      ];
      $properties[$this->targetFieldId] = new ProcessorProperty($definition);
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function addFieldValues(ItemInterface $item) {

    // Get default weight.
    $weight = $this->configuration['weight'];

    // Only run for node and comment items.
    // TODO Extend for other entities.
    $entity_type_id = $item
      ->getDatasource()
      ->getEntityTypeId();
    if (!in_array($entity_type_id, $this->configuration['allowed_entity_types'])) {
      return;
    }
    $fields = $this
      ->getFieldsHelper()
      ->filterForPropertyPath($item
      ->getFields(), NULL, $this->targetFieldId);

    // TODO Extend for other entities.
    switch ($entity_type_id) {
      case 'node':

        // Get the node object.
        $node = $this
          ->getNode($item
          ->getOriginalObject());

        // Get the user associated with this node.
        $user = User::load($node
          ->getOwnerId());

        // Get user roles.
        $user_roles = $user
          ->getRoles();

        // Construct array for role sorting.
        foreach ($user_roles as $role_id) {
          $weight = $this->configuration['sorttable'][$role_id]['weight'];
          $role_weights[$role_id]['role'] = $role_id;
          $role_weights[$role_id]['weight'] = $weight;
        }

        // Sort the roles by weight.
        uasort($role_weights, [
          'Drupal\\Component\\Utility\\SortArray',
          'sortByWeightElement',
        ]);
        $highest_role_weight = array_values($role_weights)[0];

        // Set the weight on all the configured fields.
        foreach ($fields as $field) {
          $field
            ->addValue($highest_role_weight['weight']);
        }
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'weight' => 0,
      'allowed_entity_types' => [
        'node',
        'comment',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['sorttable'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Role'),
        $this
          ->t('Weight'),
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'sorttable-order-weight',
        ],
      ],
    ];
    $master_roles = user_roles();
    $roles = array_map(function (RoleInterface $role) {
      return Html::escape($role
        ->label());
    }, $master_roles);

    // Make a dummy array to add custom weight.
    foreach ($roles as $role_id => $role_name) {
      $weight = $master_roles[$role_id]
        ->getWeight();
      if (isset($this->configuration['sorttable']) && isset($this->configuration['sorttable'][$role_id]['weight'])) {
        $weight = $this->configuration['sorttable'][$role_id]['weight'];
      }
      $role_weight[$role_id]['bundle_id'] = $role_id;
      $role_weight[$role_id]['bundle_name'] = $role_name;
      $role_weight[$role_id]['weight'] = $weight;
    }

    // Sort weights.
    uasort($role_weight, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);

    // Loop over each role and create a form row.
    foreach ($role_weight as $role_id => $role) {
      $weight = $role['weight'];
      $role_name = $role['bundle_name'];

      // Add form with weights
      // Mark the table row as draggable.
      $form['sorttable'][$role_id]['#attributes']['class'][] = 'draggable';

      // Sort the table row according to its existing/configured weight.
      $form['sorttable'][$role_id]['#weight'] = $weight;

      // Table columns containing raw markup.
      $form['sorttable'][$role_id]['label']['#plain_text'] = $role_name;

      // Weight column element.
      $form['sorttable'][$role_id]['weight'] = [
        '#type' => 'weight',
        '#title' => t('Weight for @title', [
          '@title' => $role_name,
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $weight,
        // Classify the weight element for #tabledrag.
        '#attributes' => [
          'class' => [
            'sorttable-order-weight',
          ],
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public function preIndexSave() {

    // Automatically add field to index if processor is enabled.
    $field = $this
      ->ensureField(NULL, $this->targetFieldId, 'integer');

    // Hide the field.
    $field
      ->setHidden();
  }

  /**
   * Retrieves the node related to an indexed search object.
   *
   * Will be either the node itself, or the node the comment is attached to.
   *
   * @param \Drupal\Core\TypedData\ComplexDataInterface $item
   *   A search object that is being indexed.
   *
   * @return \Drupal\node\NodeInterface|null
   *   The node related to that search object.
   */
  protected function getNode(ComplexDataInterface $item) {
    $item = $item
      ->getValue();
    if ($item instanceof CommentInterface) {
      $item = $item
        ->getCommentedEntity();
    }
    if ($item instanceof NodeInterface) {
      return $item;
    }
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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
PluginFormTrait::validateConfigurationForm public function Form validation handler. 2
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::alterIndexedItems public function Alter the items to be indexed. Overrides ProcessorInterface::alterIndexedItems 3
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::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::preprocessIndexItems public function Preprocesses search items for indexing. Overrides ProcessorInterface::preprocessIndexItems 5
ProcessorPluginBase::preprocessSearchQuery public function Preprocesses a search query. Overrides ProcessorInterface::preprocessSearchQuery 4
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
Role::$targetFieldId protected property
Role::addFieldValues public function Adds the values of properties defined by this processor to the item. Overrides ProcessorPluginBase::addFieldValues
Role::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
Role::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginBase::defaultConfiguration
Role::getNode protected function Retrieves the node related to an indexed search object.
Role::getPropertyDefinitions public function Retrieves the properties this processor defines for the given datasource. Overrides ProcessorPluginBase::getPropertyDefinitions
Role::preIndexSave public function Preprocesses the search index entity before it is saved. Overrides ProcessorPluginBase::preIndexSave
Role::submitConfigurationForm public function Form submission handler. Overrides PluginFormTrait::submitConfigurationForm
Role::supportsIndex public static function Can only be enabled for an index that indexes user related entity. Overrides ProcessorPluginBase::supportsIndex
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.