interface ViewsBulkOperationsActionProcessorInterface in Views Bulk Operations (VBO) 8

Defines Views Bulk Operations action processor.

Hierarchy

• interface \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface

4 files declare their use of ViewsBulkOperationsActionProcessorInterface

ConfigureAction.php in src/Form/ConfigureAction.php

ConfirmAction.php in src/Form/ConfirmAction.php

ViewsBulkOperationsBulkForm.php in src/Plugin/views/field/ViewsBulkOperationsBulkForm.php

ViewsBulkOperationsController.php in src/Controller/ViewsBulkOperationsController.php

File

src/Service/ViewsBulkOperationsActionProcessorInterface.php, line 8

Namespace

Drupal\views_bulk_operations\Service

interface ViewsBulkOperationsActionProcessorInterface {

  /**
   * Set values.
   *
   * @param array $view_data
   *   Data concerning the view that will be processed.
   * @param mixed $view
   *   The current view object or NULL.
   */
  public function initialize(array $view_data, $view = NULL);

  /**
   * Populate entity queue for processing.
   *
   * @param array $list
   *   Array of selected view results.
   * @param array $context
   *   Batch API context.
   */
  public function populateQueue(array $list, array &$context = []);

  /**
   * Set action context if action method exists.
   *
   * @param array $context
   *   The context to be set.
   */
  public function setActionContext(array $context);

  /**
   * Process results.
   */
  public function process();

  /**
   * Helper function for processing results from view data.
   *
   * @param array $data
   *   Data concerning the view that will be processed.
   * @param mixed $view
   *   The current view object or NULL.
   */
  public function executeProcessing(array &$data, $view = NULL);

  /**
   * Get entity for processing.
   *
   * @param array $entity_data
   *   Entity data array.
   */
  public function getEntity(array $entity_data);

  /**
   * Get the current entity queue.
   *
   * @return array
   *   Array of entities from the current queue.
   */
  public function getQueue();

}

Members

Name	Modifiers	Type	Description	Overrides
ViewsBulkOperationsActionProcessorInterface::executeProcessing	public	function	Helper function for processing results from view data.	1
ViewsBulkOperationsActionProcessorInterface::getEntity	public	function	Get entity for processing.	1
ViewsBulkOperationsActionProcessorInterface::getQueue	public	function	Get the current entity queue.	1
ViewsBulkOperationsActionProcessorInterface::initialize	public	function	Set values.	1
ViewsBulkOperationsActionProcessorInterface::populateQueue	public	function	Populate entity queue for processing.	1
ViewsBulkOperationsActionProcessorInterface::process	public	function	Process results.	1
ViewsBulkOperationsActionProcessorInterface::setActionContext	public	function	Set action context if action method exists.	1