uc_addresses.views.inc in Ubercart Addresses 6.2

Hook implementations for the Views module.

File

views/uc_addresses.views.inc

<?php

/**
 * @file
 * Hook implementations for the Views module.
 */

/**
 * Implementation of hook_views_data().
 */
function uc_addresses_views_data() {
  $data = array();

  // Get schema.
  $schema = drupal_get_schema('uc_addresses');

  // Get registered address fields.
  $address_fields = uc_addresses_get_address_fields();

  // Ubercart Addresses table.
  $data['uc_addresses']['table']['group'] = t('Ubercart Addresses');
  $data['uc_addresses']['table']['base'] = array(
    'field' => 'aid',
    'title' => t('Ubercart Addresses'),
    'help' => t('Addresses in the customers address book that can be referenced when placing an order.'),
  );

  // Declare each schema field.
  foreach ($schema['fields'] as $fieldname => $schema_field) {
    if (isset($address_fields[$fieldname])) {

      // Views properties for all fields.
      $data['uc_addresses'][$fieldname] = array(
        'title' => $address_fields[$fieldname]['title'],
        'help' => $address_fields[$fieldname]['description'],
      );

      // Set Views handlers per field.
      switch ($fieldname) {
        case 'aid':

          // Address ID (primary key).
          $data['uc_addresses']['aid'] += array(
            'field' => array(
              'handler' => 'views_handler_field_numeric',
              'click sortable' => TRUE,
            ),
            'filter' => array(
              'handler' => 'views_handler_filter_numeric',
            ),
            'sort' => array(
              'handler' => 'views_handler_sort',
            ),
            'argument' => array(
              'handler' => 'views_handler_argument_numeric',
            ),
          );
          break;
        case 'uid':

          // Address owner.
          $data['uc_addresses']['uid'] += array(
            'relationship' => array(
              'help' => t('Relate an address to the user who owns it.'),
              'handler' => 'views_handler_relationship',
              'base' => 'users',
              'field' => 'uid',
              'label' => t('owner'),
            ),
            'field' => array(
              'handler' => 'views_handler_field_user',
              'click sortable' => TRUE,
            ),
            'filter' => array(
              'handler' => 'views_handler_filter_user_current',
            ),
            'argument' => array(
              'handler' => 'views_handler_argument_user_uid',
            ),
          );
          break;
        case 'zone':
        case 'country':

          // Fields 'zone' and 'country' are setup differently (see further).
          break;
        case 'default_shipping':
        case 'default_billing':

          // Boolean fields.
          $data['uc_addresses'][$fieldname] += array(
            'field' => array(
              'handler' => 'views_handler_field_boolean',
              'click sortable' => TRUE,
            ),
            'filter' => array(
              'handler' => 'views_handler_filter_boolean_operator',
              'type' => 'yes-no',
              'use equal' => TRUE,
            ),
            'sort' => array(
              'handler' => 'views_handler_sort',
            ),
          );
          break;
        case 'created':
        case 'modified':

          // Date fields.
          $data['uc_addresses'][$fieldname] += array(
            'field' => array(
              'handler' => 'views_handler_field_date',
              'click sortable' => TRUE,
            ),
            'sort' => array(
              'handler' => 'views_handler_sort_date',
            ),
            'filter' => array(
              'handler' => 'views_handler_filter_date',
            ),
          );
          break;
        default:

          // Assume all other fields are text fields.
          $data['uc_addresses'][$fieldname] += array(
            'field' => array(
              'handler' => 'views_handler_field',
              'click sortable' => TRUE,
            ),
            'sort' => array(
              'handler' => 'views_handler_sort',
            ),
            'filter' => array(
              'handler' => 'views_handler_filter_string',
            ),
            'argument' => array(
              'handler' => 'views_handler_argument_string',
            ),
          );
          break;
      }

      // Set correct title of Ubercart core address fields.
      // First set default value for 'street2' as that is by default empty.
      $data['uc_addresses']['street2']['title'] = t('Street address 2');
      switch ($fieldname) {

        // @todo This might as well moved to uc_addresses_uc_addresses_fields() instead.
        case 'first_name':
        case 'last_name':
        case 'company':
        case 'street1':
        case 'street2':
        case 'city':
        case 'postal_code':
        case 'phone':
          $title = uc_get_field_name($fieldname);
          if ($title) {
            $data['uc_addresses'][$fieldname]['title'] = $title;
          }
          break;
      }
    }
  }

  // Countries.
  $data['uc_addresses']['country'] = array(
    'title' => t('ISO country code (numeric)'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('numeric ISO country code'),
    )),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
  );
  $data['uc_addresses_countries']['table']['group'] = $data['uc_addresses']['table']['group'];
  $data['uc_addresses_countries']['table']['join']['uc_addresses'] = array(
    'table' => 'uc_countries',
    'left_field' => 'country',
    'field' => 'country_id',
  );
  $data['uc_addresses_countries']['country_name'] = array(
    'title' => t('Country name'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('country name'),
    )),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );
  $data['uc_addresses_countries']['country_iso_code_2'] = array(
    'title' => t('ISO country code (2 characters)'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('ISO country code'),
    )),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );
  $data['uc_addresses_countries']['country_iso_code_3'] = array(
    'title' => t('ISO country code (3 characters)'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('ISO country code'),
    )),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // Zones.
  $data['uc_addresses']['zone'] = array(
    'title' => t('Zone ID'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('zone ID'),
    )),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
  );
  $data['uc_addresses_zones']['table']['group'] = $data['uc_addresses']['table']['group'];
  $data['uc_addresses_zones']['table']['join']['uc_addresses'] = array(
    'table' => 'uc_zones',
    'left_field' => 'zone',
    'field' => 'zone_id',
  );
  $data['uc_addresses_zones']['zone_name'] = array(
    'title' => t('State/Province'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('state or province'),
    )),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );
  $data['uc_addresses_zones']['zone_code'] = array(
    'title' => t('State/Province code'),
    'help' => t("The addressee's !field.", array(
      '!field' => t('state or province code'),
    )),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // Access filters.
  $data['uc_addresses']['access_view'] = array(
    'title' => t('Access'),
    'help' => t('Filter the Views results by address view access.'),
    'real field' => 'aid',
    'filter' => array(
      'help' => t('Filters the result of the view by checking address view access.') . ' ' . t('Note that this filter does not work well with pager.'),
      'handler' => 'uc_addresses_handler_filter_access',
      'uc_addresses_access_type' => 'view',
    ),
  );
  $data['uc_addresses']['access_edit'] = array(
    'title' => t('Edit access'),
    'help' => t('Filter the Views results by address edit access.'),
    'real field' => 'aid',
    'filter' => array(
      'help' => t('Filters the result of the view by checking address edit access.') . ' ' . t('Note that this filter does not work well with pager.'),
      'handler' => 'uc_addresses_handler_filter_access',
      'uc_addresses_access_type' => 'edit',
    ),
  );
  $data['uc_addresses']['access_delete'] = array(
    'title' => t('Delete access'),
    'help' => t('Filter the Views results by address delete access.'),
    'real field' => 'aid',
    'filter' => array(
      'help' => t('Filters the result of the view by checking address delete access.') . ' ' . t('Note that this filter does not work well with pager.'),
      'handler' => 'uc_addresses_handler_filter_access',
      'uc_addresses_access_type' => 'delete',
    ),
  );

  // View, edit and delete links.
  $data['uc_addresses']['view'] = array(
    'field' => array(
      'title' => t('Link'),
      'help' => t('Provide a simple link to the address.'),
      'handler' => 'uc_addresses_handler_field_uc_addresses_link',
    ),
  );
  $data['uc_addresses']['edit'] = array(
    'field' => array(
      'title' => t('Edit link'),
      'help' => t('Provide a simple link to edit the address.'),
      'handler' => 'uc_addresses_handler_field_uc_addresses_link_edit',
    ),
  );
  $data['uc_addresses']['delete'] = array(
    'field' => array(
      'title' => t('Delete link'),
      'help' => t('Provide a simple link to delete the address.'),
      'handler' => 'uc_addresses_handler_field_uc_addresses_link_delete',
    ),
  );

  // Make address fields available in user based views.
  $data['uc_addresses']['table']['join']['users'] = array(
    'left_field' => 'uid',
    'field' => 'uid',
  );
  $data['uc_addresses_countries']['table']['join']['users'] = array(
    'left_table' => 'uc_addresses',
    'left_field' => 'country',
    'table' => 'uc_countries',
    'field' => 'country_id',
  );
  $data['uc_addresses_zones']['table']['join']['users'] = array(
    'left_table' => 'uc_addresses',
    'left_field' => 'zone',
    'table' => 'uc_zones',
    'field' => 'zone_id',
  );
  return $data;
}

/**
 * Implementation of hook_views_handlers().
 */
function uc_addresses_views_handlers() {
  return array(
    'info' => array(
      'path' => drupal_get_path('module', 'uc_addresses') . '/views',
    ),
    'handlers' => array(
      'uc_addresses_handler_filter_access' => array(
        'parent' => 'views_handler_filter_boolean_operator',
      ),
      'uc_addresses_handler_field_uc_addresses_link' => array(
        'parent' => 'views_handler_field',
      ),
      'uc_addresses_handler_field_uc_addresses_link_edit' => array(
        'parent' => 'uc_addresses_handler_field_uc_addresses_link',
      ),
      'uc_addresses_handler_field_uc_addresses_link_delete' => array(
        'parent' => 'uc_addresses_handler_field_uc_addresses_link',
      ),
    ),
  );
}

/**
 * Implements hook_views_plugins().
 */
function uc_addresses_views_plugins() {
  return array(
    'row' => array(
      'uc_addresses' => array(
        'title' => t('Ubercart Addresses address'),
        'help' => t('Display the address with standard address view.'),
        'handler' => 'uc_addresses_views_plugin_row_address_view',
        'path' => drupal_get_path('module', 'uc_addresses') . '/views',
        'base' => array(
          'uc_addresses',
        ),
        // only works with 'uc_addresses' as base.
        'uses options' => TRUE,
        'type' => 'normal',
      ),
    ),
    'access' => array(
      'uc_addresses_views_access' => array(
        'title' => t('Ubercart Addresses Views Access'),
        'help' => t('Check for address access based on a user ID or address ID argument.'),
        'handler' => 'uc_addresses_views_access',
        'uses options' => TRUE,
        'path' => drupal_get_path('module', 'uc_addresses') . '/views',
      ),
    ),
    'argument validator' => array(
      'uc_addresses_address_access' => array(
        'title' => t('Address access'),
        'handler' => 'uc_addresses_views_plugin_argument_address_access',
        'path' => drupal_get_path('module', 'uc_addresses') . '/views',
      ),
      'uc_addresses_user_address_access' => array(
        'title' => t('User: address access'),
        'parent' => 'user',
        'handler' => 'uc_addresses_views_plugin_argument_user_address_access',
        'path' => drupal_get_path('module', 'uc_addresses') . '/views',
      ),
    ),
  );
}

/**
 * Implements hook_views_post_execute().
 *
 * Checks if uc_addresses' access filter is used.
 */
function uc_addresses_views_post_execute($view) {
  foreach ($view->filter as $id => $handler) {
    if ($handler instanceof uc_addresses_handler_filter_access) {
      $handler
        ->post_execute($view->result);
    }
  }
}

Functions

Name	Description
uc_addresses_views_data	Implementation of hook_views_data().
uc_addresses_views_handlers	Implementation of hook_views_handlers().
uc_addresses_views_plugins	Implements hook_views_plugins().
uc_addresses_views_post_execute	Implements hook_views_post_execute().