interface ViewsBulkOperationsActionInterface in Views Bulk Operations (VBO) 8.3
Same name and namespace in other branches
- 8 src/Action/ViewsBulkOperationsActionInterface.php \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionInterface
- 8.2 src/Action/ViewsBulkOperationsActionInterface.php \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionInterface
- 4.0.x src/Action/ViewsBulkOperationsActionInterface.php \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionInterface
Defines Views Bulk Operations action interface.
Hierarchy
- interface \Drupal\Core\Executable\ExecutableInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
- interface \Drupal\Core\Action\ActionInterface
- interface \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionInterface
- interface \Drupal\Core\Action\ActionInterface
Expanded class hierarchy of ViewsBulkOperationsActionInterface
All classes that implement ViewsBulkOperationsActionInterface
1 file declares its use of ViewsBulkOperationsActionInterface
File
- src/
Action/ ViewsBulkOperationsActionInterface.php, line 12
Namespace
Drupal\views_bulk_operations\ActionView source
interface ViewsBulkOperationsActionInterface extends ActionInterface {
/**
* Set action context.
*
* Implementation should have an option to add data to the
* context, not overwrite it on every method execution.
*
* @param array $context
* The context array.
*
* @see ViewsBulkOperationsActionBase::setContext
*/
public function setContext(array &$context);
/**
* Set view object.
*
* @param \Drupal\views\ViewExecutable $view
* The processed view.
*/
public function setView(ViewExecutable $view);
/**
* Execute action on multiple entities.
*
* Can return an array of results of processing, if no return value
* is provided, action label will be used for each result.
*
* @param array $objects
* An array of entities.
*
* @return array
* An array of translatable markup objects or strings (optional)
*/
public function executeMultiple(array $objects);
/**
* Action batch execution finished callback.
*
* Used to set finished message, redirect or execute some final logic.
*
* @param bool $success
* Was the process successful?
* @param array $results
* Batch process results array.
* @param array $operations
* Performed operations array.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse|null
* Bach redirect response or NULL.
*/
public static function finished($success, array $results, array $operations) : ?RedirectResponse;
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ActionInterface:: |
public | function | Checks object access. | 19 |
ExecutableInterface:: |
public | function | Executes the plugin. | 20 |
PluginInspectionInterface:: |
public | function | Gets the definition of the plugin implementation. | 4 |
PluginInspectionInterface:: |
public | function | Gets the plugin_id of the plugin instance. | 2 |
ViewsBulkOperationsActionInterface:: |
public | function |
Execute action on multiple entities. Overrides ActionInterface:: |
1 |
ViewsBulkOperationsActionInterface:: |
public static | function | Action batch execution finished callback. | |
ViewsBulkOperationsActionInterface:: |
public | function | Set action context. | 1 |
ViewsBulkOperationsActionInterface:: |
public | function | Set view object. | 1 |