Enable other modules to use geocoding field processing [#1627906]

Problem/Motivation

Currently the geocoder widget includes fairly complex handling of field values. This handling is embedded in a hook implementation. Other modules however may have a use for geocoder's handling.

Proposed resolution

Pull the relevant code into a new function.

Remaining tasks

Needs review.

User interface changes

n/a

API changes

Introduces new function, geocoder_widget_get_field_value(), that returns the field value for a geocoded field.

Sample code:

    if ($field_value = geocoder_widget_get_field_value($entity_type, $entity, $field_instance)) {
      $values = reset($field_value[LANGUAGE_NONE]);
    }

Comment	File	Size	Author
#5	geocoder-reuse-1627906-5.patch	856 bytes	nedjo
#5
#1	geocode-reuse-1627906-1.patch	7.92 KB	nedjo
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

nedjo

he/him/his

English

CreditAttribution: nedjo commented 11 June 2012 at 23:50

Status:

Active

» Needs review

File	Size
geocode-reuse-1627906-1.patch	7.92 KB

Comment #2

phayes CreditAttribution: phayes commented 14 June 2012 at 17:07

Just looking at the code it looks good. Still need to apply and test.

Comment #3

nedjo

he/him/his

English

CreditAttribution: nedjo commented 14 June 2012 at 23:11

Wrote this because I needed it for #1627940: Add optional geocoding to map input widget.

A potentially confusing detail of the patch comes from the fact that the original function had three possible outcomes: do nothing, unset the existing field value, and assign a new field value. To handle all three, the new helper function returns one of three different values:

FALSE: do nothing.
An empty array: use it to unset the existing field value.
A populated array: assign a new field value.

What each of these values means is not particularly intuitive. At the least, the return value should be documented in the phpdocs.