Programmatically set field properties (Rules?!) [#1853744]

In trying to create programmatically a bunch of taxonomy terms with geolocation field attached.

I run into problem with the geolocation module overriding what I am setting for the fields, and claiming that it's now overridden values hasn't got the necessary lat_sin.

My code to enter the data I have coming from another database, including lat+ Long:

function newterm($newterm){
$term = new stdClass();
$term->name = $newterm['name'];
$term->description = $newterm['name'];
if (isset($newterm['street']))$term->field_custom_field_street[LANGUAGE_NONE][0]['value'] = $newterm['street'];
if (isset($newterm['addrinfo']))$term->field_custom_field_addrinfo[LANGUAGE_NONE][0]['value'] = $newterm['addrinfo'];
if (isset($newterm['suburb']))$term->field_custom_field_suburb[LANGUAGE_NONE][0]['value'] = $newterm['suburb'];
if (isset($newterm['area']))$term->field_custom_field_area[LANGUAGE_NONE][0]['value'] = $newterm['area'];
if (isset($newterm['postcode']))$term->field_custom_field_postcode[LANGUAGE_NONE][0]['value'] = $newterm['postcode'];
if (isset($newterm['latitude'])){
     $term->field_custom_field_geolocation[LANGUAGE_NONE][0]['lat'] = $newterm['latitude'];
     $term->field_custom_field_geolocation[LANGUAGE_NONE][0]['lat_sin'] = round(sin($newterm['latitude']),5);
     $term->field_custom_field_geolocation[LANGUAGE_NONE][0]['lat_cos'] = round(cos($newterm['latitude']),5);
  }
if (isset($newterm['longitude'])){
      $term->field_custom_field_geolocation[LANGUAGE_NONE][0]['lng'] = $newterm['longitude'];
      $term->field_custom_field_geolocation[LANGUAGE_NONE][0]['lng_rad'] = round(deg2rad($newterm['longitude']),5);
      }
$term->vid = 4;
print_r($term);
taxonomy_term_save($term);
return;
}

Geolocation's presave:

/**
 * Implements hook_field_presave().
 */
function geolocation_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
  foreach ($items as $delta => $item) {
    // Precalculate some goodness.
    $item['lat_sin'] = sin(deg2rad($item['lat']));
    $item['lat_cos'] = cos(deg2rad($item['lat']));
    $item['lng_rad'] = deg2rad($item['lng']);
    $items[$delta] = $item;
  }
}

Which causes the Geolocation module's field_presave to be called, resulting in data looking like this:

Entity type: taxonomy_term
Entity : stdClass Object ( [name] => Palmerston North, Linton Military Camp [description] => Palmerston North, Linton Military Camp [field_custom_field_street] => Array ( [und] => Array ( [0] => Array ( [value] => 42nd Street ) ) ) [field_custom_field_addrinfo] => Array ( [und] => Array ( [0] => Array ( [value] => ) ) ) [field_custom_field_suburb] => Array ( [und] => Array ( [0] => Array ( [value] => Linton Military Camp ) ) ) [field_custom_field_area] => Array ( [und] => Array ( [0] => Array ( [value] => Palmerston North ) ) ) [field_custom_field_postcode] => Array ( [und] => Array ( [0] => Array ( [value] => 4820 ) ) ) [field_custom_field_geolocation] => Array ( [und] => Array ( [0] => Array ( [lat] => -40.4048 [lat_sin] => -0.42223 [lat_cos] => -0.90649 [lng] => 175.585 [lng_rad] => 3.06454 ) ) ) [vid] => 4 [vocabulary_machine_name] => post_codes )

ERROR:
PDOException: SQLSTATE[23000]: Integrity constraint violation: 1048 Column 'field_geolocation_lat_sin' cannot be null: INSERT INTO {field_data_field_geolocation} (entity_type, entity_id, revision_id, bundle, delta, language, field_geolocation_lat, field_geolocation_lng, field_geolocation_lat_sin, field_geolocation_lat_cos, field_geolocation_lng_rad) VALUES (:db_insert_placeholder_0, :db_insert_placeholder_1, :db_insert_placeholder_2, :db_insert_placeholder_3, :db_insert_placeholder_4, :db_insert_placeholder_5, :db_insert_placeholder_6, :db_insert_placeholder_7, :db_insert_placeholder_8, :db_insert_placeholder_9, :db_insert_placeholder_10); Array ( [:db_insert_placeholder_0] => taxonomy_term [:db_insert_placeholder_1] => 17 [:db_insert_placeholder_2] => 17 [:db_insert_placeholder_3] => post_codes [:db_insert_placeholder_4] => 0 [:db_insert_placeholder_5] => und [:db_insert_placeholder_6] => actual lat [:db_insert_placeholder_7] => actual long [:db_insert_placeholder_8] => [:db_insert_placeholder_9] => [:db_insert_placeholder_10] => ) in...

NB: actual latitude and longitude has been fudged above. The main point of which is that my field data is not getting through, this presave function comes along and picks up a new $instance, with the default GPS cooordinates, then it breaks because it hsan't got the data in $items.

How do I program the custom fields without the presave firing, or can I somehow pass a different instance to the presave? Or am I just doing it WRONG?

Comments

Comment #1

felgharb commented 2 February 2013 at 16:38

Hello Did you get to fix that?

Im getting the same error :
I have a content type with a geolocation field with a default value : save my location.
I cannot create this content programatically, Im getting this error always...

Comment #2

Sel_Space commented 29 December 2014 at 13:52

Priority:

Normal

» Major

I have the same issue, the geolocation field isn't required and it throws that exception when trying to create it programatically

Comment #3

Sel_Space commented 29 December 2014 at 13:57

When I remove the default value from the field it works without exception.

Comment #4

doitDave commented 2 December 2015 at 15:29

Sadly, this field seems to be no option in terms of automation.

I have been fiddling around for several hours now trying to simply set a value programmatically. It simply won't work like you would expect from common field/entity API terms.

I simply cannot figure one working way that covers new nodes (hook_node_update + entity_metadata_wrapper workaround was the only thing to work at all).

If I miss anything, kindly point it out. If anyone has found himself a workaround (not necessarily with this very field but with any location field) with no 999 dependencies or prerequisites, I would appreciate your sharing it.

All I want to do is - conditionally - set lat and lng from an image field on the same node (I have an Exif extension that even provides lat and lng tokens for any loaded entity and with any other field I would simply add a rules data value action setting the corresponding property in question to [node:field-image:file:myexifmodule:bla:foo:lat] and [...:lng].

It would be _really_ amazing if geolocation's overall simplicity would also cover this (I suppose: frequent) usecase.

Comment #5

doitDave commented 2 December 2015 at 15:32

Title:	Custom field programming	» Programmatically set field properties (Rules?!)
Category:	Support request	» Feature request

Also updated overall issue, since support will not be enough (from what I find in the codebase).

Comment #6

derjochenmeyer commented 2 December 2015 at 16:01

Status:

Active

» Needs work

Thankful for any idea on how to make this happen.

Comment #7

doitDave commented 3 December 2015 at 06:04

Since your field is still the best choice (for my actual patient at least), let's fix it. :)

first here's how I worked around it in rules (no big deal actually), in hook_node_presave I added some PHP extracted from a form_state dump:

if ($file = field_get_items('node', $node, 'field_image')) {
  $file = array_shift($file);
  if ($file = file_load($file['fid'])) {
    $lat =@ $file->exif->EXIF->GPSLatitude;
    $lng =@ $file->exif->EXIF->GPSLongitude;
    if (isset($lat) && isset($lng)) {
      $node->field_location[LANGUAGE_NONE] = array(array(
        // This is cloned what comes from the module field_presave,
        // done again.
        'lat' => $lat,
        'lng' => $lng,
        'lat_sin' => sin(deg2rad($lat)),
        'lat_cos' => cos(deg2rad($lng)),
        'lng_rad' => deg2rad($lng),
        'field_type' => 'geolocation_latlng', // I figure this is what missed in the first place?
        'address' => array('field' => '(set by exiftool / fotoblog feature / rule_exif_set_location)'),
      ));
    }
  }
}

Then, what could we do. Setting with tokens via rules/"set data value" is probably sophisticated. In any way we should at first move the lat_sin etc. to a later point (if there is one, would need some digging in field_api). In entity terms, this would be probably best done on hook_entity_insert/update (so after _presave additions have been done). But I understand that field is a bit different.

Are you more familiar with fields? Otherwise I can look it up too, but maybe not immediately.

A second step might be to figure a way to set both lat and lng in rules in order to use tokens and other standard tools.

If we got this done, I'd figure that a real boost since as I said anything else is very nice and handy and lightweight (it should stay that way IMO). But integration with more Drupal standard contribs such as rules and token would really be good.

I could actually help with tokens, too.

Comment #8

doitDave commented 3 December 2015 at 06:20

Pragmatic suggestion as a first step:

Let's add an official API function to retrieve the correct field type data (that array from the code above).

some function like

geolocation_get_field_struct($lat, $lng) {
  // code from rules action above
  return array(
  // see above, maybe more respectful for existing data
  );
}

the field_presave callback could also use that function (to reduce c&p code and redundancy).

Comment #9

doitDave commented 23 January 2016 at 16:03

Status:

Needs work

» Needs review

Comment #10

derjochenmeyer commented 12 February 2016 at 11:38

Status:

Needs review

» Active

Good suggestion.

But no patch to review > active :)

Comment #11

doitDave commented 13 February 2016 at 18:41

ok, will create one. good to know you like it. :)

Comment #12

juliencarnot commented 9 September 2016 at 10:02

Sorry if this is slightly off-topic, but it seems related to my current quest: prepopulating a geolocation-field Google Maps formatter with values from the URL, using Prepopulate module. I also tried with a Geolocation Lat/Lng formatter, with the same results.

I cannot guess a working syntax to match the input names and make it work. I've posted an issue for Prepopulate, but after reading usage.txt once again, I'm under the impression that, like for the body field in Drupal, there could be an array containing the field name [field_r_geoloc][0][lat], which led me to this issue.

I gave it a try with [geolocation_latlng][field_r_geoloc][0][lat] following doitDave's comment in #7, but still no luck. Reading the other comments, I'm now wondering if geolocation_field can support the prepopulate mechanism in it's current state.

Would be grateful for any hints or confirmation about this! If I can't get it to work, I might be interested in the upcoming patch and try to work something out with rules!