class Page in Search API Autocomplete 8

Provides autocomplete support for the search_api_page module.

Plugin annotation


@SearchApiAutocompleteSearch(
  id = "page",
  group_label = @Translation("Search pages"),
  group_description = @Translation("Searches provided by the <em>Search pages</em> module"),
  provider = "search_api_page",
  deriver = "Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\search\PageDeriver",
)

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\Page implements ContainerFactoryPluginInterface

Expanded class hierarchy of Page

1 string reference to 'Page'

views.view.search_api_autocomplete_test_view.yml in tests/search_api_autocomplete_test/config/install/views.view.search_api_autocomplete_test_view.yml: tests/search_api_autocomplete_test/config/install/views.view.search_api_autocomplete_test_view.yml

File

src/Plugin/search_api_autocomplete/search/Page.php, line 22

Namespace

Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\search

View source

class Page extends SearchPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The query helper service.
   *
   * @var \Drupal\search_api\Utility\QueryHelperInterface|null
   */
  protected $queryHelper;

  /**
   * Creates a new Page instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $plugin = new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
    $plugin
      ->setQueryHelper($container
      ->get('search_api.query_helper'));
    return $plugin;
  }

  /**
   * Retrieves the query helper.
   *
   * @return \Drupal\search_api\Utility\QueryHelperInterface
   *   The query helper.
   */
  public function getQueryHelper() {
    return $this->queryHelper ?: \Drupal::service('search_api.query_helper');
  }

  /**
   * Sets the query helper.
   *
   * @param \Drupal\search_api\Utility\QueryHelperInterface $query_helper
   *   The new query helper.
   *
   * @return $this
   */
  public function setQueryHelper(QueryHelperInterface $query_helper) {
    $this->queryHelper = $query_helper;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function createQuery($keys, array $data = []) {
    $query = $this
      ->getQueryHelper()
      ->createQuery($this
      ->getIndex());
    $query
      ->keys($keys);
    $page = $this
      ->getPage();
    if ($page && $page
      ->getSearchedFields()) {
      $query
        ->setFulltextFields(array_values($page
        ->getSearchedFields()));
    }
    return $query;
  }

  /**
   * Retrieves the search page entity for this plugin.
   *
   * @return \Drupal\search_api_page\SearchApiPageInterface|null
   *   The search page, or NULL if it couldn't be loaded.
   */
  protected function getPage() {

    /** @var \Drupal\search_api_page\SearchApiPageInterface $page */
    $page = $this
      ->getEntityTypeManager()
      ->getStorage('search_api_page')
      ->load($this
      ->getDerivativeId());
    return $page;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $this->dependencies = parent::calculateDependencies();
    $page = $this
      ->getPage();
    if ($page) {
      $key = $page
        ->getConfigDependencyKey();
      $name = $page
        ->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::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.
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.
Page::$entityTypeManager	protected	property	The entity type manager. Overrides SearchPluginBase::$entityTypeManager
Page::$queryHelper	protected	property	The query helper service.
Page::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides ConfigurablePluginBase::calculateDependencies
Page::create	public static	function	Creates an instance of the plugin. Overrides SearchPluginBase::create
Page::createQuery	public	function	Creates a search query based on this search. Overrides SearchPluginInterface::createQuery
Page::getPage	protected	function	Retrieves the search page entity for this plugin.
Page::getQueryHelper	public	function	Retrieves the query helper.
Page::setQueryHelper	public	function	Sets the query helper.
Page::__construct	public	function	Creates a new Page instance. Overrides PluginBase::__construct
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
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
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.

You are here

class Page in Search API Autocomplete 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation