function hook_repeating_date_has_changed in Date Repeat Entity 7

Same name and namespace in other branches

1. 7.2 date_repeat_entity.api.php \hook_repeating_date_has_changed()

Determines if an entity with a repeating date has changed.

Parameters

object $original_entity: The original entity before being updated.

object $updated_entity: The updated entity.

string $entity_type: The entity type

Return value

bool indicates if the date values of an entity with a repeating date have materially changed from original to current state.

1 function implements hook_repeating_date_has_changed()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

date_repeat_entity_repeating_date_has_changed in includes/date_repeat_entity.update.inc

Implements hook_repeating_date_has_changed().

1 invocation of hook_repeating_date_has_changed()

date_repeat_entity_update_dates in includes/date_repeat_entity.update.inc

Update or replaces date entities based on a scope determined by user.

File

./date_repeat_entity.api.php, line 22

Hooks provided by the Date Repeat Entity module.

Code

function hook_repeating_date_has_changed($original_entity, $updated_entity, $entity_type = 'node') {
  $repeating_date_has_changed = FALSE;

  // Check that entity aleady exists - we are not validating new entities.
  if (!is_null($original_entity) && !is_null($updated_entity)) {

    // Create two wrappers.
    $original_wrapper = entity_metadata_wrapper($entity_type, $original_entity);
    $updated_wrapper = entity_metadata_wrapper($entity_type, $updated_entity);

    // Get bundle type from original entity.
    $bundle = $original_wrapper
      ->getBundle();

    // Make sure utility functions are available.
    module_load_include('inc', 'date_repeat_entity', 'includes/date_repeat_entity.utility');
    $repeating_date_field = date_repeat_entity_get_repeating_date_field($entity_type, $bundle);

    // Check that the entity form has a repeating date field.
    if ($repeating_date_field != NULL) {

      // Get the name of the repeating field.
      $repeating_date_field_name = $repeating_date_field['field_name'];

      // Get original date field properties.
      $original_date = $original_wrapper->{$repeating_date_field_name}[0]
        ->value();
      $original_date_start_value = $original_date['value'];
      $original_date_end_value = $original_date['value2'];
      $original_rrule = $original_date['rrule'];

      // Get updated date field properties.
      $updated_date = $updated_wrapper->{$repeating_date_field_name}[0]
        ->value();
      $updated_date_start_value = $updated_date['value'];
      $updated_date_end_value = $updated_date['value2'];
      $updated_rrule = $updated_date['rrule'];

      // Check if the entity date has changed to the extent that
      // the repeating date series has changed and therefore dependent data
      // like date exceptions and referencing entities will need to be reset.
      $updated_date_data = array(
        $updated_date_start_value,
        $updated_date_end_value,
        $updated_rrule,
      );
      $original_date_data = array(
        $original_date_start_value,
        $original_date_end_value,
        $original_rrule,
      );
      if ($updated_date_data !== $original_date_data) {
        $repeating_date_has_changed = TRUE;
      }
    }
  }
  return $repeating_date_has_changed;
}