interface QueueUIInterface in Queue UI 8.2

Provides the Queue UI interface for inspecting queue data.

Hierarchy

• interface \Drupal\queue_ui\QueueUIInterface

1 file declares its use of QueueUIInterface

OverviewForm.php in src/Form/OverviewForm.php

File

src/QueueUIInterface.php, line 8

Namespace

Drupal\queue_ui

interface QueueUIInterface {

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

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

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

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

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

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

}

Members

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