sheetnode.views.inc in Sheetnode 7

Provide views data for sheetnode.

File

sheetnode.views.inc

<?php

/**
 * @file
 * Provide views data for sheetnode.
 */

/**
 * Implements hook_views_plugins().
 */
function sheetnode_views_plugins() {
  $library_path = drupal_get_path('module', 'sheetnode');
  $module_path = drupal_get_path('module', 'sheetnode');
  return array(
    'style' => array(
      'sheet' => array(
        'title' => t('Spreadsheet'),
        'help' => t('Displays results in a browser spreadsheet.'),
        'handler' => 'sheetnode_plugin_style',
        'uses row plugin' => FALSE,
        'uses fields' => TRUE,
        'uses options' => TRUE,
        'type' => 'normal',
        'path' => $module_path . '/views',
        'js' => array(
          $library_path . '/socialcalc/formatnumber2.js',
          $library_path . '/socialcalc/formula1.js',
          $library_path . '/socialcalc/socialcalcconstants.js',
          $library_path . '/socialcalc/socialcalc-3.js',
          $library_path . '/socialcalc/socialcalctableeditor.js',
          $library_path . '/socialcalc/socialcalcpopup.js',
          $library_path . '/socialcalc/socialcalcspreadsheetcontrol.js',
          $library_path . '/socialcalc/socialcalcviewer.js',
          $module_path . '/js/sheetnode.js',
        ),
      ),
      'sheet_raw' => array(
        'title' => t('SocialCalc format'),
        'help' => t('Render the view as a raw SocialCalc spreadsheet.'),
        'handler' => 'sheetnode_raw_plugin_style',
        'parent' => 'sheet',
        'uses row plugin' => FALSE,
        'uses fields' => TRUE,
        'uses options' => TRUE,
        'type' => 'feed',
        'path' => $module_path . '/views',
      ),
    ),
  );
}

/**
 * Implements hook_views_handlers().
 */
function sheetnode_views_handlers() {
  return array(
    'info' => array(
      'path' => drupal_get_path('module', 'sheetnode') . '/views',
    ),
    'handlers' => array(
      'sheetnode_handler_field_cell' => array(
        'parent' => 'views_handler_field',
      ),
      'sheetnode_handler_field_range' => array(
        'parent' => 'views_handler_field',
      ),
      'sheetnode_handler_field_date' => array(
        'parent' => 'views_handler_field',
      ),
      'sheetnode_handler_field_named_range' => array(
        'parent' => 'views_handler_field',
      ),
      'sheetnode_handler_field_editable' => array(
        'parent' => 'views_handler_field',
      ),
    ),
  );
}

/**
 * Implements hook_views_data().
 */
function sheetnode_views_data() {

  // Basic table information.
  $data['sheetnode']['table']['group'] = t('Sheetnode');

  // Explain how we join.
  $data['sheetnode']['table']['join'] = array(
    // Directly links to node table.
    'node' => array(
      'left_field' => 'vid',
      'field' => 'vid',
    ),
  );

  // Sheetnode field.
  $data['sheetnode']['content'] = array(
    'title' => t('Content'),
    'help' => t('The raw content of the sheetnode.'),
    'field' => array(
      'field' => 'value',
      'handler' => 'views_handler_field',
    ),
  );

  // Cell field.
  $data['sheetnode']['cell'] = array(
    'title' => t('Cell'),
    'help' => t('The value stored in a specific sheetnode cell.'),
    'field' => array(
      'field' => 'value',
      'handler' => 'sheetnode_handler_field_cell',
    ),
  );

  // Range field.
  $data['sheetnode']['range'] = array(
    'title' => t('Range'),
    'help' => t('The values stored in a range of cells, including whole columns or whole rows.'),
    'field' => array(
      'field' => 'value',
      'handler' => 'sheetnode_handler_field_range',
    ),
  );

  // Variable name.
  $data['sheetnode']['named_range'] = array(
    'title' => t('Named range'),
    'help' => t('The cell or range values referred to by a named variable.'),
    'field' => array(
      'field' => 'value',
      'handler' => 'sheetnode_handler_field_named_range',
    ),
  );
  return $data;
}

/**
 * Implements hook_views_data_alter().
 */
function sheetnode_views_data_alter(&$data) {
  $fieldapi_info = field_info_fields();
  foreach ($data as $table_name => $table_info) {
    foreach ($table_info as $field_name => $field_info) {

      // Add a SocialCalc date converter for each date field.
      if (!empty($field_info['field']['handler']) && $field_info['field']['handler'] == 'views_handler_field_date') {
        $date = $field_info;
        $date['real field'] = $field_name;
        $date['title'] = $field_info['title'] . ' (SocialCalc)';
        $date['field']['handler'] = 'sheetnode_handler_field_date';
        unset($date['filter'], $date['argument'], $date['relationship'], $date['sort']);
        $data[$table_name][$field_name . '_socialcalc'] = $date;
      }

      // Add sheetnode handlers for each sheet field.
      if (!empty($field_info['field']['field_name']) && $fieldapi_info[$field_info['field']['field_name']]['type'] == 'sheetfield') {
        $field_info += array(
          'title short' => '',
        );
        $cell = $field_info;
        $cell['title'] = $field_info['title'] . ' (' . $field_name . ':' . t('cell') . ')';
        $cell['title short'] = $field_info['title short'] . ':' . t('cell');
        $cell['help'] = t('Cell reference') . ' - ' . $field_info['help'];
        $cell['field']['handler'] = 'sheetnode_handler_field_cell';
        $data[$table_name][$field_name . '_cell'] = $cell;
        $range = $cell;
        $range['title'] = $field_info['title'] . ' (' . $field_name . ':' . t('range') . ')';
        $range['title short'] = $field_info['title short'] . ':' . t('range');
        $range['help'] = t('Range reference') . ' - ' . $field_info['help'];
        $range['field']['handler'] = 'sheetnode_handler_field_range';
        $data[$table_name][$field_name . '_range'] = $range;
        $content = $cell;
        $content['title'] = $field_info['title'] . ' (' . $field_name . ':' . t('content') . ')';
        $content['title short'] = $field_info['title short'] . ':' . t('content');
        $content['help'] = t('Content') . ' - ' . $field_info['help'];
        $content['field']['handler'] = 'views_handler_field';
        $data[$table_name][$field_name . '_content'] = $content;
        $named_range = $cell;
        $named_range['title'] = $field_info['title'] . ' (' . $field_name . ':' . t('named range') . ')';
        $named_range['title short'] = $field_info['title short'] . ':' . t('named range');
        $named_range['help'] = t('Named range') . ' - ' . $field_info['help'];
        $named_range['field']['handler'] = 'sheetnode_handler_field_named_range';
        $data[$table_name][$field_name . '_named_range'] = $named_range;
      }
    }
  }

  // Add sheetnode editable field.
  $data['sheetnode']['sheetview_edit'] = array(
    'title' => t('Make spreadsheet editable'),
    'help' => t('Add this field to make your spreadsheet editable.'),
    'field' => array(
      'handler' => 'sheetnode_handler_field_editable',
    ),
  );
}

Functions

Name	Description
sheetnode_views_data	Implements hook_views_data().
sheetnode_views_data_alter	Implements hook_views_data_alter().
sheetnode_views_handlers	Implements hook_views_handlers().
sheetnode_views_plugins	Implements hook_views_plugins().