class NoUi in Search API 8

Provides a test backend that should be hidden from the UI.

Plugin annotation

@SearchApiBackend(
  id = "search_api_test_no_ui",
  label = @Translation("No UI backend"),
  no_ui = true,
)

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\Backend\BackendPluginBase implements BackendInterface uses LoggerTrait
          • class \Drupal\search_api_test_no_ui\Plugin\search_api\backend\NoUi

File

tests/search_api_test_no_ui/src/Plugin/search_api/backend/NoUi.php, line 18

Namespace

Drupal\search_api_test_no_ui\Plugin\search_api\backend

class NoUi extends BackendPluginBase {

  /**
   * {@inheritdoc}
   */
  public function indexItems(IndexInterface $index, array $items) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function deleteItems(IndexInterface $index, array $item_ids) {
  }

  /**
   * {@inheritdoc}
   */
  public function deleteAllIndexItems(IndexInterface $index, $datasource_id = NULL) {
  }

  /**
   * {@inheritdoc}
   */
  public function search(QueryInterface $query) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BackendPluginBase::$fieldsHelper	protected	property	The fields helper.
BackendPluginBase::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
BackendPluginBase::$server	protected	property	The server this backend is configured for.
BackendPluginBase::$serverId	protected	property	The backend's server's ID.
BackendPluginBase::addIndex	public	function	Adds a new index to this server. Overrides BackendSpecificInterface::addIndex	2
BackendPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ConfigurablePluginBase::create	1
BackendPluginBase::getBackendDefinedFields	public	function	Provides information on additional fields made available by the backend. Overrides BackendSpecificInterface::getBackendDefinedFields
BackendPluginBase::getDiscouragedProcessors	public	function	Limits the processors displayed in the UI for indexes on this server. Overrides BackendSpecificInterface::getDiscouragedProcessors	1
BackendPluginBase::getFieldsHelper	public	function	Retrieves the fields helper.
BackendPluginBase::getMessenger	public	function	Retrieves the messenger.
BackendPluginBase::getQueryFulltextFields	protected	function	Retrieves the effective fulltext fields from the query.
BackendPluginBase::getServer	public	function	Retrieves the server entity for this backend. Overrides BackendInterface::getServer
BackendPluginBase::getSpecialFields	protected	function	Creates dummy field objects for the "magic" fields present for every index.	1
BackendPluginBase::getSupportedFeatures	public	function	Returns all features that this backend supports. Overrides BackendSpecificInterface::getSupportedFeatures	2
BackendPluginBase::isAvailable	public	function	Returns a boolean with the availability of the backend. Overrides BackendSpecificInterface::isAvailable	1
BackendPluginBase::postInsert	public	function	Reacts to the server's creation. Overrides BackendInterface::postInsert	1
BackendPluginBase::postUpdate	public	function	Notifies the backend that its configuration was updated. Overrides BackendInterface::postUpdate	2
BackendPluginBase::preDelete	public	function	Notifies the backend that the server is about to be deleted. Overrides BackendInterface::preDelete	1
BackendPluginBase::preUpdate	public	function	Notifies the backend that its configuration is about to be updated. Overrides BackendInterface::preUpdate	1
BackendPluginBase::removeIndex	public	function	Removes an index from this server. Overrides BackendSpecificInterface::removeIndex	2
BackendPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginBase::setConfiguration
BackendPluginBase::setFieldsHelper	public	function	Sets the fields helper.
BackendPluginBase::setMessenger	public	function	Sets the messenger. Overrides MessengerTrait::setMessenger
BackendPluginBase::setServer	public	function	Sets the server entity for this backend. Overrides BackendInterface::setServer
BackendPluginBase::supportsDataType	public	function	Determines whether the backend supports a given add-on data type. Overrides BackendSpecificInterface::supportsDataType	1
BackendPluginBase::updateIndex	public	function	Notifies the server that an index attached to it has been changed. Overrides BackendSpecificInterface::updateIndex	2
BackendPluginBase::validateOperator	protected	function	Verifies that the given condition operator is valid for this backend.
BackendPluginBase::viewSettings	public	function	Returns additional, backend-specific information about this server. Overrides BackendSpecificInterface::viewSettings	2
BackendPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct	1
BackendPluginBase::__sleep	public	function	Implements the magic __sleep() method. Overrides DependencySerializationTrait::__sleep	1
BackendPluginBase::__wakeup	public	function	Implements the magic __wakeup() method. Overrides DependencySerializationTrait::__wakeup	1
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::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.
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
LoggerTrait::$logger	protected	property	The logging channel to use.
LoggerTrait::getLogger	public	function	Retrieves the logger.
LoggerTrait::logException	protected	function	Logs an exception.
LoggerTrait::setLogger	public	function	Sets the logger.
MessengerTrait::messenger	public	function	Gets the messenger.	29
NoUi::deleteAllIndexItems	public	function	Deletes all the items from the index. Overrides BackendSpecificInterface::deleteAllIndexItems
NoUi::deleteItems	public	function	Deletes the specified items from the index. Overrides BackendSpecificInterface::deleteItems
NoUi::indexItems	public	function	Indexes the specified items. Overrides BackendSpecificInterface::indexItems
NoUi::search	public	function	Executes a search on this server. Overrides BackendSpecificInterface::search
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
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.