Defines a generic bulk operation form element.
Expanded class hierarchy of BulkFormBase
abstract class BulkFormBase extends FieldPluginBase {
  /**
   * An array of actions that can be executed.
   *
   * @var array
   */
  protected $actions = array();
  /**
   * Constructs a new BulkForm object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityManager $manager
   *   The entity manager.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityManager $manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->actions = $manager
      ->getStorageController('action')
      ->load();
  }
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, array $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.entity'));
  }
  /**
   * Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::render().
   */
  public function render($values) {
    return '<!--form-item-' . $this->options['id'] . '--' . $this->view->row_index . '-->';
  }
  /**
   * Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::pre_render().
   */
  public function pre_render(&$values) {
    parent::pre_render($values);
    // If the view is using a table style, provide a placeholder for a
    // "select all" checkbox.
    if (!empty($this->view->style_plugin) && $this->view->style_plugin instanceof Table) {
      // Add the tableselect css classes.
      $this->options['element_label_class'] .= 'select-all';
      // Hide the actual label of the field on the table header.
      $this->options['label'] = '';
    }
  }
  /**
   * Form constructor for the bulk form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array $form_state
   *   An associative array containing the current state of the form.
   */
  public function views_form(&$form, &$form_state) {
    // Add the tableselect javascript.
    $form['#attached']['library'][] = array(
      'system',
      'drupal.tableselect',
    );
    // Only add the bulk form options and buttons if there are results.
    if (!empty($this->view->result)) {
      // Render checkboxes for all rows.
      $form[$this->options['id']]['#tree'] = TRUE;
      foreach ($this->view->result as $row_index => $row) {
        $form[$this->options['id']][$row_index] = array(
          '#type' => 'checkbox',
          // We are not able to determine a main "title" for each row, so we can
          // only output a generic label.
          '#title' => t('Update this item'),
          '#title_display' => 'invisible',
          '#default_value' => !empty($form_state['values'][$this->options['id']][$row_index]) ? 1 : NULL,
        );
      }
      // Replace the form submit button label.
      $form['actions']['submit']['#value'] = t('Apply');
      // Ensure a consistent container for filters/operations in the view header.
      $form['header'] = array(
        '#type' => 'container',
        '#weight' => -100,
      );
      // Build the bulk operations action widget for the header.
      // Allow themes to apply .container-inline on this separate container.
      $form['header'][$this->options['id']] = array(
        '#type' => 'container',
      );
      $form['header'][$this->options['id']]['action'] = array(
        '#type' => 'select',
        '#title' => t('With selection'),
        '#options' => $this
          ->getBulkOptions(),
      );
      // Duplicate the form actions into the action container in the header.
      $form['header'][$this->options['id']]['actions'] = $form['actions'];
    }
    else {
      // Remove the default actions build array.
      unset($form['actions']);
    }
  }
  /**
   * Returns the available operations for this form.
   *
   * @return array
   *   An associative array of operations, suitable for a select element.
   */
  protected function getBulkOptions() {
    return array_map(function ($action) {
      return $action
        ->label();
    }, $this->actions);
  }
  /**
   * Submit handler for the bulk form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array $form_state
   *   An associative array containing the current state of the form.
   */
  public function views_form_submit(&$form, &$form_state) {
    if ($form_state['step'] == 'views_form_views_form') {
      // Filter only selected checkboxes.
      $selected = array_filter($form_state['values'][$this->options['id']]);
      $entities = array();
      foreach (array_intersect_key($this->view->result, $selected) as $row) {
        $entity = $this
          ->getEntity($row);
        $entities[$entity
          ->id()] = $entity;
      }
      $action = $this->actions[$form_state['values']['action']];
      $action
        ->execute($entities);
      $operation_definition = $action
        ->getPluginDefinition();
      if (!empty($operation_definition['confirm_form_path'])) {
        $form_state['redirect'] = $operation_definition['confirm_form_path'];
      }
    }
  }
  /**
   * Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::query().
   */
  public function query() {
  }
  /**
   * {@inheritdoc}
   */
  public function clickSortable() {
    return FALSE;
  }
}| Name   | Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| BulkFormBase:: | protected | property | An array of actions that can be executed. | |
| BulkFormBase:: | public | function | Determine if this field is click sortable. Overrides FieldPluginBase:: | |
| BulkFormBase:: | public static | function | Creates an instance of the plugin. Overrides ContainerFactoryPluginBase:: | |
| BulkFormBase:: | protected | function | Returns the available operations for this form. | 1 | 
| BulkFormBase:: | public | function | Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::pre_render(). Overrides FieldPluginBase:: | |
| BulkFormBase:: | public | function | Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::query(). Overrides FieldPluginBase:: | |
| BulkFormBase:: | public | function | Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::render(). Overrides FieldPluginBase:: | |
| BulkFormBase:: | public | function | Form constructor for the bulk form. | 1 | 
| BulkFormBase:: | public | function | Submit handler for the bulk form. | 2 | 
| BulkFormBase:: | public | function | Constructs a new BulkForm object. Overrides HandlerBase:: | 2 | 
| FieldPluginBase:: | property | Stores additional fields which get's added to the query. The generated aliases are stored in $aliases. | ||
| FieldPluginBase:: | property | |||
| FieldPluginBase:: | property | |||
| FieldPluginBase:: | public | property | The field value prior to any rewriting. | |
| FieldPluginBase:: | protected | function | Add 'additional' fields to the query. | |
| FieldPluginBase:: | protected | function | Add any special tokens this field might use for itself. | 4 | 
| FieldPluginBase:: | public | function | Return a string representing this handler's name in the UI. Overrides HandlerBase:: | 1 | 
| FieldPluginBase:: | public | function | Provide extra data to the administration form Overrides HandlerBase:: | |
| FieldPluginBase:: | public | function | Render a field using advanced settings. | |
| FieldPluginBase:: | protected | function | Determine if this field can allow advanced rendering. | 1 | 
| FieldPluginBase:: | public | function | Default options form that provides the label widget that all fields
should have. Overrides HandlerBase:: | 32 | 
| FieldPluginBase:: | public | function | Called to determine what to tell the clicksorter. | 1 | 
| FieldPluginBase:: | protected | function | Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides HandlerBase:: | 33 | 
| FieldPluginBase:: | protected | function | Document any special tokens this field might use for itself. | 3 | 
| FieldPluginBase:: | public | function | Return the class of the field. | |
| FieldPluginBase:: | public | function | Return the class of the field's label. | |
| FieldPluginBase:: | public | function | Return an HTML element for the label based upon the field's element type. | |
| FieldPluginBase:: | public | function | Return an HTML element based upon the field's element type. | 1 | 
| FieldPluginBase:: | public | function | Return the class of the field's wrapper. | |
| FieldPluginBase:: | public | function | Return an HTML element for the wrapper based upon the field's element type. | |
| FieldPluginBase:: | public | function | Provide a list of elements valid for field HTML. | |
| FieldPluginBase:: | public | function | Gets the entity matching the current row and relationship. | |
| FieldPluginBase:: | protected | function | Returns all field lables of fields before this field. | |
| FieldPluginBase:: | public | function | Get the 'render' tokens to use for advanced rendering. | |
| FieldPluginBase:: | protected | function | Recursive function to add replacements for nested query string parameters. | |
| FieldPluginBase:: | public | function | Get the value that's supposed to be rendered. | 1 | 
| FieldPluginBase:: | public | function | Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase:: | 19 | 
| FieldPluginBase:: | public | function | Checks if a field value is empty. | |
| FieldPluginBase:: | public | function | Get this field's label. | |
| FieldPluginBase:: | protected | function | Render this field as altered text, from a fieldset set by the user. | |
| FieldPluginBase:: | protected | function | Render this field as a link, with the info from a fieldset set by the user. | |
| FieldPluginBase:: | public | function | Perform an advanced text render for the item. | |
| FieldPluginBase:: | public | function | Trim the field down to the specified length. | |
| FieldPluginBase:: | public | function | Performs some cleanup tasks on the options array before saving it. Overrides HandlerBase:: | |
| FieldPluginBase:: | function | Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily. | ||
| FieldPluginBase:: | public | function | Provide a full list of possible theme templates used by this style. Overrides PluginBase:: | |
| FieldPluginBase:: | public | function | Replace a value with tokens from the last field. | |
| FieldPluginBase:: | public static | function | Trims the field down to the specified length. | |
| FieldPluginBase:: | public | function | Determines if this field will be available as an option to group the result by in the style settings. | |
| HandlerBase:: | public | property | When a field has been moved this property is set. | |
| HandlerBase:: | public | property | When a table has been moved this property is set. | |
| HandlerBase:: | public | property | With field you can override the realField if the real field is not set. | |
| HandlerBase:: | public | property | Where the $query object will reside: | 1 | 
| HandlerBase:: | public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
| HandlerBase:: | public | property | The relationship used for this field. | |
| HandlerBase:: | public | property | The table this handler is attached to. | |
| HandlerBase:: | public | property | The alias of the table of this handler which is used in the query. | |
| HandlerBase:: | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | 
| HandlerBase:: | public | function | Check whether current user has access to this handler. | 6 | 
| HandlerBase:: | public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
| HandlerBase:: | public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
| HandlerBase:: | public | function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 | 
| HandlerBase:: | public | function | Render our chunk of the exposed handler form when selecting | 1 | 
| HandlerBase:: | public | function | Form for exposed handler options. | 2 | 
| HandlerBase:: | public | function | Provide a form for setting options. | 1 | 
| HandlerBase:: | public | function | Provide a form for aggregation settings. | 1 | 
| HandlerBase:: | public | function | Determine if a handler can be exposed. | 2 | 
| HandlerBase:: | protected | function | Transform a string by a certain method. | |
| HandlerBase:: | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | 
| HandlerBase:: | public | function | Provide defaults for the handler. | |
| HandlerBase:: | public | function | Displays the Expose form. | |
| HandlerBase:: | public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 | 
| HandlerBase:: | public | function | Get information about the exposed form for the form renderer. | 1 | 
| HandlerBase:: | public | function | Creates cross-database SQL dates. | |
| HandlerBase:: | public | function | Creates cross-database SQL date formatting. | |
| HandlerBase:: | public | function | Determines the entity type used by this handler. | |
| HandlerBase:: | public | function | Shortcut to get a handler's raw field value. | |
| HandlerBase:: | public | function | Get the join object that should be used for this handler. | |
| HandlerBase:: | public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
| HandlerBase:: | public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 | 
| HandlerBase:: | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | 
| HandlerBase:: | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
| HandlerBase:: | public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 | 
| HandlerBase:: | protected | function | Provides a unique placeholders for handlers. | |
| HandlerBase:: | public | function | Run after the view is executed, before the result is cached. | |
| HandlerBase:: | public | function | Run before the view is built. | 1 | 
| HandlerBase:: | public | function | Sanitize the value for output. | |
| HandlerBase:: | public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
| HandlerBase:: | public | function | Shortcut to display the expose/hide button. | 2 | 
| HandlerBase:: | public | function | Shortcut to display the exposed options form. | |
| HandlerBase:: | public | function | If set to remember exposed input in the session, store it there. | 1 | 
| HandlerBase:: | public | function | Submit the exposed handler form | |
| HandlerBase:: | public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
| HandlerBase:: | public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
| HandlerBase:: | public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 | 
| HandlerBase:: | public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
| HandlerBase:: | public | function | Provides the handler some groupby. | 2 | 
| HandlerBase:: | public | function | Validates the handler against the complete View. Overrides PluginBase:: | 1 | 
| HandlerBase:: | public | function | Validate the exposed handler form | 4 | 
| HandlerBase:: | public | function | Validate the options form. | 1 | 
| HandlerBase:: | public | function | Validate the options form. | |
| HandlerBase:: | public | function | Validate the options form. Overrides PluginBase:: | 5 | 
| PluginBase:: | protected | property | Configuration information passed into the plugin. | 1 | 
| PluginBase:: | public | property | Plugins's definition | |
| PluginBase:: | public | property | The display object this plugin is for. | |
| PluginBase:: | public | property | Options for this plugin will be held here. | |
| PluginBase:: | protected | property | The plugin implementation definition. | |
| PluginBase:: | protected | property | The plugin_id. | |
| PluginBase:: | protected | property | Denotes whether the plugin has an additional options form. | 8 | 
| PluginBase:: | public | property | The top object of a view. | 1 | 
| PluginBase:: | public | function | Clears a plugin. | 2 | 
| PluginBase:: | public | function | Returns an array of available token replacements. | |
| PluginBase:: | public | function | Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: | |
| PluginBase:: | public | function | Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: | |
| PluginBase:: | public | function | Adds elements for available core tokens to a form. | |
| PluginBase:: | public | function | Returns a string with any core tokens replaced. | |
| PluginBase:: | public | function | Return the human readable name of the display. | |
| PluginBase:: | protected | function | Fills up the options of the plugin with defaults. | |
| PluginBase:: | public | function | Returns the summary of the settings in the display. | 6 | 
| PluginBase:: | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
| PluginBase:: | public | function | Returns the usesOptions property. | 8 |