class Views in Search API Autocomplete 8

Provides autocomplete support for Views search.

Plugin annotation


@SearchApiAutocompleteSearch(
  id = "views",
  group_label = @Translation("Search views"),
  group_description = @Translation("Searches provided by Views"),
  provider = "views",
  deriver =
  "Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\search\ViewsDeriver"
)

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_autocomplete\Plugin\PluginBase implements PluginInterface
    class \Drupal\search_api_autocomplete\Search\SearchPluginBase implements SearchPluginInterface
    class \Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\search\Views implements PluginFormInterface uses PluginFormTrait

Expanded class hierarchy of Views

File

src/Plugin/search_api_autocomplete/search/Views.php, line 28

Namespace

Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\search

View source

class Views extends SearchPluginBase implements PluginFormInterface {
  use PluginFormTrait;

  /**
   * The views executable factory.
   *
   * @var \Drupal\views\ViewExecutableFactory|null
   */
  protected $viewsExecutableFactory;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var static $plugin */
    $plugin = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $plugin
      ->setViewsExecutableFactory($container
      ->get('views.executable'));
    return $plugin;
  }

  /**
   * Retrieves the Views executable factory.
   *
   * @return \Drupal\views\ViewExecutableFactory
   *   The Views executable factory.
   */
  public function getViewsExecutableFactory() {
    return $this->viewsExecutableFactory ?: \Drupal::service('views.executable');
  }

  /**
   * Sets the Views executable factory.
   *
   * @param \Drupal\views\ViewExecutableFactory $views_executable_factory
   *   The new Views executable factory.
   *
   * @return $this
   */
  public function setViewsExecutableFactory(ViewExecutableFactory $views_executable_factory) {
    $this->viewsExecutableFactory = $views_executable_factory;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'displays' => [
        'default' => TRUE,
        'selected' => [],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $view = ViewsViews::getView($this
      ->getDerivativeId());
    if (!$view) {
      return [];
    }
    $options = [];
    $view
      ->initDisplay();
    foreach ($view->displayHandlers as $id => $display) {

      /** @var \Drupal\views\Plugin\views\display\DisplayPluginBase $display */
      $options[$id] = $display->display['display_title'];
    }
    $form['displays']['default'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('For which Views displays should Autocomplete be active?'),
      '#options' => [
        1 => $this
          ->t('All except those selected'),
        0 => $this
          ->t('None except those selected'),
      ],
      '#default_value' => (int) $this->configuration['displays']['default'],
    ];
    $form['displays']['selected'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Displays'),
      '#options' => $options,
      '#default_value' => $this->configuration['displays']['selected'],
      '#size' => min(4, count($options)),
      '#multiple' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {

    // Filter out empty checkboxes.
    $parents = [
      'displays',
      'selected',
    ];
    $value = $form_state
      ->getValue($parents, []);
    $value = array_keys(array_filter($value));
    $form_state
      ->setValue($parents, $value);
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public function createQuery($keys, array $data = []) {
    $views_id = $this
      ->getDerivativeId();
    $view = $this
      ->getEntityTypeManager()
      ->getStorage('view')
      ->load($views_id);
    if ($view instanceof ViewEntityInterface) {
      $view = $this
        ->getViewsExecutableFactory()
        ->get($view);
    }
    if (!$view) {
      $vars['@view'] = $views_id;
      throw new SearchApiAutocompleteException($this
        ->t('Could not load view @view.', $vars));
    }
    $data += [
      'display' => NULL,
      'arguments' => [],
    ];
    $view
      ->setDisplay($data['display']);
    $view
      ->setArguments($data['arguments']);

    // Set the keys via the exposed input, to get the correct handling for the
    // filter in question.
    $single_field_filter = !empty($data['field']);
    if (!empty($data['filter'])) {
      $input = $keys;

      // The Views filter for individual fulltext fields uses a nested "value"
      // field for the real input, due to Views internals.
      if ($single_field_filter) {
        $input = [
          'value' => $keys,
        ];
      }
      $view
        ->setExposedInput([
        $data['filter'] => $input,
      ]);
    }
    $view
      ->preExecute();

    // Since we only have a single value in the exposed input, any exposed
    // filters set to "Required" might cause problems – especially "Search:
    // Fulltext search", which aborts the query when validation fails (instead
    // of relying on the Form API "#required" validation). The normal filters
    // which use the Form API actually don't seem to cause problems, but it's
    // still better to be on the safe side here and just disabled "Required" for
    // all filters. (It also makes the code simpler.)

    /** @var \Drupal\views\Plugin\views\filter\FilterPluginBase $filter */
    foreach ($view->display_handler
      ->getHandlers('filter') as $filter) {
      $filter->options['expose']['required'] = FALSE;
    }
    $view
      ->build();
    $query_plugin = $view
      ->getQuery();
    if (!$query_plugin instanceof SearchApiQuery) {
      $views_label = $view->storage
        ->label() ?: $views_id;
      throw new SearchApiAutocompleteException("Could not create search query for view '{$views_label}': view is not based on Search API.");
    }
    $query = $query_plugin
      ->getSearchApiQuery();
    if (!$query) {
      $views_label = $view->storage
        ->label() ?: $views_id;
      throw new SearchApiAutocompleteException("Could not create search query for view '{$views_label}'.");
    }
    if ($single_field_filter) {
      $query
        ->setFulltextFields([
        $data['field'],
      ]);
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $this->dependencies = parent::calculateDependencies();
    $view_id = $this
      ->getDerivativeId();
    $view = $this
      ->getEntityTypeManager()
      ->getStorage('view')
      ->load($view_id);
    if ($view) {
      $key = $view
        ->getConfigDependencyKey();
      $name = $view
        ->getConfigDependencyName();
      $this
        ->addDependency($key, $name);
    }
    return $this->dependencies;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
HideablePluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden	1
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::$search	protected	property	The search this suggester is attached to.
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::getSearch	public	function	Retrieves the search this plugin is configured for. Overrides PluginInterface::getSearch
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::setSearch	public	function	Sets the search this plugin is configured for. Overrides PluginInterface::setSearch
PluginBase::__construct	public	function	Constructs a SearchPluginBase object. Overrides ConfigurablePluginBase::__construct	1
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
SearchPluginBase::$entityTypeManager	protected	property	The entity manager.	1
SearchPluginBase::getEntityTypeManager	public	function	Retrieves the entity manager.
SearchPluginBase::getGroupDescription	public	function	Retrieves a description for this search's group. Overrides SearchPluginInterface::getGroupDescription
SearchPluginBase::getGroupLabel	public	function	Retrieves a group label for this search. Overrides SearchPluginInterface::getGroupLabel
SearchPluginBase::getIndex	public	function	Retrieves the index to which this search plugin belongs. Overrides SearchPluginInterface::getIndex
SearchPluginBase::getIndexId	public	function	Retrieves the ID of the index to which this search plugin belongs. Overrides SearchPluginInterface::getIndexId
SearchPluginBase::setEntityTypeManager	public	function	Sets the entity manager.
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.
Views::$viewsExecutableFactory	protected	property	The views executable factory.
Views::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
Views::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides ConfigurablePluginBase::calculateDependencies
Views::create	public static	function	Creates an instance of the plugin. Overrides SearchPluginBase::create
Views::createQuery	public	function	Creates a search query based on this search. Overrides SearchPluginInterface::createQuery
Views::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginBase::defaultConfiguration
Views::getViewsExecutableFactory	public	function	Retrieves the Views executable factory.
Views::setViewsExecutableFactory	public	function	Sets the Views executable factory.
Views::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormTrait::submitConfigurationForm

You are here

class Views in Search API Autocomplete 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation