function apachesolr_get_field_mappings in Apache Solr Search 7

Same name and namespace in other branches

1. 6.3 apachesolr.module \apachesolr_get_field_mappings()

Gets the Apache Solr field mappings.

Field mappings define the various callbacks and Facet API keys associated with field types, i.e. "integer", "date", etc. Mappings are gathered by invoking hook_apachesolr_field_mappings().

Parameters

string $entity_type: The machine name of the entity mappings are being collected for.

Return value

array An associative array keyed by field type to an array of mappings containing:

• dependency plugins: The Facet API dependency plugins associated with fields of this type.
• map callback: The Facet API map callback that converts the raw values stored in the index to something human readable.
• name callback: Callback used to modify the base name of the field as it is stored in Solr. For example, the name callback cound change an integer field from "field_foo" to "field_bar" so that it is stored in Solr as "i_field_bar".
• hierarchy callback: The Facet API hierarchy processing callback for hierarchical facets.
• indexing_callback: Callback used to retrieve values for indexing.
• index_type: The Solr datatype associated with this field type.
• facets: A boolean flagging whether facets are allowed for this field.
• facet missing allowed: A boolean flagging whether the Facet API "missing facets" setting is supported by fields of this type.
• facet mincount allowed: A boolean flagging whether the Facet API "minimum facet count" setting is supported by fields of this type.
• multiple: A boolean flagging whether the field contains multiple values.

See also

http://drupal.org/node/1825426

1 call to apachesolr_get_field_mappings()

apachesolr_entity_fields in ./apachesolr.module

Returns array containing information about node fields that should be indexed

File

./apachesolr.module, line 2209

Integration with the Apache Solr search application.

Code

function apachesolr_get_field_mappings($entity_type) {
  $field_mappings =& drupal_static(__FUNCTION__, array());
  if (!isset($field_mappings[$entity_type])) {
    $field_mappings[$entity_type] = module_invoke_all('apachesolr_field_mappings');
    $mappings =& $field_mappings[$entity_type];
    foreach (array_keys($mappings) as $key) {

      // Set all values with defaults.
      $defaults = array(
        'dependency plugins' => array(
          'bundle',
          'role',
        ),
        'map callback' => FALSE,
        'name callback' => '',
        'hierarchy callback' => FALSE,
        'indexing_callback' => '',
        'index_type' => 'string',
        'facets' => FALSE,
        'facet missing allowed' => FALSE,
        'facet mincount allowed' => FALSE,
        // Field API allows any field to be multi-valued.
        'multiple' => TRUE,
      );
      if ($key !== 'per-field') {
        $mappings[$key] += $defaults;
      }
      else {
        foreach (array_keys($field_mappings[$entity_type][$key]) as $field_key) {
          $mappings[$key][$field_key] += $defaults;
        }
      }
    }

    // Allow other modules to add or alter the field mappings.
    drupal_alter('apachesolr_field_mappings', $mappings, $entity_type);
  }
  return $field_mappings[$entity_type];
}