You are here

class ViewsBulkOperationsPassTestAction in Views Bulk Operations (VBO) 8

Same name and namespace in other branches
  1. 8.3 tests/views_bulk_operations_test/src/Plugin/Action/ViewsBulkOperationsPassTestAction.php \Drupal\views_bulk_operations_test\Plugin\Action\ViewsBulkOperationsPassTestAction
  2. 8.2 tests/views_bulk_operations_test/src/Plugin/Action/ViewsBulkOperationsPassTestAction.php \Drupal\views_bulk_operations_test\Plugin\Action\ViewsBulkOperationsPassTestAction
  3. 4.0.x tests/views_bulk_operations_test/src/Plugin/Action/ViewsBulkOperationsPassTestAction.php \Drupal\views_bulk_operations_test\Plugin\Action\ViewsBulkOperationsPassTestAction

Action for test purposes only.

Plugin annotation


@Action(
  id = "views_bulk_operations_passing_test_action",
  label = @Translation("VBO parameters passing test action"),
  type = "node",
  pass_view = TRUE,
  pass_context = TRUE,
)

Hierarchy

Expanded class hierarchy of ViewsBulkOperationsPassTestAction

File

tests/views_bulk_operations_test/src/Plugin/Action/ViewsBulkOperationsPassTestAction.php, line 19

Namespace

Drupal\views_bulk_operations_test\Plugin\Action
View source
class ViewsBulkOperationsPassTestAction extends ViewsBulkOperationsActionBase {

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $nodes) {
    if (!empty($this->context['sandbox'])) {
      drupal_set_message(sprintf('Processed %s of %s.', $this->context['sandbox']['processed'], $this->context['sandbox']['total']));
    }

    // Check if the passed view result rows contain the correct nodes.
    if (empty($this->context['sandbox']['result_pass_error'])) {
      $this->view->result = array_values($this->view->result);
      foreach ($nodes as $index => $node) {
        $result_node = $this->view->result[$index]->_entity;
        if ($node
          ->id() !== $result_node
          ->id() || $node
          ->label() !== $result_node
          ->label()) {
          $this->context['sandbox']['result_pass_error'] = TRUE;
        }
      }
    }
    $batch_size = isset($this->context['sandbox']['batch_size']) ? $this->context['sandbox']['batch_size'] : 0;
    $total = isset($this->context['sandbox']['total']) ? $this->context['sandbox']['total'] : 0;
    $processed = isset($this->context['sandbox']['processed']) ? $this->context['sandbox']['processed'] : 0;

    // On last batch display message if passed rows match.
    if ($processed + $batch_size >= $total) {
      if (empty($this->context['sandbox']['result_pass_error'])) {
        drupal_set_message('Passed view results match the entity queue.');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    $this
      ->executeMultiple([
      $entity,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    return $object
      ->access('update', $account, $return_as_object);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
ViewsBulkOperationsActionBase::$configuration protected property Configuration array. Overrides PluginBase::$configuration
ViewsBulkOperationsActionBase::$context protected property Action context.
ViewsBulkOperationsActionBase::$view protected property The processed view.
ViewsBulkOperationsActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ViewsBulkOperationsActionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration
ViewsBulkOperationsActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
ViewsBulkOperationsActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
ViewsBulkOperationsActionBase::setContext public function Set action context. Overrides ViewsBulkOperationsActionInterface::setContext
ViewsBulkOperationsActionBase::setView public function Set view object. Overrides ViewsBulkOperationsActionInterface::setView
ViewsBulkOperationsActionBase::submitConfigurationForm public function Default configuration form submit handler. 1
ViewsBulkOperationsActionBase::validateConfigurationForm public function Default configuration form validator.
ViewsBulkOperationsPassTestAction::access public function Checks object access. Overrides ActionInterface::access
ViewsBulkOperationsPassTestAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ViewsBulkOperationsPassTestAction::executeMultiple public function Execute action on multiple entities. Overrides ViewsBulkOperationsActionBase::executeMultiple