domain_views.views.inc in Domain Views 7

Provides the views data and handlers for domain.module.

Original code by mrichar1. Port to Drupal 6 by nonsie.

File

domain_views.views.inc

<?php

/**
 * @file
 * Provides the views data and handlers for domain.module.
 *
 * Original code by mrichar1.  Port to Drupal 6 by nonsie.
 *
 * @ingroup domain_views
 */

/**
 * Implements hook_views_data().
 */
function domain_views_views_data() {
  $data = array();

  // Define the {domain} table.
  $data['domain']['table']['group'] = t('Domains');

  // We can use this as a base table for Views.
  $data['domain']['table']['base'] = array(
    'field' => 'domain_id',
    'title' => t('Domains'),
    'help' => t('Domain Access uses domains to divide and display content on a group of related sites.'),
  );

  // Define the joins.
  $data['domain']['table']['join']['node'] = array(
    'left_table' => 'domain_access',
    'left_field' => 'gid',
    'field' => 'domain_id',
  );
  $data['domain']['table']['join']['node_revision'] = array(
    'left_table' => 'domain_access',
    'left_field' => 'gid',
    'field' => 'domain_id',
  );

  // Define the fields.
  $data['domain']['domain_id'] = array(
    'title' => t('Domain ID'),
    'help' => t('The unique id key for the active domain.'),
    'field' => array(
      'click sortable' => TRUE,
      'handler' => 'domain_views_handler_field_domain_id',
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'domain_views_handler_filter_domain_domain_id',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );
  $data['domain']['subdomain'] = array(
    'title' => t('Subdomain'),
    'help' => t('The URL string that identifies a domain.'),
    'field' => array(
      'handler' => 'domain_views_handler_field_domain_subdomain',
      'click sortable' => TRUE,
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );
  $data['domain']['sitename'] = array(
    'title' => t('Site name'),
    'help' => t('The display string that identifies a domain.'),
    'field' => array(
      'handler' => 'domain_views_handler_field_domain_sitename',
      'click sortable' => TRUE,
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );
  $data['domain']['scheme'] = array(
    'title' => t('Scheme'),
    'help' => t('The http protocol used by the domain.'),
    'field' => array(
      'click sortable' => TRUE,
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );
  $data['domain']['valid'] = array(
    'title' => t('Valid'),
    'help' => t('A boolean flag indicating the domain can be seen by site visitors.'),
    'field' => array(
      'handler' => 'views_handler_field_boolean',
      'click sortable' => TRUE,
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'views_handler_filter_boolean_operator',
      'label' => t('Valid'),
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  // New fields in 7.x.3.
  if (domain_views_api_version() > 2) {
    $data['domain']['weight'] = array(
      'title' => t('Weight'),
      'help' => t('The sort order for domain lists.'),
      'field' => array(
        'handler' => 'views_handler_field_numeric',
        'click sortable' => TRUE,
      ),
      // Information for accepting a domain_id as a filter
      'filter' => array(
        'handler' => 'views_handler_filter_numeric',
        'label' => t('Weight'),
      ),
      // Information for sorting on a domain_id.
      'sort' => array(
        'handler' => 'views_handler_sort',
      ),
    );
    $data['domain']['is_default'] = array(
      'title' => t('Default domain'),
      'help' => t('A boolean flag indicating the default domain.'),
      'field' => array(
        'handler' => 'views_handler_field_boolean',
        'click sortable' => TRUE,
      ),
      // Information for accepting a domain_id as a filter
      'filter' => array(
        'handler' => 'views_handler_filter_boolean_operator',
        'label' => t('Default domain'),
      ),
      // Information for sorting on a domain_id.
      'sort' => array(
        'handler' => 'views_handler_sort',
      ),
    );
    $data['domain']['machine_name'] = array(
      'title' => t('Machine name'),
      'help' => t('The machine-readable name of this domain.'),
      'field' => array(
        'click sortable' => TRUE,
      ),
      // Information for accepting a domain_id as a filter
      'filter' => array(
        'handler' => 'domain_views_handler_filter_domain_machine_name',
      ),
      // Information for sorting on a domain_id.
      'sort' => array(
        'handler' => 'views_handler_sort',
      ),
    );
  }

  // Define the {domain_access} table.
  $data['domain_access']['table']['group'] = t('Domain Access');

  // Define the joins.
  // Note that we only JOIN on domain_id records.
  $data['domain_access']['table']['join']['node'] = array(
    'left_field' => 'nid',
    'field' => 'nid',
    'extra' => array(
      array(
        'field' => 'realm',
        'value' => 'domain_id',
        'numeric' => FALSE,
      ),
    ),
  );

  // Define the joins between {node_revision} and {domain_access}.
  $data['domain_access']['table']['join']['node_revision'] = array(
    'left_field' => 'nid',
    'field' => 'nid',
    'extra' => array(
      array(
        'field' => 'realm',
        'value' => 'domain_id',
        'numeric' => FALSE,
      ),
    ),
  );

  // Join the two domain tables.
  // Note that we only JOIN on domain_id records.
  $data['domain_access']['table']['join']['domain'] = array(
    'left_field' => 'domain_id',
    'field' => 'gid',
    'extra' => array(
      array(
        'field' => 'realm',
        'value' => 'domain_id',
        'numeric' => FALSE,
      ),
    ),
  );

  // Define the fields.
  $data['domain_access']['nid'] = array(
    'title' => t('Node ID'),
    'help' => t('The node id.'),
    'field' => array(
      'click sortable' => TRUE,
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'relationship' => array(
      'title' => t('Domain node'),
      'help' => t("Bring in information about the domain this node is assigned to."),
      'base' => 'node',
      'field' => 'nid',
      'handler' => 'views_handler_relationship',
      'label' => t('Domain node'),
    ),
  );

  // Define the fields.
  $data['domain_access']['gid'] = array(
    'title' => t('Domain ID'),
    'help' => t('The domain id of the record.'),
    'field' => array(
      'click sortable' => TRUE,
      'handler' => 'domain_views_handler_field_domain_id',
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'domain_views_handler_filter_domain_access_gid',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    // Information accepting domain_id as an argument
    'argument' => array(
      'handler' => 'domain_views_handler_argument_domain_access_gid',
    ),
  );

  // Define the fields.
  $data['domain_access']['realm'] = array(
    'title' => t('Access Type'),
    'help' => t('The domain realm.'),
    'field' => array(
      'click sortable' => TRUE,
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'domain_views_handler_filter_domain_access_realm',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  // Define available on current domain field
  $data['domain_access']['current_all'] = array(
    'title' => t('Available on current domain'),
    'field' => array(
      'help' => t('A boolean flag indicating whether this content available for current domain (published to current domain or all affiliates)'),
      'field' => 'gid',
      'handler' => 'views_handler_field_boolean',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'help' => t('Filters out nodes not available on current domain (published to current domain or all affiliates)'),
      'field' => 'gid',
      'handler' => 'domain_views_handler_filter_domain_access_current_all',
      'label' => t('Available on current domain'),
    ),
  );

  /* TODO: make this sortable.
    $data['domain_access']['sitename'] = array(
      'title' => t('Site name'),
      'help' => t('The display string that identifies a domain.'),
      'field' => array(
        'handler' => 'domain_views_handler_field_domain_access_sitename',
        'click sortable' => FALSE,
      ),
    ); */

  // Define the {domain_editor} table.
  $data['domain_editor']['table']['group'] = t('Domain Editor');

  // Define the joins.
  $data['domain_editor']['table']['join']['domain'] = array(
    'left_field' => 'domain_id',
    'field' => 'domain_id',
  );
  $data['domain_editor']['table']['join']['users'] = array(
    'left_field' => 'uid',
    'field' => 'uid',
  );
  $data['domain_editor']['table']['join']['node'] = array(
    'left_field' => 'uid',
    'field' => 'uid',
  );
  $data['domain_editor']['table']['join']['node_revision'] = array(
    'left_field' => 'uid',
    'field' => 'uid',
  );

  // Define the fields.
  $data['domain_editor']['uid'] = array(
    'title' => t('User ID'),
    'help' => t('The user\'s id.'),
    'field' => array(
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  // Define the fields.
  $data['domain_editor']['domain_id'] = array(
    'title' => t('Domain ID'),
    'help' => t('The domain(s) an editor is assigned to.'),
    'field' => array(
      'click sortable' => TRUE,
      'handler' => 'domain_views_handler_field_domain_id',
    ),
    // Information for accepting a domain_id as a filter
    'filter' => array(
      'handler' => 'domain_views_handler_filter_domain_domain_id',
    ),
    // Information for accepting a domain_id as a filter
    'argument' => array(
      'handler' => 'domain_views_handler_argument_domain_access_gid',
    ),
    // Information for sorting on a domain_id.
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'relationship' => array(
      'title' => t('Domain editors'),
      'help' => t("Bring in information about the domain this user is assigned to."),
      'base' => 'domain',
      'field' => 'domain_id',
      'handler' => 'views_handler_relationship',
      'label' => t('Domain editors'),
    ),
  );
  return $data;
}

/**
 * Implements hook_views_plugins().
 */
function domain_views_views_plugins() {
  $path = drupal_get_path('module', 'domain_views') . '/includes';
  return array(
    'access' => array(
      'domain' => array(
        'title' => t('Domain'),
        'help' => t('Will be available only on selected domains.'),
        'handler' => 'domain_views_plugin_access',
        'uses options' => TRUE,
        'path' => $path,
      ),
    ),
    'argument default' => array(
      'current_domain' => array(
        'title' => t('Current domain'),
        'handler' => 'domain_views_plugin_argument_default_current',
        'path' => $path,
        'parent' => 'fixed',
      ),
    ),
    'cache' => array(
      'time_per_domain' => array(
        'title' => t('Time-based Per Domain'),
        'help' => t('Time-based caching of views on a per domain basis. This is necessary if you want to cache a view that filters on "current domain".'),
        'handler' => 'domain_views_plugin_cache_time',
        'uses options' => TRUE,
        'path' => $path,
        'parent' => 'time',
      ),
    ),
  );
}

/**
 * Implements hook_views_query_substitutions ()
 */
function domain_views_views_query_substitutions($view) {
  $domain = domain_get_domain();
  $default = domain_default();
  $return = array(
    '***CURRENT_DOMAIN***' => $domain['domain_id'],
    '***PRIMARY_DOMAIN***' => $default['domain_id'],
  );

  // Ensure compatibility with 7.x.2 and 7.x.3.
  if (isset($domain['machine_name'])) {
    $return['***CURRENT_DOMAIN_MACHINE_NAME***'] = $domain['machine_name'];
    $return['***PRIMARY_DOMAIN_MACHINE_NAME***'] = $default['machine_name'];
  }
  return $return;
}

Related topics

Domain Views: provides views integration.

Views integration for Domain Access.

Functions

Name	Description
domain_views_views_data	Implements hook_views_data().
domain_views_views_plugins	Implements hook_views_plugins().
domain_views_views_query_substitutions	Implements hook_views_query_substitutions ()