calculate Computed Field from datetime-range/time-range field using custom module hook

Question

OK, I've been struggling with this for days now. Hopefully someone can shed some light on this...

Site is on Drupal 9.4.3 (currently the latest) using PHP 8.1.6

I have a content type with a datetime_range field setup to use as time-range (Start time and End Time) formatted for time only input. Field Name: field_friday_hours

The content type also has a computed_field decimal field, where I want to set the total hours calculated from the "Start time and End time" of the date range field. Computed Field Name: field_test_total_hours

The date range field collecting the start and stop time also uses time_range contrib module as well as DateTime Hide Seconds (datetimehideseconds) module - which I don't know if that's been complicating the situation for me or if that doesn't matter.

The computed field gives me this code sample to use in a custom module: The hook implementation function signature should be

computed_field_field_test_total_hours_compute($entity_type_manager, $entity, $fields, $delta)

and the desired value should be returned. The variables available to your code include:

$entity_type_manager: The entity type manager.
$entity: The entity the field belongs to.
$fields: The list of fields available in this entity.
$delta: Current index of the field in case of multi-value computed fields (counting from 0).
$value: The resulting value to be set above, or returned in your hook implementation).

Here is what dpm($form); gives me on node/add/...(

In the above I believe the 2nd to last array is the one I'm looking for yet I have no idea what to do with that information in this particular situation.

In my custom module I've tried a bunch of random things found in other posts that yield either no results or produces errors.

I've tried

function computed_field_field_test_total_hours_compute($entity_type_manager, $entity, $fields, $delta) {
  $start_time = $entity->field_friday_hours[0]['value'];
  $end_time = $entity->field_friday_hours[0]['end_value'];
  $total_time = $end_time - $start_time;
  
  $value = $total_time;
}

additionally I've tried to get the time values with: (examples for $start_time...)

$start_time = $fields['field_friday_hours'][0]['value']['time']['#value'];
$start_time = $entity->field_friday_hours[0]['value']['#default_value'];
$start_time = $entity->get('field_friday_hours')->getValue();
$start_time = $field['field_friday_hours'][0]['value']['time']['#value'];

And several variations of the above as well including $start = $start_time->_toString and $start_time = $entity->field_friday_hours[0]['value']->format('H:i'); etc etc etc, nothing is getting me where I need to be!

Further more even trying to just set the value of the computed field using something like $value = 8.5; without trying to get any other field data/values and it won't even set it. So I'm assuming I missed the boat on this completely.

I know with computed field there is also the option to format the computed field via a plugin and doing calculations there - however before I even attempt that approach I'd like to know how to make the hook approach work correctly.

I even tried hook_alter like this:

function custom_module_computed_field_field_test_total_hours_value_alter(&$value, $context) {

}

But nothing there seamed to work either!

At this point my head is pounding from reviewing document after document having searched for an answer extensively with nothing adding up and or working.

If recreating the the computed field in another type would help I'm all for it - or if there is a definite easier way to do this I'm all ears...

Please HELP - Thanks in advance!

Hi.. I'm wondering if someone wouldn't mind telling me how I can edit this post to improve it? — sidgrafix, Jul 28 '22 at 18:46

score 0 · Accepted Answer · answered Jul 28 '22 at 19:42

So after a lot of trial and error I finally figured things out.

With the use of the provided function displayed on the computed fields edit page in my custom module as follows:

function computed_field_field_test_total_hours_compute($entity_type_manager, $entity, $fields, $delta) {
// Get and set Start time
  $get_stime = $entity->field_friday_hours->value;
  $start_time = new DrupalDateTime($get_stime);

// Get and set End time
  $get_etime = $entity->get('field_friday_hours')->getValue()[0]['end_value'];
  $end_time = new DrupalDateTime($get_etime);

// Calculate hours to decimal
  $diff = $end_time->getTimestamp() - $start_time->getTimestamp();
  $hours = $diff/3600;
  $tot_hours = round($hours, 2);

// Set Computed field value
  $value = $tot_hours;
  return $value;
}

In comparison to what I was originally trying (which was initially based on other posts and answers to similar questions when trying to get field values in a hook or function) I was close. Looks like I didn't have enough information with setting a variable with $entity or it was in the wrong format.

I'm still not 100% clear on what patterns in what types of hooks can be used to get field data especially in Drupal 8 and 9, let alone through the use of a custom module. Most documentation especially for contributed modules for anything Drupal 8 or 9 is incomplete or none existent.

I ended up having to simplifying things first and work through it.

First by just setting a generic value and returning it to make sure the computed field actually populated on node save.
After that I made sure I could do basics to generate a value to return, by creating a date with start and end time from a string without getting it from any fields. I could manage this fine in both the suggested function and hook_value_alter.
Then I created simple text field and tried to get it's field value.
Still for the life of me I couldn't figure out how to get a basic text field value in hook_value_alter, so I switched to the suggested function as the few snippets I found using $entity worked to get the text fields value and on node save it took the value of the text field and placed it in the computed field.
After that it took a little more in trial and error on getting the actual date-range using time-range field values.

At this time what confused me the most was were I could get the start time with this:

$entity->field_friday_hours->value;

To get the end time value I couldn't do this:

$entity->field_friday_hours->end_value;

I had to do this:

$entity->get('field_friday_hours')->getValue()[0]['end_value'];

Which at first struck me as odd; anytime I tried to use get() or getValue() I constantly fatal errored with can't get or getValue of null. So for the longest time I really thought that wouldn't work in either the suggested function or hook_value_alter.

That said using dpm($form) made how it ended up working even a bit more confusing, considering that should have given me the structure to use to get the start and end time values "at least from what I understood" and had read pretty much everywhere.

Yet using the array structure per dpm() the order should have included ['widget'] before [0] which was not the case in the final result.

If I'm understanding correctly now get() gets the field and getValue() starts from whatever part of the object array that follows it - which is still a tad bit confusing (aside from the fact I may be completely wrong on that, as I'm just going by what I can see happening as I worked through everything)

Please feel free to correct me on anything.

Regardless this works in Drupal 9 to get date-range start and end times and then convert them to hours in a decimal format and return them to a computed field.

calculate Computed Field from datetime-range/time-range field using custom module hook

1 Answers1