stanford_capx.views.inc

<?php
/**
 * @file
 * Expose and change data for views.
 */


/**
 * Exposed the configuration entity serialized
 * @return [type] [description]
 */
function stanford_capx_views_data() {
  $data = array();

   // First, the entry $data['example_table']['table'] describes properties of
  // the actual table – not its content.

  // The 'group' index will be used as a prefix in the UI for any of this
  // table's fields, sort criteria, etc. so it's easy to tell where they came
  // from.
  $data['capx_cfe']['table']['group'] = t('Configuration Entity');

  // Define this as a base table – a table that can be described in itself by
  // views (and not just being brought in as a relationship). In reality this
  // is not very useful for this table, as it isn't really a distinct object of
  // its own, but it makes a good example.
  $data['capx_cfe']['table']['base'] = array(
    'field' => 'cfid', // This is the identifier field for the view.
    'title' => t('CAPx Configuration Entity'),
    'help' => t('CAPx Configuration Entity contains the settings for the mapping and importer entities.'),
    'weight' => -10,
  );

  $data['capx_cfe']['table']['entity type'] = 'capx_cfe';

  // Settings table field.
  $data['capx_cfe']['settings'] = array(
    'title' => t('Configuration Settings'),
    'help' => t('Exposes the serialized array of settings.'),
    'field' => array(
      'handler' => 'views_handler_field_configuration_settings',
      'click sortable' => FALSE,
    ),
  );

  // Meta table field.
  $data['capx_cfe']['meta'] = array(
    'title' => t('Meta Data'),
    'help' => t('Exposes meta data.'),
    'field' => array(
      'handler' => 'views_handler_field_configuration_metadata',
      'click sortable' => FALSE,
    ),
  );

  // Example plain text field.
  $data['capx_cfe']['machine_name'] = array(
    'title' => t('Machine name'),
    'help' => t('The machine name of the entity.'),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE, // This is use by the table display plugin.
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // Example numeric text field.
  $data['capx_cfe']['cfid'] = array(
    'title' => t('Configuration ID'),
    'help' => t('The ID of the configuration entity.'),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  // Example plain text field.
  $data['capx_cfe']['title'] = array(
    'title' => t('Title'),
    'help' => t('The human readable title of the entity.'),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE, // This is use by the table display plugin.
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // Example plain text field.
  $data['capx_cfe']['type'] = array(
    'title' => t('type'),
    'help' => t('The type of entity.'),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE, // This is use by the table display plugin.
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // Mapper edit link.
  $data['capx_cfe']['mapper_edit_link'] = array(
    'title' => t('Mapping edit link'),
    'help' => t('Edit link for mappings'),
    'field' => array(
      'handler' => 'views_handler_field_mapper_edit_link',
    ),
  );

  // Mapper delete link.
  $data['capx_cfe']['mapper_delete_link'] = array(
    'title' => t('Mapping delete link'),
    'help' => t('Delete link for mappings'),
    'field' => array(
      'handler' => 'views_handler_field_mapper_delete_link',
    ),
  );

  // Importer edit link.
  $data['capx_cfe']['importer_edit_link'] = array(
    'title' => t('Importer edit link'),
    'help' => t('Edit link for importers'),
    'field' => array(
      'handler' => 'views_handler_field_importer_edit_link',
    ),
  );

  // Importer sync profiles link.
  $data['capx_cfe']['importer_sync_profiles'] = array(
    'title' => t('Importer sync profiles action link'),
    'help' => t('Sync profiles action'),
    'field' => array(
      'handler' => 'views_handler_field_importer_sync_profiles',
    ),
  );

  // Importer orphan profiles check link.
  $data['capx_cfe']['importer_orphan_profiles'] = array(
    'title' => t('Importer orphan profiles action link'),
    'help' => t('Check orphan profiles action'),
    'field' => array(
      'handler' => 'views_handler_field_importer_orphan_profiles',
    ),
  );

  // Importer delete link.
  $data['capx_cfe']['importer_delete_link'] = array(
    'title' => t('Importer delete link'),
    'help' => t('Delete link for importers'),
    'field' => array(
      'handler' => 'views_handler_field_importer_delete_link',
    ),
  );

 // uid field.
  $data['capx_cfe']['uid'] = array(
    'title' => t('Author uid'),
    'help' => t('The user authoring the content. If you need more fields than the uid add the content: author relationship'),
    'relationship' => array(
      'title' => t('Author'),
      'help' => t('Relate content to the user who created it.'),
      'handler' => 'views_handler_relationship',
      'base' => 'users',
      'field' => 'uid',
      'label' => t('author'),
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_user_name',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
    'field' => array(
      'handler' => 'views_handler_field_user',
    ),
  );

  // Example timestamp field.
  $data['capx_cfe']['created'] = array(
    'title' => t('Created'),
    'help' => t('The date the entity was created.'),
    'field' => array(
      'handler' => 'views_handler_field_date',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort_date',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_date',
    ),
  );

  // Example timestamp field.
  $data['capx_cfe']['changed'] = array(
    'title' => t('Changed'),
    'help' => t('The date the entity was last changed.'),
    'field' => array(
      'handler' => 'views_handler_field_date',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort_date',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_date',
    ),
  );

  // CAPx PROFILES
  // ---------------------------------------------------------------------------


  // The 'group' index will be used as a prefix in the UI for any of this
  // table's fields, sort criteria, etc. so it's easy to tell where they came
  // from.
  $data['capx_profiles']['table']['group'] = t('CAPx profile');

  // Define this as a base table – a table that can be described in itself by
  // views (and not just being brought in as a relationship). In reality this
  // is not very useful for this table, as it isn't really a distinct object of
  // its own, but it makes a good example.
  $data['capx_profiles']['table']['base'] = array(
    'field' => 'id', // This is the identifier field for the view.
    'title' => t('CAPx profile'),
    'help' => t('Additional information about a profile.'),
    'weight' => -10,
  );

  // profile table table field.
  $data['capx_profiles']['id'] = array(
    'title' => t('Profile import id'),
    'help' => t('The table id of the imported profile.'),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort_numeric',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
  );

  // profile table table field.
  $data['capx_profiles']['entity_type'] = array(
    'title' => t('Entity Type'),
    'help' => t('The entity type of the imported profile.'),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE, // This is use by the table display plugin.
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // profile table table field.
  $data['capx_profiles']['bundle_type'] = array(
    'title' => t('Bundle Type'),
    'help' => t('The bundle type of the imported profile.'),
    'field' => array(
      'handler' => 'views_handler_field',
      'click sortable' => TRUE, // This is use by the table display plugin.
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_string',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_string',
    ),
  );

  // settings table field.
  $data['capx_profiles']['importer'] = array(
    'title' => t('Importer'),
    'help' => t('The machine name of the CAPx importer.'),
    'field' => array(
      'handler' => 'views_handler_field',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_importer',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_importer',
    ),
  );

  $data['capx_profiles']['entity_id'] = array(
    'title' => t('Entity ID'),
    'help' => t('The entity id.'),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
    'field' => array(
      'handler' => 'views_handler_field_numeric',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  $data['capx_profiles']['profile_id'] = array(
    'title' => t('Profile ID'),
    'help' => t('The profile ID that is assigned at the CAP API.'),
    'argument' => array(
      'handler' => 'views_handler_argument_numeric',
    ),
    'field' => array(
      'handler' => 'views_handler_field_capx_profile_id',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_numeric',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  $data['capx_profiles']['orphaned'] = array(
    'title' => t('Orphaned Status'),
    'help' => t('A boolean value to wether or not the profile has been orphaned.'),
    'argument' => array(
      'handler' => 'views_handler_argument_boolean',
    ),
    'field' => array(
      'handler' => 'views_handler_field_boolean',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_boolean',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  $data['capx_profiles']['sync'] = array(
    'title' => t('Sync Status'),
    'help' => t('A boolean value to wether or not the profile is receiving update.'),
    'argument' => array(
      'handler' => 'views_handler_argument_boolean',
    ),
    'field' => array(
      'handler' => 'views_handler_field_boolean',
      'click sortable' => TRUE,
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_boolean',
    ),
    'sort' => array(
      'handler' => 'views_handler_sort',
    ),
  );

  $data['capx_profiles']['last_sync'] = array(
    'title' => t('Last Sync'),
    'help' => t('The last time the profile was successully updated.'),
    'field' => array(
      'handler' => 'views_handler_field_date',
      'click sortable' => TRUE,
    ),
    'sort' => array(
      'handler' => 'views_handler_sort_date',
    ),
    'filter' => array(
      'handler' => 'views_handler_filter_date',
    ),
    'argument' => array(
      'handler' => 'views_handler_argument_date',
    ),
  );


  return $data;
}

/**
 * Implements hook_views_data_alter()
 * @param  [type] $data [description]
 * @return [type]       [description]
 */
function stanford_capx_views_data_alter(&$data) {

  // Add a relationship to the capx_profiles table.
  $data['node']['capx_profiles'] = array(
    'title' => t('CAPx profile info relationship'),
    'help' => t('A relationship to the extra profile information from CAP'),
    'relationship' => array(
      'base' => 'capx_profiles', // Table we're joining to.
      'base field' => 'entity_id', // Field on the joined table.
      'field' => 'nid', // Real field name on the 'foo' table.
      'handler' => 'views_handler_relationship',
      'label' => t('CAPx Profile Data'),
      'title' => t('CAPx Profile Data'),
      'help' => t('A relationship between the imported entity and the additional data stored in the capx_profiles table.'),
    ),
  );

  // Add a relationship to the capx_profiles table.
  $data['capx_profiles']['node'] = array(
    'title' => t('CAPx profile to node relationship'),
    'help' => t('A relationship to the node table from CAP profiles'),
    'relationship' => array(
      'base' => 'node', // Table we're joining to.
      'base field' => 'nid', // Field on the joined table.
      'field' => 'entity_id', // Real field name on the 'foo' table.
      'handler' => 'views_handler_relationship',
      'label' => t('CAPx Profile Node Information'),
      'title' => t('CAPx Profile Node Information'),
      'help' => t('A relationship between the CAPx profiles table and the node table.'),
      'extra' => array(
        array(
          'table' => 'capx_profiles',
          'field' => 'entity_type',
          'value' => 'node',
        ),
      ),
    ),
  );

  // Add a relationship to the capx_profiles table.
  $data['capx_profiles']['bean'] = array(
    'title' => t('CAPx profile to bean relationship'),
    'help' => t('A relationship to the bean table from CAP profiles'),
    'relationship' => array(
      'base' => 'bean', // Table we're joining to.
      'base field' => 'bid', // Field on the joined table.
      'field' => 'entity_id', // Real field name on the 'foo' table.
      'handler' => 'views_handler_relationship',
      'label' => t('CAPx Profile BEAN Information'),
      'title' => t('CAPx Profile BEAN Information'),
      'help' => t('A relationship between the CAPx profiles table and the BEAN table.'),
      'extra' => array(
        array(
          'table' => 'capx_profiles',
          'field' => 'entity_type',
          'value' => 'bean',
        ),
      ),
    ),
  );

  // Add a relationship to the capx_profiles table.
  $data['capx_profiles']['user'] = array(
    'title' => t('CAPx profile to user relationship'),
    'help' => t('A relationship to the user table from CAP profiles'),
    'relationship' => array(
      'base' => 'users', // Table we're joining to.
      'base field' => 'uid', // Field on the joined table.
      'field' => 'entity_id', // Real field name on the 'foo' table.
      'handler' => 'views_handler_relationship',
      'label' => t('CAPx Profile User Information'),
      'title' => t('CAPx Profile User Information'),
      'help' => t('A relationship between the CAPx profiles table and the User table.'),
      'extra' => array(
        array(
          'table' => 'capx_profiles',
          'field' => 'entity_type',
          'value' => 'user',
        ),
      ),
    ),
  );

}

/**
 * Implements hook_views_pre_view()
 *
 */
function stanford_capx_views_pre_view(&$view, &$display_id, $args) {

  // Overview form view all button.
  if ($view->name == "importers_overview_page" && $display_id !== "default") {
    // Set the footer of the view to have a dynamic more link.
    $options = array(
      'id' => 'area',
      'table' => 'views',
      'field' => 'area',
      'empty' => FALSE,
      'content' => l(t("View all imported profiles"), "admin/config/capx/profiles", array("attributes" => array("class" => array("button")))),
      'format' => 'full_html',
      'tokenize' => 0,
    );
    $view->display_handler->set_option('footer', array('text' => $options));
  }

  // Profile list view page menu in header.
  if ($view->name == "capx_admin_profiles" && $display_id == "profiles") {
    $menu_block = stanford_capx_management_menu_block();
    drupal_add_css($menu_block['#attached']['css'][0]);

    $options = array(
      'id' => 'area',
      'table' => 'views',
      'field' => 'area',
      'empty' => TRUE,
      'content' => $menu_block['#markup'],
      'format' => 'full_html',
      'tokenize' => 0,
    );

    $view->display_handler->set_option('header', array('text' => $options));
  }
}