class NullQueue in Purge 8.3

API-compliant null queue back-end.

This plugin is not intended for usage but gets loaded during module installation, when configuration rendered invalid or when no other plugins are available. Because its API compliant, Drupal won't crash visibly.

Plugin annotation


@PurgeQueue(
  id = "null",
  label = @Translation("Null"),
  description = @Translation("API-compliant null queue back-end."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\purge\Plugin\Purge\Queue\QueueBase implements QueueInterface uses QueueBasePageTrait
    class \Drupal\purge\Plugin\Purge\Queue\MemoryQueue implements QueueInterface
    class \Drupal\purge\Plugin\Purge\Queue\NullQueue implements QueueInterface

Expanded class hierarchy of NullQueue

File

src/Plugin/Purge/Queue/NullQueue.php, line 18

Namespace

Drupal\purge\Plugin\Purge\Queue

View source

class NullQueue extends MemoryQueue implements QueueInterface {

}

Members

Name	Modifiers	Type	Description	Overrides
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
MemoryQueue::$buffer	protected	property	The internal buffer where all data is copied in.
MemoryQueue::$bufferInitialized	protected	property	Whether the buffer has been initialized or not.
MemoryQueue::bufferInitialize	private	function	Initialize the buffer.	1
MemoryQueue::claimItem	public	function	Claims an item in the queue for processing. Overrides QueueInterface::claimItem
MemoryQueue::claimItemMultiple	public	function	Claims multiple items from the queue for processing. Overrides QueueBase::claimItemMultiple
MemoryQueue::CREATED		constant
MemoryQueue::createItem	public	function	Adds a queue item and store it directly to the queue. Overrides QueueInterface::createItem
MemoryQueue::createItemMultiple	public	function	Add multiple items to the queue and store them efficiently. Overrides QueueBase::createItemMultiple
MemoryQueue::createQueue	public	function	Creates a queue. Overrides QueueInterface::createQueue
MemoryQueue::DATA		constant	Define constants for the array indiced in our buffer.
MemoryQueue::deleteItem	public	function	Deletes a finished item from the queue. Overrides QueueInterface::deleteItem
MemoryQueue::deleteItemMultiple	public	function	Delete multiple items from the queue at once. Overrides QueueBase::deleteItemMultiple
MemoryQueue::deleteQueue	public	function	Deletes a queue and every item in the queue. Overrides QueueInterface::deleteQueue	1
MemoryQueue::EXPIRE		constant
MemoryQueue::numberOfItems	public	function	Retrieves the number of items in the queue. Overrides QueueInterface::numberOfItems
MemoryQueue::releaseItem	public	function	Releases an item that the worker could not process. Overrides QueueInterface::releaseItem
MemoryQueue::releaseItemMultiple	public	function	Release multiple items that the worker could not process. Overrides QueueBase::releaseItemMultiple
MemoryQueue::selectPage	public	function	Select a page of queue data with a limited number of items. Overrides QueueInterface::selectPage
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
QueueBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
QueueBasePageTrait::$selectPageLimit	protected	property	The configured limit of items on selected data pages.
QueueBasePageTrait::selectPageLimit	public	function
QueueBasePageTrait::selectPageMax	public	function
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