class ViewsBulkOperationExampleAction in Views Bulk Operations (VBO) 4.0.x
Same name and namespace in other branches
- 8.3 modules/views_bulk_operations_example/src/Plugin/Action/ViewsBulkOperationExampleAction.php \Drupal\views_bulk_operations_example\Plugin\Action\ViewsBulkOperationExampleAction
- 8 modules/views_bulk_operations_example/src/Plugin/Action/ViewsBulkOperationExampleAction.php \Drupal\views_bulk_operations_example\Plugin\Action\ViewsBulkOperationExampleAction
- 8.2 modules/views_bulk_operations_example/src/Plugin/Action/ViewsBulkOperationExampleAction.php \Drupal\views_bulk_operations_example\Plugin\Action\ViewsBulkOperationExampleAction
An example action covering most of the possible options.
If type is left empty, action will be selectable for all entity types.
Plugin annotation
@Action(
id = "views_bulk_operations_example",
label = @Translation("VBO example action"),
type = "",
confirm = TRUE,
)
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\views_bulk_operations_example\Plugin\Action\ViewsBulkOperationExampleAction implements PluginFormInterface, ViewsBulkOperationsPreconfigurationInterface
- 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 ViewsBulkOperationExampleAction
File
- modules/
views_bulk_operations_example/ src/ Plugin/ Action/ ViewsBulkOperationExampleAction.php, line 24
Namespace
Drupal\views_bulk_operations_example\Plugin\ActionView source
class ViewsBulkOperationExampleAction extends ViewsBulkOperationsActionBase implements ViewsBulkOperationsPreconfigurationInterface, PluginFormInterface {
/**
* {@inheritdoc}
*/
public function execute($entity = NULL) {
/*
* All config resides in $this->configuration.
* Passed view rows will be available in $this->context.
* Data about the view used to select results and optionally
* the batch context are available in $this->context or externally
* through the public getContext() method.
* The entire ViewExecutable object with selected result
* rows is available in $this->view or externally through
* the public getView() method.
*/
// Do some processing..
// ...
$this
->messenger()
->addMessage($entity
->label() . ' - ' . $entity
->language()
->getId() . ' - ' . $entity
->id());
return sprintf('Example action (configuration: %s)', print_r($this->configuration, TRUE));
}
/**
* {@inheritdoc}
*/
public function buildPreConfigurationForm(array $form, array $values, FormStateInterface $form_state) {
$form['example_preconfig_setting'] = [
'#title' => $this
->t('Example setting'),
'#type' => 'textfield',
'#default_value' => isset($values['example_preconfig_setting']) ? $values['example_preconfig_setting'] : '',
];
return $form;
}
/**
* Configuration form builder.
*
* If this method has implementation, the action is
* considered to be configurable.
*
* @param array $form
* Form array.
* @param Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*
* @return array
* The configuration form.
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['example_config_setting'] = [
'#title' => t('Example setting pre-execute'),
'#type' => 'textfield',
'#default_value' => $form_state
->getValue('example_config_setting'),
];
return $form;
}
/**
* Submit handler for the action configuration form.
*
* If not implemented, the cleaned form values will be
* passed directly to the action $configuration parameter.
*
* @param array $form
* Form array.
* @param Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
// This is not required here, when this method is not defined,
// form values are assigned to the action configuration by default.
// This function is a must only when user input processing is needed.
$this->configuration['example_config_setting'] = $form_state
->getValue('example_config_setting');
}
/**
* {@inheritdoc}
*/
public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
if ($object
->getEntityType() === 'node') {
$access = $object
->access('update', $account, TRUE)
->andIf($object->status
->access('edit', $account, TRUE));
return $return_as_object ? $access : $access
->isAllowed();
}
// Other entity types may have different
// access methods and properties.
return TRUE;
}
}