class NoUi in Search API 8

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

Plugin annotation

@SearchApiDatasource(
  id = "search_api_test_no_ui",
  label = @Translation("No UI datasource"),
  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\Plugin\IndexPluginBase implements IndexPluginInterface
          • class \Drupal\search_api\Datasource\DatasourcePluginBase implements DatasourceInterface
            • class \Drupal\search_api_test_no_ui\Plugin\search_api\datasource\NoUi

File

tests/search_api_test_no_ui/src/Plugin/search_api/datasource/NoUi.php, line 17

Namespace

Drupal\search_api_test_no_ui\Plugin\search_api\datasource

class NoUi extends DatasourcePluginBase {

  /**
   * {@inheritdoc}
   */
  public function getItemId(ComplexDataInterface $item) {
    return NULL;
  }

}

Members

Name	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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	4
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.
DatasourcePluginBase::canContainEntityReferences	public	function	Determines whether this datasource can contain entity references. Overrides DatasourceInterface::canContainEntityReferences	1
DatasourcePluginBase::checkItemAccess	public	function	Checks whether a user has permission to view the given item. Overrides DatasourceInterface::checkItemAccess
DatasourcePluginBase::getAffectedItemsForEntityChange	public	function	Identifies items affected by a change to a referenced entity. Overrides DatasourceInterface::getAffectedItemsForEntityChange	1
DatasourcePluginBase::getBundles	public	function	Retrieves the bundles associated to this datasource. Overrides DatasourceInterface::getBundles	1
DatasourcePluginBase::getEntityTypeId	public	function	Retrieves the entity type ID of items from this datasource, if any. Overrides DatasourceInterface::getEntityTypeId	1
DatasourcePluginBase::getFieldDependencies	public	function	Retrieves any dependencies of the given fields. Overrides DatasourceInterface::getFieldDependencies	1
DatasourcePluginBase::getItemAccessResult	public	function	Checks whether a user has permission to view the given item. Overrides DatasourceInterface::getItemAccessResult	1
DatasourcePluginBase::getItemBundle	public	function	Retrieves the item's bundle. Overrides DatasourceInterface::getItemBundle	1
DatasourcePluginBase::getItemIds	public	function	Returns a list of IDs of items from this datasource. Overrides DatasourceInterface::getItemIds	1
DatasourcePluginBase::getItemLabel	public	function	Retrieves a human-readable label for an item. Overrides DatasourceInterface::getItemLabel	1
DatasourcePluginBase::getItemLanguage	public	function	Retrieves the item's language. Overrides DatasourceInterface::getItemLanguage	1
DatasourcePluginBase::getItemUrl	public	function	Retrieves a URL at which the item can be viewed on the web. Overrides DatasourceInterface::getItemUrl	1
DatasourcePluginBase::getListCacheContexts	public	function	Returns the list cache contexts associated with this datasource. Overrides DatasourceInterface::getListCacheContexts	1
DatasourcePluginBase::getPropertyDefinitions	public	function	Retrieves the properties exposed by the underlying complex data type. Overrides DatasourceInterface::getPropertyDefinitions	2
DatasourcePluginBase::getViewModes	public	function	Returns the available view modes for this datasource. Overrides DatasourceInterface::getViewModes	1
DatasourcePluginBase::load	public	function	Loads an item. Overrides DatasourceInterface::load
DatasourcePluginBase::loadMultiple	public	function	Loads multiple items. Overrides DatasourceInterface::loadMultiple	2
DatasourcePluginBase::viewItem	public	function	Returns the render array for the provided item and view mode. Overrides DatasourceInterface::viewItem	1
DatasourcePluginBase::viewMultipleItems	public	function	Returns the render array for the provided items and view mode. Overrides DatasourceInterface::viewMultipleItems	1
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
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.
NoUi::getItemId	public	function	Retrieves the unique ID of an object from this datasource. Overrides DatasourceInterface::getItemId
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.