weight.views.inc in Weight 7

Views2 support for Weight module.

File

weight.views.inc

<?php

/**
 * @file
 * Views2 support for Weight module.
 */

/**
 * Implements hook_views_data().
 */
function weight_views_data() {
  $data['node_weight'] = array(
    'table' => array(
      'group' => t('Weight'),
      'join' => array(
        'node' => array(
          'table' => 'node',
          'left_field' => 'nid',
          'field' => 'nid',
        ),
      ),
    ),
    'weight' => array(
      'real field' => 'sticky',
      'title' => t('Weight'),
      // The item it appears as on the UI,
      'help' => t('The node weight.'),
      // The help that appears on the UI,
      'field' => array(
        'handler' => 'weight_handler_field_sticky',
        'click sortable' => TRUE,
      ),
      'filter' => array(
        'handler' => 'weight_handler_filter_weight',
        'label' => t('Weight'),
      ),
      'sort' => array(
        'handler' => 'weight_handler_sort',
      ),
    ),
  );
  $data['node_weight_stick'] = array(
    'table' => array(
      'group' => t('Weight'),
      'join' => array(
        'node' => array(
          'table' => 'node',
          'left_field' => 'nid',
          'field' => 'nid',
        ),
      ),
    ),
    'weight_stick' => array(
      'real field' => 'sticky',
      'title' => t('Weighted Sticky'),
      // The item it appears as on the UI,
      'help' => t('Checks if something really is sticky.'),
      // The help that appears on the UI,
      'filter' => array(
        'handler' => 'weight_handler_filter_sticky',
        'label' => t('Weighted Sticky'),
        'type' => 'yes-no',
      ),
    ),
  );
  return $data;
}

/**
 * Implements hook_views_plugins();
 */
function weight_views_plugins() {
  return array(
    'style' => array(
      'weight' => array(
        'title' => t('Weight Changer'),
        'help' => t('Displays rows in a table which allows weight change.  Be sure to add the Weight field and Sort by Weight.'),
        'handler' => 'views_plugin_style_table',
        'parent' => 'table',
        'path' => drupal_get_path('module', 'weight'),
        'theme' => 'weight_view_weight',
        'uses row plugin' => FALSE,
        'uses fields' => TRUE,
        'uses options' => TRUE,
        'type' => 'normal',
      ),
    ),
  );
}

/**
 * Implements hook_views_handlers().
 */
function weight_views_handlers() {
  return array(
    'info' => array(
      'path' => drupal_get_path('module', 'weight'),
    ),
    'handlers' => array(
      'weight_handler_field_sticky' => array(
        'parent' => 'views_handler_field_numeric',
      ),
      'weight_handler_sort' => array(
        'parent' => 'views_handler_sort',
      ),
      'weight_handler_filter_sticky' => array(
        'parent' => 'views_handler_filter_boolean_operator',
      ),
      'weight_handler_filter_weight' => array(
        'parent' => 'views_handler_filter_numeric',
      ),
    ),
  );
}

/**
 * Display a view as a weight changing table.
 */
function theme_weight_view_weight(&$vars) {
  $view = $vars['view'];
  $result = $vars['result'] = $vars['rows'];
  $rows = array();
  $options = $view->style_plugin->options;
  $handler = $view->style_plugin;
  $fields =& $view->field;
  $columns = $handler
    ->sanitize_columns($options['columns'], $fields);
  $active = !empty($handler->active) ? $handler->active : '';
  $order = !empty($handler->order) ? $handler->order : 'asc';
  $query = tablesort_get_query_parameters();
  $renders = array();
  $view->row_index = 0;
  $keys = array_keys($view->field);
  foreach ($result as $count => $row) {
    foreach ($keys as $id) {
      $renders[$count][$id] = $view->field[$id]
        ->theme($row);
    }
    $view->row_index = $count + 1;
  }
  unset($view->row_index);
  foreach ($columns as $field => $column) {

    // render the header labels
    if ($field == $column && empty($fields[$field]->options['exclude'])) {
      $label = check_plain(!empty($fields[$field]) ? $fields[$field]
        ->label() : '');
      if (empty($options['info'][$field]['sortable']) || !$fields[$field]
        ->click_sortable()) {
        $vars['header'][$field] = $label;
      }
      else {

        // @todo -- make this a setting
        $initial = 'asc';
        if ($active == $field && $order == 'asc') {
          $initial = 'desc';
        }
        $title = t('sort by @s', array(
          '@s' => $label,
        ));
        if ($active == $field) {
          $label .= theme('tablesort_indicator', array(
            'style' => $initial,
          ));
        }
        $query['order'] = urlencode($field);
        $query['sort'] = $initial;
        $link_options = array(
          'html' => TRUE,
          'attributes' => array(
            'title' => $title,
          ),
          'query' => $query,
        );
        $vars['header'][$field] = l($label, $_GET['q'], $link_options);
      }
    }

    // Create a second variable so we can easily find what fields we have and what the
    // CSS classes should be.
    $vars['fields'][$field] = drupal_clean_css_identifier($field);
    if ($active == $field) {
      $vars['fields'][$field] .= ' active';
    }

    // Render each field into its appropriate column.
    foreach ($result as $num => $row) {
      if (!empty($fields[$field]) && empty($fields[$field]->options['exclude'])) {
        $field_output = $renders[$num][$field];

        // Don't bother with separators and stuff if the field does not show up.
        if (empty($field_output) && !empty($vars['rows'][$num]->{$column})) {
          continue;
        }

        // Place the field into the column, along with an optional separator.
        if (!empty($vars['rows'][$num]->{$column})) {
          if (!empty($options['info'][$column]['separator'])) {
            $vars['rows'][$num][$column] .= filter_xss_admin($options['info'][$column]['separator']);
          }
        }
        else {
          $vars['rows'][$num]->{$column} = $field_output;
        }
      }
    }
  }
  $vars['class'] = 'views-table-weight';
  if (!empty($options['sticky'])) {
    drupal_add_js('misc/tableheader.js');
    $vars['class'] .= ' sticky-enabled';
  }

  // Pass along the nid.
  foreach ($view->result as $count => $item) {
    $vars['rows'][$count]->nid_hidden = $item->nid;
  }
  $id = $view->name . '_drag';
  $form = drupal_get_form('weight_view_weight_form', $vars['header'], $vars['rows'], $vars['fields'], $vars['class'], $id, $vars['title']);
  return render($form);
}

/**
 * Display a view as a weight changing table.
 */
function weight_view_weight_form($form, &$form_state, $header, $rows, $fields, $class, $id, $title) {

  // Make this form draggable
  drupal_add_tabledrag($id, 'order', 'sibling', 'weight_dragger');
  $form = array(
    '#tree' => TRUE,
  );
  $form['#variables'] = array(
    'header' => $header,
    'class' => $class,
    'fields' => $fields,
    'id' => $id,
    'title' => $title,
  );
  foreach ($rows as $count => $row) {
    if (is_numeric($count)) {
      foreach ($row as $field => $content) {
        $nid = $row->nid_hidden;
        if (drupal_substr($field, 0, 6) == 'weight') {
          $form['rows'][$count][$field] = array(
            '#default_value' => $content,
            '#type' => 'weight',
            '#delta' => variable_get('weight_range', 20),
          );
        }
        elseif ($field != 'nid_hidden') {
          $form['rows'][$count][$field] = array(
            '#type' => 'value',
            '#value' => $content,
          );
        }
        else {
          $form['rows'][$count][$field] = array(
            '#type' => 'hidden',
            '#value' => $content,
          );
        }
      }
    }
    foreach ($form['rows'][$count] as $key => $frow) {
      if (!array_key_exists($key, $header) && $key != 'nid_hidden') {
        unset($form['rows'][$count][$key]);
      }
    }
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Save the changed weights.
 */
function weight_view_weight_form_submit($form, &$form_state) {
  foreach ($form_state['values']['rows'] as $count => $value) {
    $weight = $value['weight'];
    $nid = $value['nid_hidden'];
    $node = node_load($nid);
    if ($node->sticky) {
      $node->sticky = -1 * $weight + 100;
    }
    else {
      $node->sticky = -1 * $weight - 100;
    }
    node_save($node);
  }
  drupal_set_message(t('Your weight changes have been saved.'));
}

Functions

Name	Description
theme_weight_view_weight	Display a view as a weight changing table.
weight_views_data	Implements hook_views_data().
weight_views_handlers	Implements hook_views_handlers().
weight_views_plugins	Implements hook_views_plugins();
weight_view_weight_form	Display a view as a weight changing table.
weight_view_weight_form_submit	Save the changed weights.