currency.views.inc in Currency 6

Register all of the basic handlers that views uses.

File

views/currency.views.inc

<?php

/**
 * @file
 *   Register all of the basic handlers that views uses.
 */

/**
 * Implementation of hook_views_handlers().
 */
function currency_views_handlers() {
  return array(
    'info' => array(
      'path' => drupal_get_path('module', 'currency') . '/views/handlers',
    ),
    'handlers' => array(
      'currency_handler_field_currency' => array(
        'parent' => 'views_handler_field',
      ),
      'currency_handler_argument_currency' => array(
        'parent' => 'views_handler_argument',
      ),
      'currency_handler_filter_currency' => array(
        'parent' => 'views_handler_filter_in_operator',
      ),
    ),
  );
}

/**
 * Implementation of hook_views_data().
 */
function currency_views_data() {
  $data['currencyapi']['table']['group'] = t('Currency');
  $data['currencyapi']['table']['base'] = array(
    'title' => t('Exchange Rates'),
    'help' => t('Exchange rates provided by the currency_api module'),
  );
  $data['currencyapi']['currency_from'] = array(
    'title' => t('Currency from'),
    'help' => t('The currency that the amount is converted from'),
    'field' => array(
      'handler' => 'currency_handler_field_currency',
    ),
    'argument' => array(
      'handler' => 'currency_handler_argument_currency',
    ),
    'filter' => array(
      'handler' => 'currency_handler_filter_currency',
    ),
  );
  $data['currencyapi']['currency_to'] = array(
    'title' => t('Currency to'),
    'help' => t('The currency that the amount is converted to'),
    'field' => array(
      'handler' => 'currency_handler_field_currency',
    ),
    'argument' => array(
      'handler' => 'currency_handler_argument_currency',
    ),
    'filter' => array(
      'handler' => 'currency_handler_filter_currency',
    ),
  );
  $data['currencyapi']['rate'] = array(
    'title' => t('Exchange rate'),
    'help' => t('The exchange rate used for conversion'),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
    ),
  );
  $data['currencyapi']['timestamp'] = array(
    'title' => t('Timestamp'),
    'help' => t('The time that the exchange rate was last updated'),
    'field' => array(
      'handler' => 'views_handler_field_date',
    ),
  );
  return $data;
}

/**
 * Calls currency_api_convert for every exchange rate that should be displayed
 * according to filter and argument settings to ensure that rates are in the
 * database when views performs it's query.
 */
function currency_views_preload($view) {
  static $processed = FALSE;
  if (!$processed) {

    // $this->value for keyed array of selected currencies
    if ($view->filter['currency_from']) {
      $selected_from = _currency_views_get_selected_options($view->filter['currency_from']->value);
    }
    elseif ($view->argument['currency_from'] && ($currency_from = $view->argument['currency_from']
      ->get_value())) {

      // process argument
      $selected_from = array(
        $currency_from,
      );
    }
    if ($view->filter['currency_to']) {
      $selected_to = _currency_views_get_selected_options($view->filter['currency_to']->value);
    }
    elseif ($view->argument['currency_to'] && ($currency_to = $view->argument['currency_to']
      ->get_value())) {
      $selected_to = array(
        $currency_to,
      );
    }
    if ($selected_from && $selected_to) {

      // selected currencies - make sure exchange rates are in database by calling currency_api for each from/to currency combination
      foreach ($selected_from as $currency_from) {
        foreach ($selected_to as $currency_to) {
          currency_api_convert($currency_from, $currency_to);
        }
      }
    }
    $processed = TRUE;
  }
}

/**
 * Helper function to get the filter's selected options.
 */
function _currency_views_get_selected_options($options) {
  foreach ($options as $key => $set) {
    if ($set) {

      // i.e. not equal to 0
      $selected_options[] = $set;
    }
  }
  return $selected_options;
}

Functions

Name	Description
currency_views_data	Implementation of hook_views_data().
currency_views_handlers	Implementation of hook_views_handlers().
currency_views_preload	Calls currency_api_convert for every exchange rate that should be displayed according to filter and argument settings to ensure that rates are in the database when views performs it's query.
_currency_views_get_selected_options	Helper function to get the filter's selected options.