You are here

interface ViewsBulkOperationsActionProcessorInterface in Views Bulk Operations (VBO) 8.2

Same name and namespace in other branches
  1. 8.3 src/Service/ViewsBulkOperationsActionProcessorInterface.php \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface
  2. 8 src/Service/ViewsBulkOperationsActionProcessorInterface.php \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface
  3. 4.0.x src/Service/ViewsBulkOperationsActionProcessorInterface.php \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface

Defines Views Bulk Operations action processor.

Hierarchy

Expanded class hierarchy of ViewsBulkOperationsActionProcessorInterface

All classes that implement 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
View source
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);

  /**
   * Get full list of items from a specific view page.
   *
   * @param int $page
   *   Results page number.
   *
   * @return array
   *   Array of result data arrays.
   */
  public function getPageList($page);

  /**
   * 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 = []);

  /**
   * 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);

}

Members

Namesort descending Modifiers Type Description Overrides
ViewsBulkOperationsActionProcessorInterface::executeProcessing public function Helper function for processing results from view data. 1
ViewsBulkOperationsActionProcessorInterface::getPageList public function Get full list of items from a specific view page. 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