class NoUi in Search API 8

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

Plugin annotation

@SearchApiTracker(
  id = "search_api_test_no_ui",
  label = @Translation("No UI tracker"),
  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\Tracker\TrackerPluginBase implements TrackerInterface
            • class \Drupal\search_api\Plugin\search_api\tracker\Basic implements PluginFormInterface uses LoggerTrait, PluginFormTrait
              • class \Drupal\search_api_test_no_ui\Plugin\search_api\tracker\NoUi implements PluginFormInterface

File

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

Namespace

Drupal\search_api_test_no_ui\Plugin\search_api\tracker

class NoUi extends Basic implements PluginFormInterface {

}

Members

Name	Modifiers	Type	Description	Overrides
Basic::$connection	protected	property	The database connection used by this plugin.
Basic::$timeService	protected	property	The time service.
Basic::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
Basic::create	public static	function	Creates an instance of the plugin. Overrides ConfigurablePluginBase::create
Basic::createDeleteStatement	protected	function	Creates a DELETE statement for this tracker.
Basic::createInsertStatement	protected	function	Creates an INSERT statement for this tracker.
Basic::createRemainingItemsStatement	protected	function	Creates a SELECT statement which filters on the not indexed items.
Basic::createSelectStatement	protected	function	Creates a SELECT statement for this tracker.
Basic::createUpdateStatement	protected	function	Creates an UPDATE statement for this tracker.
Basic::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginBase::defaultConfiguration
Basic::getDatabaseConnection	public	function	Retrieves the database connection.
Basic::getIndexedItemsCount	public	function	Retrieves the number of indexed items for this index. Overrides TrackerInterface::getIndexedItemsCount
Basic::getRemainingItems	public	function	Retrieves a list of item IDs that need to be indexed. Overrides TrackerInterface::getRemainingItems
Basic::getRemainingItemsCount	public	function	Retrieves the total number of pending items for this index. Overrides TrackerInterface::getRemainingItemsCount
Basic::getTimeService	public	function	Retrieves the time service.
Basic::getTotalItemsCount	public	function	Retrieves the total number of items that are being tracked for this index. Overrides TrackerInterface::getTotalItemsCount
Basic::setDatabaseConnection	public	function	Sets the database connection.
Basic::setTimeService	public	function	Sets the time service.
Basic::STATUS_INDEXED		constant	Status value that represents items which are indexed in their latest form.
Basic::STATUS_NOT_INDEXED		constant	Status value that represents items which still need to be indexed.
Basic::trackAllItemsDeleted	public	function	Removes all items from the tracker, or only those of a specific datasource. Overrides TrackerInterface::trackAllItemsDeleted
Basic::trackAllItemsUpdated	public	function	Marks all items as updated, or only those of a specific datasource. Overrides TrackerInterface::trackAllItemsUpdated
Basic::trackItemsDeleted	public	function	Removes items from the tracking system for this index. Overrides TrackerInterface::trackItemsDeleted
Basic::trackItemsIndexed	public	function	Marks items as indexed for this index. Overrides TrackerInterface::trackItemsIndexed
Basic::trackItemsInserted	public	function	Inserts new items into the tracking system for this index. Overrides TrackerInterface::trackItemsInserted
Basic::trackItemsUpdated	public	function	Marks the given items as updated for this index. Overrides TrackerInterface::trackItemsUpdated
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::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
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
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	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::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
PluginFormTrait::submitConfigurationForm	public	function	Form submission handler.	7
PluginFormTrait::validateConfigurationForm	public	function	Form validation handler.	2
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.