class SearchApiAlterRoleFilter in Search API 7

Data alteration that filters out users based on their role.

Hierarchy

• class \SearchApiAbstractAlterCallback implements SearchApiAlterCallbackInterface
  • class \SearchApiAlterRoleFilter

1 string reference to 'SearchApiAlterRoleFilter'

search_api_search_api_alter_callback_info in ./search_api.module

Implements hook_search_api_alter_callback_info().

File

includes/callback_role_filter.inc, line 11

Contains the SearchApiAlterRoleFilter class.

class SearchApiAlterRoleFilter extends SearchApiAbstractAlterCallback {

  /**
   * Overrides SearchApiAbstractAlterCallback::supportsIndex().
   *
   * This plugin only supports indexes containing users.
   */
  public function supportsIndex(SearchApiIndex $index) {
    if ($this
      ->isMultiEntityIndex($index)) {
      return in_array('user', $index->options['datasource']['types']);
    }
    return $index
      ->getEntityType() == 'user';
  }

  /**
   * Implements SearchApiAlterCallbackInterface::alterItems().
   */
  public function alterItems(array &$items) {
    $selected_roles = $this->options['roles'];
    $default = (bool) $this->options['default'];
    $multi_types = $this
      ->isMultiEntityIndex($this->index);
    foreach ($items as $id => $item) {
      if ($multi_types) {
        if ($item->item_type !== 'user') {
          continue;
        }
        $item_roles = $item->user->roles;
      }
      else {
        $item_roles = $item->roles;
      }
      $role_match = count(array_diff_key($item_roles, $selected_roles)) !== count($item_roles);
      if ($role_match === $default) {
        unset($items[$id]);
      }
    }
  }

  /**
   * Overrides SearchApiAbstractAlterCallback::configurationForm().
   *
   * Add option for the roles to include/exclude.
   */
  public function configurationForm() {
    $options = array_map('check_plain', user_roles());
    $form = array(
      'default' => array(
        '#type' => 'radios',
        '#title' => t('Which users should be indexed?'),
        '#default_value' => isset($this->options['default']) ? $this->options['default'] : 1,
        '#options' => array(
          1 => t('All but those from one of the selected roles'),
          0 => t('Only those from the selected roles'),
        ),
      ),
      'roles' => array(
        '#type' => 'select',
        '#title' => t('Roles'),
        '#default_value' => isset($this->options['roles']) ? $this->options['roles'] : array(),
        '#options' => $options,
        '#size' => min(4, count($options)),
        '#multiple' => TRUE,
      ),
    );
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiAbstractAlterCallback::$index	protected	property	The index whose items will be altered.
SearchApiAbstractAlterCallback::$options	protected	property	The configuration options for this callback, if it has any.
SearchApiAbstractAlterCallback::configurationFormSubmit	public	function	Implements SearchApiAlterCallbackInterface::configurationFormSubmit(). Overrides SearchApiAlterCallbackInterface::configurationFormSubmit	4
SearchApiAbstractAlterCallback::configurationFormValidate	public	function	Implements SearchApiAlterCallbackInterface::configurationFormValidate(). Overrides SearchApiAlterCallbackInterface::configurationFormValidate	1
SearchApiAbstractAlterCallback::isMultiEntityIndex	protected	function	Determines whether the given index contains multiple types of entities.
SearchApiAbstractAlterCallback::propertyInfo	public	function	Implements SearchApiAlterCallbackInterface::propertyInfo(). Overrides SearchApiAlterCallbackInterface::propertyInfo	6
SearchApiAbstractAlterCallback::__construct	public	function	Implements SearchApiAlterCallbackInterface::__construct(). Overrides SearchApiAlterCallbackInterface::__construct	1
SearchApiAlterRoleFilter::alterItems	public	function	Implements SearchApiAlterCallbackInterface::alterItems(). Overrides SearchApiAlterCallbackInterface::alterItems
SearchApiAlterRoleFilter::configurationForm	public	function	Overrides SearchApiAbstractAlterCallback::configurationForm(). Overrides SearchApiAbstractAlterCallback::configurationForm
SearchApiAlterRoleFilter::supportsIndex	public	function	Overrides SearchApiAbstractAlterCallback::supportsIndex(). Overrides SearchApiAbstractAlterCallback::supportsIndex