abstract class QueueUIBase in Queue UI 8.2

Class QueueUIBase

@package Drupal\queue_ui

Hierarchy

• class \Drupal\queue_ui\QueueUIBase implements QueueUIInterface

1 file declares its use of QueueUIBase

DatabaseQueue.php in src/Plugin/QueueUI/DatabaseQueue.php

File

src/QueueUIBase.php, line 10

Namespace

Drupal\queue_ui

abstract class QueueUIBase implements QueueUIInterface {

  /**
   * Retrieve the available operations for the implementing queue class.
   */
  public abstract function getOperations();

  /**
   * Inspect the queue items in a specified queue.
   *
   * @param string $queue_name
   *  The name of the queue being inspected.
   */
  public abstract function getItems($queue_name);

  /**
   * @param $queue_name
   */
  public abstract function releaseItems($queue_name);

  /**
   * View item data for a specified queue item.
   *
   * @param integer $item_id
   *  The item id to be viewed.
   */
  public abstract function loadItem($item_id);

  /**
   * Force the releasing of a specified queue item.
   *
   * @param integer $item_id
   *  The item id to be released.
   */
  public abstract function releaseItem($item_id);

  /**
   * Force the deletion of a specified queue item.
   *
   * @param integer $item_id
   *  The item id to be deleted.
   */
  public abstract function deleteItem($item_id);

}

Members

Name	Modifiers	Type	Description	Overrides
QueueUIBase::deleteItem	abstract public	function	Force the deletion of a specified queue item. Overrides QueueUIInterface::deleteItem	1
QueueUIBase::getItems	abstract public	function	Inspect the queue items in a specified queue. Overrides QueueUIInterface::getItems	1
QueueUIBase::getOperations	abstract public	function	Retrieve the available operations for the implementing queue class. Overrides QueueUIInterface::getOperations	1
QueueUIBase::loadItem	abstract public	function	View item data for a specified queue item. Overrides QueueUIInterface::loadItem	1
QueueUIBase::releaseItem	abstract public	function	Force the releasing of a specified queue item. Overrides QueueUIInterface::releaseItem	1
QueueUIBase::releaseItems	abstract public	function	Overrides QueueUIInterface::releaseItems	1