Add optional geocoding to map input widget

Here's a beginning, along the lines outlined in "proposed resolution". It's a complex issue and there are several possible approaches--not sure this is the best, but thought I'd sketch something in. Not currently functional--geocoding in a validate callback doesn't set the rendered form values. Ideas or improvements on that issue or on the overall approach welcome.

Should this be on 7.x-2.x? Or wait until the widget-revamp branch stabilizes?

Sketched in some relevant assumptions in #1393246-22: Interactive geocoding widget.

Some minor fixes (output an element wrapper div using #prefix and #suffix, change button from 'submit' to 'button'). However, still not outputting the geocoded values in the returned form element.

Here's a patch on the 2.x branch.

The patch is now working thanks to a tip about working with AJAX submissions. Not sure if that's the recommended approach--unsetting an input, seems like a quirky workaround. Could use review by someone familiar with D7 AJAX forms.

The patch includes a couple of unrelated fixes I needed to do to get it working: removing a duplicate widget declaration from geofield_field_widget_info() and returning a form from openlayers_field_widget_settings_form(). I'll pull those into a separate patch when I get a chance.

This patch still requires the patch at #1627906: Enable other modules to use geocoding field processing.

Reroll after recent changes. Also improve #states handling.

Requires #1637476: Geofield widget does not show and "Store each simple feature as a separate field." doesnt work and #1637904: Remove duplicate geofield_openlayers widget (the first of which presumably will require manual patching, since it changes contiguous lines).

Attaching a screenshot of the widget when configured to use geocoder.

When the button is clicked, just the widget part of the form is returned via AJAX, including a point geocoded from the address (if one was entered).

However, if there's an error on the form (e.g., title field is empty), that error message is returned and no geocoding is done. Need to look into the code more closely to see how to avoid triggering validation errors.

Update summary.

Here's a considerably improved patch based on study of core's add_more field widget. Now doesn't trigger validation errors.

Reviewing with Patrick.

Needs testing with multiple values.

+++ b/geofield.widgets.openlayers.inc
@@ -86,6 +137,41 @@ function openlayers_field_widget_form(&$form, &$form_state, $field, $instance,
+      '#limit_validation_errors' => array(array_merge($parents, array($field_name, $langcode)), array($settings['geocoder_field'], $langcode)),

This line could use a comment. Also, determine if both fields need to be excluded or only the geocoder field.

+++ b/geofield.widgets.openlayers.inc
@@ -94,6 +180,46 @@ function openlayers_field_widget_form(&$form, &$form_state, $field, $instance,
+    drupal_array_set_nested_value($form_state, array_merge(array('input'), $parents, array($field_name)), $field_value);

Needs code comment.

Also, add a message if no geocoder results returned.

+++ b/geofield.widgets.openlayers.inc
@@ -94,6 +180,46 @@ function openlayers_field_widget_form(&$form, &$form_state, $field, $instance,
+function openlayers_widget_geocode($form, $form_state) {
...
+  return $form[$field_name];

This looks like it will fail if e.g. the geofield is nested in a fieldset. Find #parents and use drupal_array_get_nested_value().

Thanks Patrick. Here's an updated patch addressing most of the issues noted in #9.

Changes:

• Return just the individual field delta from the AJAX call. This change means the patch at least minimally works with multiple geofield values. It should also be fine with geofields nested in fieldsets, though I haven't tested that.
• Improve inline code comments.
• Manually wrap the geocoder elements of field settings in a fieldset for readability.
• Suppress the geocoder button when generating the widget for the field settings default value.

Remaining issues:

• For some reason on the returned content with multiple values the delta's weight widget is visible. Not sure if there's much we can do about that without hacking. If geocoder goes back to using a single widget for multiple values presumably this problem will disappear.
• In #1637108-2: Lat/Lon FormAPI: Add button to force geocode Brandonian suggested "I think we should change the text on the button from 'Geocode,' which is technical jargon, to something like 'Find Me' or 'Find my Location,' which reflects what's happening in a way that an end user is more likely to understand." Presumably we should do the same here. Currently the label is "Geocode from [field label] field". What should it be instead? Maybe "Place" or "Map" or "Locate" instead of "Geocode"?

Reference field_form_set_state().

Fixed the visible weight issue from #11 by unsetting the weight prior to returning the form element (same as is done in addressfield module with the address widget).

Changed "Geocode from [field label] field" to "Find using [field label] field" to be consistent with the labelling introduced in #1637108: Lat/Lon FormAPI: Add button to force geocode.

Successfully tested with:

• Single value geofield
• Multi-value geofield
• Unlimited value geofield
• Multiple value address field--geocodes to geofield by corresponding delta
• Geofield nested in field group
• Address field nested in field group

All identified issues now addressed so this is ready for review.

Update remaining tasks.

@henryblyth: thanks for testing!

There seems to be a problem with the geocoder dev release--it doesn't contain the latest code. Please try with a git clone of the geocoder 7.x-1.x branch. Please also apply the latest patches from the issues linked in the "Remaining tasks" section of this issue's summary.