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]);
    }
CommentFileSizeAuthor
#5 geocoder-reuse-1627906-5.patch856 bytesnedjo
#1 geocode-reuse-1627906-1.patch7.92 KBnedjo

Comments

nedjo’s picture

nedjo
he/him/his
Primary language English
commented
Status: Active » Needs review
StatusFileSize
new geocode-reuse-1627906-1.patch7.92 KB
phayes’s picture

phayes commented

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

nedjo’s picture

nedjo
he/him/his
Primary language English
commented

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.

phayes’s picture

phayes commented
Status: Needs review » Fixed

Committed. Thanks Nedjo

nedjo’s picture

nedjo
he/him/his
Primary language English
commented
Status: Fixed » Needs review
StatusFileSize
new geocoder-reuse-1627906-5.patch856 bytes

Missed a variable in the new function that was set in the original one.

phayes’s picture

phayes commented
Status: Needs review » Fixed

Commited.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.