abstract class ViewsBulkOperationsActionBase in Views Bulk Operations (VBO) 4.0.x
Same name and namespace in other branches
- 8.3 src/Action/ViewsBulkOperationsActionBase.php \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase
- 8 src/Action/ViewsBulkOperationsActionBase.php \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase
- 8.2 src/Action/ViewsBulkOperationsActionBase.php \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase
Views Bulk Operations action plugin base.
Provides a base implementation for a configurable and preconfigurable VBO Action plugin.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Action\ActionBase implements ActionInterface
- class \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase implements ConfigurableInterface, ViewsBulkOperationsActionInterface uses ViewsBulkOperationsActionCompletedTrait
- class \Drupal\Core\Action\ActionBase implements ActionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ViewsBulkOperationsActionBase
6 files declare their use of ViewsBulkOperationsActionBase
- CancelUserAction.php in src/
Plugin/ Action/ CancelUserAction.php - EntityDeleteAction.php in src/
Plugin/ Action/ EntityDeleteAction.php - ViewsBulkOperationExampleAction.php in modules/
views_bulk_operations_example/ src/ Plugin/ Action/ ViewsBulkOperationExampleAction.php - ViewsBulkOperationsAdvancedTestAction.php in tests/
views_bulk_operations_test/ src/ Plugin/ Action/ ViewsBulkOperationsAdvancedTestAction.php - ViewsBulkOperationsPassTestAction.php in tests/
views_bulk_operations_test/ src/ Plugin/ Action/ ViewsBulkOperationsPassTestAction.php
File
- src/
Action/ ViewsBulkOperationsActionBase.php, line 17
Namespace
Drupal\views_bulk_operations\ActionView source
abstract class ViewsBulkOperationsActionBase extends ActionBase implements ViewsBulkOperationsActionInterface, ConfigurableInterface {
use ViewsBulkOperationsActionCompletedTrait;
/**
* Action context.
*
* @var array
* Contains view data and optionally batch operation context.
*/
protected $context;
/**
* The processed view.
*
* @var \Drupal\views\ViewExecutable
*/
protected $view;
/**
* Configuration array.
*
* @var array
*/
protected $configuration;
/**
* {@inheritdoc}
*/
public function setContext(array &$context) {
$this->context['sandbox'] =& $context['sandbox'];
foreach ($context as $key => $item) {
if ($key === 'sandbox') {
continue;
}
$this->context[$key] = $item;
}
}
/**
* {@inheritdoc}
*/
public function setView(ViewExecutable $view) {
$this->view = $view;
}
/**
* {@inheritdoc}
*/
public function executeMultiple(array $objects) {
$results = [];
foreach ($objects as $entity) {
$results[] = $this
->execute($entity);
}
return $results;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [];
}
/**
* Default configuration form validator.
*
* This method will be needed if a child class will implement
* \Drupal\Core\Plugin\PluginFormInterface. Code saver.
*
* @param array &$form
* Form array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
}
/**
* Default configuration form submit handler.
*
* This method will be needed if a child class will implement
* \Drupal\Core\Plugin\PluginFormInterface. Code saver.
*
* @param array &$form
* Form array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$form_state
->cleanValues();
foreach ($form_state
->getValues() as $key => $value) {
$this->configuration[$key] = $value;
}
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
return $this->configuration;
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
$this->configuration = $configuration;
}
/**
* Default custom access callback.
*
* @param \Drupal\Core\Session\AccountInterface $account
* The user the access check needs to be preformed against.
* @param \Drupal\views\ViewExecutable $view
* The View Bulk Operations view data.
*
* @return bool
* Has access.
*/
public static function customAccess(AccountInterface $account, ViewExecutable $view) {
return TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ActionInterface:: |
public | function | Checks object access. | 19 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
ExecutableInterface:: |
public | function | Executes the plugin. | 21 |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
ViewsBulkOperationsActionBase:: |
protected | property |
Configuration array. Overrides PluginBase:: |
|
ViewsBulkOperationsActionBase:: |
protected | property | Action context. | |
ViewsBulkOperationsActionBase:: |
protected | property | The processed view. | |
ViewsBulkOperationsActionBase:: |
public static | function | Default custom access callback. | |
ViewsBulkOperationsActionBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
|
ViewsBulkOperationsActionBase:: |
public | function |
Execute action on multiple entities. Overrides ActionBase:: |
1 |
ViewsBulkOperationsActionBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
ViewsBulkOperationsActionBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
ViewsBulkOperationsActionBase:: |
public | function |
Set action context. Overrides ViewsBulkOperationsActionInterface:: |
|
ViewsBulkOperationsActionBase:: |
public | function |
Set view object. Overrides ViewsBulkOperationsActionInterface:: |
|
ViewsBulkOperationsActionBase:: |
public | function | Default configuration form submit handler. | 1 |
ViewsBulkOperationsActionBase:: |
public | function | Default configuration form validator. | |
ViewsBulkOperationsActionCompletedTrait:: |
public static | function | Batch finished callback. | 1 |
ViewsBulkOperationsActionCompletedTrait:: |
public static | function | Set message function wrapper. | 1 |
ViewsBulkOperationsActionCompletedTrait:: |
public static | function | Translation function wrapper. | 1 |