Defines a simple bulk operation form element.
@Plugin(
  id = "action_bulk_form",
  module = "action"
)
Expanded class hierarchy of BulkForm
class BulkForm extends FieldPluginBase {
  /**
   * 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 \Drupal\views\Plugin\views\style\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'] = '';
    }
  }
  /**
   * Implements \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::views_form().
   */
  public function views_form(&$form, &$form_state) {
    // Add the tableselect javascript.
    $form['#attached']['library'][] = array(
      'system',
      'drupal.tableselect',
    );
    // Render checkboxes for all rows.
    foreach ($this->view->result as $row_index => $row) {
      $entity_id = $this
        ->get_value($row);
      $form[$this->options['id']][$row_index] = array(
        '#type' => 'checkbox',
        '#default_value' => FALSE,
      );
    }
    $form[$this->options['id']]['#tree'] = TRUE;
    // Get all available actions.
    $actions = action_get_all_actions();
    $entity_type = $this
      ->getEntityType();
    // Filter actions by the entity type and build options for the form.
    $actions = array_filter($actions, function ($action) use ($entity_type) {
      return $action['type'] == $entity_type && empty($action['configurable']);
    });
    $options = array_map(function ($action) {
      return $action['label'];
    }, $actions);
    $form['action'] = array(
      '#type' => 'select',
      '#title' => t('Action'),
      '#options' => $options,
      '#description' => t('Select the action you want to execute on the content entitites.'),
    );
    // Move the submit button beside the selection.
    $form['actions']['#weight'] = 1;
    // Replace the text with Update.
    $form['actions']['submit']['#value'] = t('Update');
    // Put the submit button both at the top and bottom.
    $form['actions_bottom'] = $form['actions'];
    $form['actions_bottom']['#weight'] = 100;
  }
  /**
   * Implements \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::views_form_submit().
   */
  public function views_form_submit(&$form, &$form_state) {
    if ($form_state['step'] == 'views_form_views_form') {
      $action = $form_state['values']['action'];
      $action = action_load($action);
      $count = 0;
      // Filter only selected checkboxes.
      $selected = array_filter($form_state['values'][$this->options['id']]);
      if (!empty($selected)) {
        foreach (array_keys($selected) as $row_index) {
          $entity = $this
            ->get_entity($this->view->result[$row_index]);
          actions_do($action->aid, $entity);
          $entity
            ->save();
          $count++;
        }
      }
      if ($count) {
        drupal_set_message(t('%action action performed on %count item(s).', array(
          '%action' => $action->label,
          '%count' => $count,
        )));
      }
    }
  }
  /**
   * Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::query().
   */
  public function query() {
  }
}| Name   | Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| BulkForm:: | public | function | Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::pre_render(). Overrides FieldPluginBase:: | |
| BulkForm:: | public | function | Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::query(). Overrides FieldPluginBase:: | |
| BulkForm:: | public | function | Overrides \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::render(). Overrides FieldPluginBase:: | |
| BulkForm:: | public | function | Implements \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::views_form(). | |
| BulkForm:: | public | function | Implements \Drupal\views\Plugin\views\Plugin\field\FieldPluginBase::views_form_submit(). | |
| 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:: | function | Add 'additional' fields to the query. | ||
| FieldPluginBase:: | 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:: | function | Render a field using advanced settings. | ||
| FieldPluginBase:: | 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:: | 27 | 
| FieldPluginBase:: | function | Called to determine what to tell the clicksorter. | 1 | |
| FieldPluginBase:: | function | Determine if this field is click sortable. | 1 | |
| FieldPluginBase:: | protected | function | Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides HandlerBase:: | 28 | 
| FieldPluginBase:: | function | Document any special tokens this field might use for itself. | 3 | |
| FieldPluginBase:: | function | Return the class of the field. | ||
| FieldPluginBase:: | function | Return the class of the field's label. | ||
| FieldPluginBase:: | function | Return an HTML element for the label based upon the field's element type. | ||
| FieldPluginBase:: | function | Return an HTML element based upon the field's element type. | 1 | |
| FieldPluginBase:: | function | Return the class of the field's wrapper. | ||
| FieldPluginBase:: | function | Return an HTML element for the wrapper based upon the field's element type. | ||
| FieldPluginBase:: | function | Provide a list of elements valid for field HTML. | ||
| FieldPluginBase:: | function | Get the entity matching the current row and relationship. | ||
| FieldPluginBase:: | function | Get the 'render' tokens to use for advanced rendering. | ||
| FieldPluginBase:: | function | Recursive function to add replacements for nested query string parameters. | ||
| FieldPluginBase:: | function | Get the value that's supposed to be rendered. | 1 | |
| FieldPluginBase:: | public | function | Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase:: | 18 | 
| FieldPluginBase:: | function | Checks if a field value is empty. | ||
| FieldPluginBase:: | public | function | Get this field's label. | |
| FieldPluginBase:: | function | Render this field as altered text, from a fieldset set by the user. | ||
| FieldPluginBase:: | function | Render this field as a link, with the info from a fieldset set by the user. | ||
| FieldPluginBase:: | function | Perform an advanced text render for the item. | ||
| FieldPluginBase:: | 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:: | function | Replace a value with tokens from the last field. | ||
| FieldPluginBase:: | 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 | 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 | 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 | function | Creates cross-database SQL dates. | |
| HandlerBase:: | public | function | Creates cross-database SQL date formatting. | |
| HandlerBase:: | public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
| HandlerBase:: | public static | function | Figure out what timezone we're in; needed for some date manipulations. | |
| 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:: | protected | 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 | 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:: | 4 | 
| HandlerBase:: | public | function | Constructs a Handler object. Overrides PluginBase:: | |
| PluginBase:: | protected | property | Configuration information passed into the plugin. | 1 | 
| PluginBase:: | public | property | Plugins's definition | |
| PluginBase:: | protected | property | The discovery object. | |
| 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_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 | Provide a list of additional theme functions for the theme information page | |
| PluginBase:: | public | function | Clears a plugin. | 2 | 
| PluginBase:: | public | function | Returns an array of available token replacements. | |
| PluginBase:: | public | function | Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: | |
| PluginBase:: | public | function | Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). 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 | ||
| 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 |