views_bulk_operations_plugin_style.inc in Views Bulk Operations (VBO) 6

File

views_bulk_operations_plugin_style.inc

<?php

class views_bulk_operations_plugin_style extends views_plugin_style_table {
  var $all_operations = array();

  /**
   * Implementation of views_plugin::init().
   */
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);
    $this
      ->populate_operations();
  }

  /**
   * Implementation of views_plugin::option_definition().
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['operations'] = array(
      'default' => array(),
    );
    $options['execution_type'] = array(
      'default' => VBO_EXECUTION_DIRECT,
    );
    $options['max_performance'] = array(
      'default' => 0,
    );
    $options['display_type'] = array(
      'default' => 0,
    );
    $options['display_result'] = array(
      'default' => TRUE,
    );
    $options['merge_single_action'] = array(
      'default' => TRUE,
    );
    $options['hide_selector'] = array(
      'default' => FALSE,
    );
    $options['preserve_selection'] = array(
      'default' => TRUE,
    );
    return $options;
  }

  /**
   * Implementation of views_plugin::options_form().
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $execution = array(
      VBO_EXECUTION_DIRECT => t('Invoke them directly'),
      VBO_EXECUTION_BATCH => t('Use Batch API'),
    );
    if (module_exists('drupal_queue')) {
      $execution[VBO_EXECUTION_QUEUE] = t('Use <a href="@drupalqueue">Drupal Queue</a>', array(
        '@drupalqueue' => url('http://drupal.org/project/drupal_queue'),
      ));
    }
    $form['execution_type'] = array(
      '#type' => 'radios',
      '#title' => t('To execute operations'),
      '#default_value' => $this->options['execution_type'],
      '#options' => $execution,
    );
    $form['max_performance'] = array(
      '#type' => 'checkbox',
      '#title' => t('Maximize Batch API performance'),
      '#description' => t('If checked, each batch process will execute as many rows as possible within the server resource limits.'),
      '#default_value' => $this->options['max_performance'],
    );
    $form['display_type'] = array(
      '#type' => 'radios',
      '#title' => t('Display operations as'),
      '#default_value' => $this->options['display_type'],
      '#options' => array(
        t('Dropdown selectbox with Submit button'),
        t('Each action as a separate button'),
      ),
    );
    $form['hide_selector'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide selector dropdown'),
      '#description' => t('Check this box to hide the selector dropdown.'),
      '#default_value' => $this->options['hide_selector'],
    );
    $form['preserve_selection'] = array(
      '#type' => 'checkbox',
      '#title' => t('Preserve selection across pages'),
      '#description' => t('Check this box to preserve item selection across multiple pages. Requires JavaScript.'),
      '#default_value' => $this->options['preserve_selection'],
    );
    $form['display_result'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display processing result'),
      '#description' => t('Check this box to let Drupal display a message with the result of processing the selected objects.'),
      '#default_value' => $this->options['display_result'],
    );
    $form['merge_single_action'] = array(
      '#type' => 'checkbox',
      '#title' => t('Merge single action\'s form with item selection view'),
      '#description' => t('In case only one action is selected *and* this action is configurable, display its action form along with the item selection view.'),
      '#default_value' => $this->options['merge_single_action'],
    );

    // Display operations and their settings.
    $form['operations'] = array(
      '#tree' => TRUE,
      '#type' => 'fieldset',
      '#title' => t('Selected operations'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    foreach ($this
      ->get_operations_options() as $key => $label) {
      $dom_id = 'edit-style-options-operations-' . str_replace('_', '-', $key) . '-selected';
      $form['operations'][$key]['selected'] = array(
        '#type' => 'checkbox',
        '#title' => $label,
        '#default_value' => @$this->options['operations'][$key]['selected'],
      );
      $form['operations'][$key]['skip_confirmation'] = array(
        '#type' => 'checkbox',
        '#title' => t('Skip confirmation step'),
        '#default_value' => @$this->options['operations'][$key]['skip_confirmation'],
        '#process' => array(
          'views_process_dependency',
        ),
        '#dependency' => array(
          $dom_id => array(
            1,
          ),
        ),
      );
      $form['operations'][$key]['label'] = array(
        '#type' => 'textfield',
        '#title' => t('Override label'),
        '#default_value' => @$this->options['operations'][$key]['label'],
        '#process' => array(
          'views_process_dependency',
        ),
        '#dependency' => array(
          $dom_id => array(
            1,
          ),
        ),
      );
      $form_function = $this->all_operations[$key]['callback'] . '_views_bulk_operations_form';
      if (function_exists($form_function)) {
        $form_settings = call_user_func($form_function, @$this->options['operations'][$key]['settings']);
        foreach (element_children($form_settings) as $child) {

          // The views dependency code requires special handling for checkboxes.
          if (isset($form_settings[$child]['#type']) && $form_settings[$child]['#type'] == 'checkboxes') {
            $child_wrapper_id = 'edit-style-options-operations-' . str_replace('_', '-', $key) . '-settings-' . str_replace('_', '-', $child) . '-wrapper';
            $form_settings[$child] += array(
              '#prefix' => '<div id="' . $child_wrapper_id . '"><div>',
              '#suffix' => '</div></div>',
              '#process' => array(
                'expand_checkboxes',
                'views_process_dependency',
              ),
              '#dependency' => array(
                $dom_id => array(
                  1,
                ),
              ),
            );
          }
          else {
            $form_settings[$child] += array(
              '#process' => array(
                'views_process_dependency',
              ),
              '#dependency' => array(
                $dom_id => array(
                  1,
                ),
              ),
            );
          }
        }
        $form['operations'][$key]['settings'] = $form_settings;
      }
    }
  }

  /**
   * Implementation of views_plugin::options_validate().
   */
  function options_validate(&$form, &$form_state) {
    foreach ($form_state['values']['style_options']['operations'] as $key => &$options) {
      if (empty($options['selected'])) {
        continue;
      }
      if (!isset($options['settings'])) {
        continue;
      }
      $operation = $this->all_operations[$key];
      $form_function = $operation['callback'] . '_views_bulk_operations_form_validate';
      if (function_exists($form_function)) {
        $options['settings']['_error_element_base'] = 'style_options][operations][' . $key . '][settings][';
        call_user_func($form_function, $form, array(
          'values' => $options['settings'],
        ));
      }
    }
  }

  /**
   * Implementation of views_plugin::options_submit().
   */
  function options_submit(&$form, &$form_state) {
    foreach ($form_state['values']['style_options']['operations'] as $key => $options) {
      if (empty($options['selected'])) {
        continue;
      }
      if (!isset($options['settings'])) {
        continue;
      }
      $operation = $this->all_operations[$key];
      $form_function = $operation['callback'] . '_views_bulk_operations_form_submit';
      if (function_exists($form_function)) {
        call_user_func($form_function, $form, array(
          'values' => $options['settings'],
        ));
      }
    }

    // Reset runtime settings for this view.
    unset($_SESSION['vbo_values'][$this->view->name]);
  }

  /**
   * Implementation of views_plugin::query().
   */
  function query() {

    // Add base field if not present in the query.
    if (!isset($this->view->query->fields[$this->view->base_field])) {
      $this->view->query
        ->add_field($this->view->base_table, $this->view->base_field);
    }
  }

  /**
   * Implementation of views_plugin::render().
   */
  function render() {

    // Client code might flag to skip rendering if we just want to build complete results.
    if (!empty($this->view->skip_render)) {
      return;
    }

    // We build the groups here to pass them to the node_selector function through the form.
    $this->sets = $this
      ->render_grouping($this->view->result, $this->options['grouping']);

    // Create a form ID for the form using the name and display of the view.
    $parts = array(
      'views_bulk_operations_form',
      $this->view->name,
      $this->view->current_display,
    );
    $this->form_id = implode('_', $parts);

    // Populate hashed results for selection.
    $this->result = array();
    foreach ($this->view->result as $row) {
      $this->result[_views_bulk_operations_hash_object($row, $this->view)] = $row;
    }
    if ($this->options['preserve_selection']) {
      $view_id = _views_bulk_operations_view_id($this->view);
      $view_name = $this->view->name;
      if (empty($_SESSION['vbo_values'][$view_name][$view_id]['result'])) {
        $_SESSION['vbo_values'][$view_name][$view_id]['result'] = array();
      }
      $_SESSION['vbo_values'][$view_name][$view_id]['result'] += $this->result;
    }

    // Copy the plugin globally because we might need it during form validation.
    global $vbo_plugins;
    $vbo_plugins[$this->form_id] = $this;

    // Rendering the plugin as a form.
    return drupal_get_form($this->form_id, $this);
  }

  /**
   * API function to get list of selected operations.
   */
  function get_selected_operations() {
    $selected = array();
    foreach ($this->options['operations'] as $key => $options) {
      if (empty($options['selected'])) {
        continue;
      }
      if (empty($this->all_operations[$key])) {
        continue;
      }
      if (module_exists('actions_permissions')) {
        $perm = actions_permissions_get_perm($this->all_operations[$key]['label'], $this->all_operations[$key]['callback']);
        if (!user_access($perm)) {
          continue;
        }
      }
      if (!empty($this->all_operations[$key]['permissions'])) {
        foreach ($this->all_operations[$key]['permissions'] as $perm) {
          if (!user_access($perm)) {
            continue 2;
          }
        }
      }
      $selected[$key] = !empty($this->options['operations'][$key]['label']) ? t($this->options['operations'][$key]['label']) : $this->all_operations[$key]['label'];
    }
    return $selected;
  }

  /**
   * API function to get operation information.
   */
  function get_operation_info($key) {
    if (empty($this->all_operations[$key])) {
      return NULL;
    }
    $operation = $this->all_operations[$key];
    $operation['perm label'] = $operation['label'];
    if (!empty($this->options['operations'][$key]['label'])) {
      $operation['label'] = t($this->options['operations'][$key]['label']);
    }
    $operation['options'] = $this->options['operations'][$key] + array(
      'settings' => NULL,
    );
    return $operation;
  }
  function get_operations_options() {
    static $options = array();
    if (empty($options)) {
      $object_info = _views_bulk_operations_object_info_for_view($this->view);
      if (!$object_info) {
        return $options;
      }
      foreach ($this->all_operations as $key => $operation) {
        if ($operation['type'] == $object_info['type'] || $operation['type'] == 'system' || in_array($object_info['hook'], (array) $operation['hooks'])) {
          $options[$key] = $operation['label'] . ' (' . $key . ')';
        }
      }
    }
    return $options;
  }
  function populate_operations() {
    module_load_include('inc', 'node', 'node.admin');
    $operations = array();
    foreach (_views_bulk_operations_get_object_info() as $object_type => $object_info) {
      $hook_name = $object_type . '_operations';
      foreach (module_invoke_all($hook_name) as $operation) {
        if (empty($operation['callback'])) {
          continue;
        }
        $key = $operation['callback'] . (empty($operation['callback arguments']) ? '' : '-' . md5(serialize($operation['callback arguments'])));
        if (!isset($operation['behavior'])) {

          // assume operations modify nodes by default
          $operation['behavior'] = array(
            'changes_node_property',
          );
        }
        $operations[$key] = array(
          'key' => $key,
          'label' => $operation['label'],
          'callback' => $operation['callback'],
          'callback arguments' => isset($operation['callback arguments']) ? $operation['callback arguments'] : array(),
          'configurable' => isset($operation['configurable']) ? $operation['configurable'] : FALSE,
          'form properties' => isset($operation['form properties']) ? $operation['form properties'] : array(),
          'source' => 'operation',
          'type' => $object_type,
          'aggregate' => isset($operation['aggregate']) ? (int) $operation['aggregate'] : VBO_AGGREGATE_OPTIONAL,
          'access op' => $this
            ->get_access_op($operation),
          'permissions' => isset($operation['permissions']) ? $operation['permissions'] : NULL,
          'hooks' => array(),
        );
      }
    }
    $action_operations = actions_list() + $this
      ->get_custom_actions();
    foreach ($action_operations as $callback => $operation) {
      $key = isset($operation['key']) ? $operation['key'] : $callback;
      $operations[$key] = array(
        'key' => $key,
        'label' => $operation['description'],
        'callback' => isset($operation['callback']) ? $operation['callback'] : $callback,
        'callback arguments' => isset($operation['parameters']) ? $operation['parameters'] : array(),
        'configurable' => isset($operation['configurable']) ? $operation['configurable'] : FALSE,
        'form properties' => isset($operation['form properties']) ? $operation['form properties'] : array(),
        'source' => 'action',
        'type' => $operation['type'],
        'aggregate' => isset($operation['aggregate']) ? (int) $operation['aggregate'] : VBO_AGGREGATE_FORBIDDEN,
        'access op' => $this
          ->get_access_op($operation),
        'permissions' => isset($operation['permissions']) ? $operation['permissions'] : NULL,
        'hooks' => isset($operation['hooks']) ? array_keys((array) $operation['hooks']) : array(),
      );
    }
    uasort($operations, create_function('$a, $b', 'return strcasecmp($a["label"], $b["label"]);'));
    $this->all_operations = $operations;
  }
  function get_access_op($operation) {
    $access_op = 0;
    if (isset($operation['behavior'])) {
      if (in_array('views_node_property', $operation['behavior'])) {
        $access_op |= VBO_ACCESS_OP_VIEW;
      }
      if (in_array('changes_node_property', $operation['behavior'])) {
        $access_op |= VBO_ACCESS_OP_UPDATE;
      }
      if (in_array('creates_node_property', $operation['behavior'])) {
        $access_op |= VBO_ACCESS_OP_CREATE;
      }
      if (in_array('deletes_node_property', $operation['behavior'])) {
        $access_op |= VBO_ACCESS_OP_DELETE;
      }
    }
    return $access_op;
  }
  function get_custom_actions() {
    $actions = array();
    $static_actions = actions_list();
    $result = db_query("SELECT * FROM {actions} WHERE parameters > ''");
    while ($action = db_fetch_object($result)) {
      $parameters = unserialize($action->parameters);
      $actions[$action->aid] = array(
        'description' => $action->description,
        'type' => $action->type,
        'configurable' => FALSE,
        'parameters' => $parameters,
        'key' => $action->callback . (empty($parameters) ? '' : '-' . md5($action->parameters)),
      );
      foreach (array(
        'callback',
        'behavior',
        'aggregate',
        'permissions',
        'hooks',
        'form properties',
      ) as $attribute) {
        if (isset($static_actions[$action->callback][$attribute])) {
          $actions[$action->aid][$attribute] = $static_actions[$action->callback][$attribute];
        }
      }
      if (isset($static_actions[$action->callback]['parameters'])) {
        $actions[$action->aid]['parameters'] = array_merge($actions[$action->aid]['parameters'], $static_actions[$action->callback]['parameters']);
      }
    }
    return $actions;
  }

}

Classes

Name	Description
views_bulk_operations_plugin_style