class ReportWorkerOne in Examples for Developers 3.x

A report worker.

@QueueWorker( id = "cron_example_queue_1", title = @Translation("First worker in cron_example"), cron = {"time" = 1} )

QueueWorkers are new in Drupal 8. They define a queue, which in this case is identified as cron_example_queue_1 and contain a process that operates on all the data given to the queue.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\cron_example\Plugin\QueueWorker\ReportWorkerBase implements ContainerFactoryPluginInterface uses MessengerTrait, StringTranslationTrait
      • class \Drupal\cron_example\Plugin\QueueWorker\ReportWorkerOne

See also

queue_example.module

File

modules/cron_example/src/Plugin/QueueWorker/ReportWorkerOne.php, line 20

Namespace

Drupal\cron_example\Plugin\QueueWorker

class ReportWorkerOne extends ReportWorkerBase {

  /**
   * {@inheritdoc}
   */
  public function processItem($data) {
    $this
      ->reportWork(1, $data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.
ReportWorkerBase::$logger	protected	property	The logger.
ReportWorkerBase::$state	protected	property	The state.
ReportWorkerBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ReportWorkerBase::reportWork	protected	function	Simple reporter log and display information about the queue.
ReportWorkerBase::__construct	public	function	ReportWorkerBase constructor. Overrides PluginBase::__construct
ReportWorkerOne::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.