interface EntityQueueHandlerInterface in Entityqueue 7

Abstraction of the handling logic of a queue.

Hierarchy

• interface \EntityQueueHandlerInterface

File

plugins/entityqueue/handler/base.inc, line 11

Contains Entityqueue handler interface and base class.

interface EntityQueueHandlerInterface {

  /**
   * Factory function: creates a new instance of this handler for a queue.
   *
   * @param EntityQueue $queue
   *   An EntityQueue object.
   *
   * @return EntityQueueHandlerInterface
   */
  public static function getInstance(EntityQueue $queue);

  /**
   * Generates a settings form for this handler.
   */
  public function settingsForm();

  /**
   * Generates an add/edit subqueue form for this handler.
   */
  public function subqueueForm(EntitySubqueue $subqueue, &$form_state);

  /**
   * Returns the entity type label of a queue target type.
   */
  public function getTargetTypeLabel();

  /**
   * Returns the label of the queue's handler.
   */
  public function getHandlerLabel();

  /**
   * Returns the label of a given subqueue.
   */
  public function getSubqueueLabel(EntitySubqueue $subqueue);

  /**
   * Returns TRUE if subqueue can be deleted, otherwise returns FALSE.
   */
  public function canDeleteSubqueue(EntitySubqueue $subqueue);

  /**
   * Act on creating a queue.
   */
  public function create();

  /**
   * Act on loading a queue.
   */
  public function load();

  /**
   * Act on loading a queue that is defined only in code.
   */
  public function loadFromCode();

  /**
   * Act before a queue is saved.
   */
  public function preSave();

  /**
   * Act after a new queue is saved.
   */
  public function insert();

  /**
   * Act after a queue is updated.
   */
  public function update();

  /**
   * Act before deleting a queue.
   */
  public function preDelete();

  /**
   * Act after deleting a queue.
   */
  public function postDelete();

}

Members

Name	Modifiers	Type	Description	Overrides
EntityQueueHandlerInterface::canDeleteSubqueue	public	function	Returns TRUE if subqueue can be deleted, otherwise returns FALSE.	1
EntityQueueHandlerInterface::create	public	function	Act on creating a queue.	1
EntityQueueHandlerInterface::getHandlerLabel	public	function	Returns the label of the queue's handler.	1
EntityQueueHandlerInterface::getInstance	public static	function	Factory function: creates a new instance of this handler for a queue.	1
EntityQueueHandlerInterface::getSubqueueLabel	public	function	Returns the label of a given subqueue.	1
EntityQueueHandlerInterface::getTargetTypeLabel	public	function	Returns the entity type label of a queue target type.	1
EntityQueueHandlerInterface::insert	public	function	Act after a new queue is saved.	1
EntityQueueHandlerInterface::load	public	function	Act on loading a queue.	1
EntityQueueHandlerInterface::loadFromCode	public	function	Act on loading a queue that is defined only in code.	1
EntityQueueHandlerInterface::postDelete	public	function	Act after deleting a queue.	1
EntityQueueHandlerInterface::preDelete	public	function	Act before deleting a queue.	1
EntityQueueHandlerInterface::preSave	public	function	Act before a queue is saved.	1
EntityQueueHandlerInterface::settingsForm	public	function	Generates a settings form for this handler.	1
EntityQueueHandlerInterface::subqueueForm	public	function	Generates an add/edit subqueue form for this handler.	1
EntityQueueHandlerInterface::update	public	function	Act after a queue is updated.	1