islandora_solr_views.views.inc

<?php

/**
 * @file
 * This file contains views definitions. Defines views and data/field types.
 */


/**
 * Implements hook_views_plugins().
 */
function islandora_solr_views_views_plugins() {
  return array(
    'module' => 'islandora_solr_views',
    'query' => array(
      'islandora_solr_views_query' => array(
        'title' => t('Islandora Solr Query'),
        'help' => t('Query that allows you to search Islandora Solr.'),
        'handler' => 'islandora_solr_views_query',
        'parent' => 'views_query',
      ),
    ),
  );

}

/**
 * Implements hook_views_data().
 */
function islandora_solr_views_views_data() {
  // Set base variables.
  $base_field = 'PID';
  $base_table = 'islandora_solr';
  $data[$base_table]['table']['group'] = t('Islandora Solr');

  $data[$base_table]['table']['base'] = array(
    'query class' => 'islandora_solr_views_query',
    'title' => t('Islandora Solr'),
    'help' => t('Searches the Islandora Solr index.'),
    'field' => $base_field,
  );

  // Get the list of the fields in index directly from Solr.
  $luke = islandora_solr_get_luke();
  $solr_fields = $luke['fields'];

  // Always add score handlers.
  $data[$base_table]['score'] = array(
    'title' => t('Score'),
    'help' => t('Relevancy score'),
    'field' => array(
      'handler' => 'islandora_solr_views_handler_field',
      'click sortable' => TRUE,
    ),
    'argument' => array(
      'handler' => 'islandora_solr_views_handler_argument',
    ),
    'filter' => array(
      'handler' => 'islandora_solr_views_handler_filter',
    ),
    'sort' => array(
      'handler' => 'islandora_solr_views_handler_sort',
    ),
  );

  // Include object manage link.
  $data[$base_table]['islandora_manage'] = array(
    'title' => t('Manage link'),
    'help' => t('Provide a simple link to manage the content.'),
    'field' => array(
      'handler' => 'islandora_solr_views_handler_field_manage',
    ),
  );

  // Include a lucene query parser filter (q).
  $data[$base_table]['query_lucene'] = array(
    'title' => t('Query Parser (Lucene)'),
    'help' => t('Query Parser field to perform Lucene keyword searches.'),
    'filter' => array(
      'handler' => 'islandora_solr_views_handler_filter_query_lucene',
    ),
  );

  // Include a dismax query parser filter (q).
  $data[$base_table]['query_dismax'] = array(
    'title' => t('Query Parser (DisMax)'),
    'help' => t('Query Parser field to perform DisMax keyword searches.'),
    'filter' => array(
      'handler' => 'islandora_solr_views_handler_filter_query_dismax',
    ),
  );

  // Loop over all solr fields.
  foreach ($solr_fields as $solr_field_name => $solr_field) {

    // We do not allow to display 'sort_*' fields.
    if (strpos($solr_field_name, 'sort_') === 0) {
      continue;
    }
    // Set luke field variables.
    $field_type = $solr_field['type'];
    $field_schema = $solr_field['schema'];
    $field_dynamicbase = isset($solr_field['dynamicBase']) ? $solr_field['dynamicBase'] : NULL;

    // Set field handlers.
    $field = array();
    $field['title'] = $solr_field_name;
    $field['help'] = t('Type') . ': ' . $field_type;
    // Field handler.
    if ($field_type == 'date') {
      $field['field']['handler'] = 'islandora_solr_views_handler_field_date';
    }
    else {
      $field['field']['handler'] = 'islandora_solr_views_handler_field';
    }
    // Check if sortable.
    if (strstr($field_schema, "I") != FALSE AND strstr($field_schema, "M") == FALSE) {
      $field['field']['click sortable'] = TRUE;
    }
    // Argument handler.
    $field['argument'] = array(
      'handler' => 'islandora_solr_views_handler_argument',
    );
    // Filter handler.
    $field['filter'] = array(
      'handler' => 'islandora_solr_views_handler_filter',
    );
    // Sortable handler.
    // Check if sortable: must be indexed and can't be multivalued.
    // http://wiki.apache.org/solr/CommonQueryParameters#sort
    if (strstr($field_schema, "I") != FALSE AND strstr($field_schema, "M") == FALSE) {
      $field['sort'] = array(
        'handler' => 'islandora_solr_views_handler_sort',
      );
    }
    // Add array.
    $data[$base_table][$solr_field_name] = $field;
  }
  // Add our collection counting goodness.
  $data[$base_table]['solr_collection_count'] = array(
    'title' => 'Collection count',
    'help' => t('This shows the number of immediate child objects in the collection.'),
    'field' => array(
      'handler' => 'IslandoraSolrViewsHandlerCollectionCount',
    ),
  );
  return $data;
}