Incorrect use of $field_map in SolrBaseQuery::getSolrsortUrlQuery [#1861544]

  /**
   * Handles aliases for field to make nicer URLs.
   *
   * @param $field_map
   *   An array keyed with aliases with the real Solr index field name as value.
   *
   * @return DrupalSolrQueryInterface
   *   The called object.
   */
  function addFieldAliases($field_map);

According to apachesolr.interfaces.inc, a call to DrupalSolrQueryInterface::addFieldAliases could look like:

$query->addFieldAliases(array('myalias' => 'real_solr_field_name'));

but the code in SolrBaseQuery::getSolrsortUrlQuery() expects the field map to be in the opposite order.

Comment	File	Size	Author
#6	1861544-addFieldAlias-6.patch	1.2 KB	Nick_vh
#6
#4	1861544-addFieldAlias-1.patch	531 bytes	fizk
#4
#1	1861544-field-map-getSolrsortUrlQuery-1.patch	774 bytes	fizk
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

File	Size
1861544-field-map-getSolrsortUrlQuery-1.patch	774 bytes

Comment #2

fizk CreditAttribution: fizk commented 8 December 2012 at 16:27

Status:

Active

» Needs review

Comment #3

Nick_vh

he/him

Ghent

CreditAttribution: Nick_vh commented 24 January 2013 at 12:54

Status:

Needs review

» Needs work

I'm not sure if this is actually a smart move to do an array flip.

I'd have to look deeper in this, could you also make some simpletest proving that the current behaviour is wrong? Maybe updating the documentation is better and we don't suddenly break assumptions?

Comment #4

fizk CreditAttribution: fizk commented 24 January 2013 at 17:10

File	Size
1861544-addFieldAlias-1.patch	531 bytes

Well, we'll be breaking assumptions either way - some think the documentation is right, and others know it isn't.

I agree, changing the documentation is probably going to affect less people. Here's a patch.

Comment #5

fizk CreditAttribution: fizk commented 24 January 2013 at 17:10

Status:

Needs work

» Needs review

Comment #6

Nick_vh

he/him

Ghent

CreditAttribution: Nick_vh commented 25 January 2013 at 18:50

Status:

Needs review

» Patch (to be ported)

File	Size
1861544-addFieldAlias-6.patch	1.2 KB

Adding some more docs, I'm planning to update the whol einterface in #1897556: Update documentation for all the functions and make sure it reflects reality so this already helps. Could you actually clarify for me for what you are trying to implement this and it breaks?

Committed to 7.x1.x, thanks!

Comment #7

Nick_vh

he/him

Ghent

CreditAttribution: Nick_vh commented 25 January 2013 at 18:51

Version:

7.x-1.x-dev

» 6.x-3.x-dev

Comment #8

fizk CreditAttribution: fizk commented 25 January 2013 at 20:03

I'm implementing hook_apachesolr_query_prepare() and calling addFieldAliases() so I can sort by field names that are prettier than the default field names.

/**
 * Implements hook_apachesolr_query_prepare().
 */
function msearch_apachesolr_query_prepare($query) {
    // Sort node creation date via "date"
    $query->addFieldAliases(array('date' => 'ds_created'));

    // Sort author username via "username"
    $query->addFieldAliases(array('username' => 'sort_name'));

    // Sort node type via "type"
    $query->addFieldAliases(array('type' => 'bundle'));

    // Sort node title via "title"
    $query->addFieldAliases(array('title' => 'sort_label'));
}

For anyone else reading this, please note the order should be the other way around (eg. $query->addFieldAliases(array('ds_created' => 'date')); is correct).