Club Drupal

 * @file

 * Functionality for the computed field.

 */

/**

 * Implements hook_field_info().

        'recalculate' => FALSE,

    'float' => 'decimal',

    'numeric' => 'decimal',

    'varchar' => 'text',

    'text' => 'text',

    'longtext' => 'text',

    // Entity API's defaults are pretty good so set the property_type and let them do the work for us.

 * Implements hook_field_settings_form().

    '#description' => t('<p>The variables available to your code include: <code>@fields</code>. To set the value of the field, set <code>@entity_field</code>.  For multi-value computed fields continue with <code>@entity_field_multi</code>.  Here\'s a simple example which sets the computed field\'s value to the value of the sum of the number fields (<code>@field_a</code> and <code>@field_b</code>) in a node entity:</p> !example <p>Alternately, this code can be supplied by your own custom function named: <code>@compute_func(&$entity_field, $entity_type, $entity, $field, $instance, $langcode, $items)</code>.</p>', array(

      '@fields' => '&$entity_field, $entity_type, $entity, $field, $instance, $langcode, and $items',

      '@entity_field' => '$entity_field[0][\'value\']',

      '@entity_field_multi' => '$entity_field[1][\'value\']',

      '@field_a' => 'field_a',

      '@field_b' => 'field_b',

      '!example' => '<p><code>$field_a = field_get_items($entity_type, $entity, "field_a");<br />

        $field_b = field_get_items($entity_type, $entity, "field_b");<br />

        $entity_field[0]["value"] = $field_a[0]["value"] + $field_b[0]["value"];</code></p>

      ',

      '@compute_func' => $compute_func,

    )),

    '#description' => t('This code should assign a string to the <code>@display_output</code> variable, which will be printed when the field is displayed. The raw computed value of the field is in <code>@value</code>.  <strong>Note:</strong> this code has no effect if you use the "Raw computed value" display formatter.<p> Alternately, this code can be supplied by your own custom function named: <code>@display_func($field, $entity_field_item, $entity_lang, $langcode, $entity)</code>.  Return the value to be displayed.  Original value is in $entity_field_item[\'value\'].', array(

      '@display_output' => '$display_output',

      '@value' => '$entity_field_item[\'value\']',

      '@display_func' => $display_func,

    )),

    );

  $form['recalculate'] = array(

    '#type' => 'checkbox',

    '#title' => t('Recalculate the field value every time.'),

    '#description' => t('By default, Drupal will cache the value of this field even if it is not stored in the database (and even if Page Caching is disabled). This option will cause computed_field to recalculate the value every time this field is displayed. For example, a time-based calculated value may change more often than field cache is cleared. (Note that Drupal page caching will still cache the field value.)'),

    '#default_value' => is_numeric($settings['recalculate']) ? $settings['recalculate'] : FALSE,

  );

    '#options' => array(

      'varchar' => 'varchar',

      'text' => 'text',

      'longtext' => 'longtext',

      'int' => 'int',

      'float' => 'float',

      'numeric' => 'decimal',

    ),

    '#options' => array(

      'tiny' => 'tiny',

      'small' => 'small',

      'medium' => 'medium',

      'normal' => 'normal',

      'big' => 'big',

    ),

 * #element_validate callback for computed_field_field_settings_form().

 */

 * Implements hook_field_load().

  // Compute field values on load if they aren't stored in the database.

 * Implements hook_field_prepare_view().

  $settings = $field['settings'];

  // Compute field values in case user is "previewing" an entity.

    if ((isset($entity->op) && $entity->op == 'Preview') || $settings['recalculate']) {

 * Implements hook_field_insert().

 * Implements hook_field_update().

 * Implements hook_field_widget_info().

 * Implements hook_field_widget_form().

  // preview errors when selecting a different language.

  if (empty($items)) {

    $items[0]['value'] = NULL;

  }

  $data_to_display = FALSE;

  // Special case formatter that returns the raw computed values without any display code processing.

      if (!isset($entity_field_item['value'])) {

        $entity_field_item['value'] = NULL;

      }

  // Other display formatters which run through display code processing.

  // Check if the value is to be formatted by a display function outside the DB.

  $display_in_code = function_exists($display_func) ? TRUE : FALSE;

  // Loop the items to display.

    // For "some" backwards compatibility.

    // Setup a variable with the entity language if available.

    if (isset($entity->language)) {

      $entity_lang = $entity->language;

    }

    else {

      $entity_lang = LANGUAGE_NONE;

    }

    // If there are value "holes" in the field array let's set the value to NULL.

    // to avoid undefined index errors in typical PHP display code.

    if (!isset($entity_field_item['value'])) {

      $entity_field_item['value'] = NULL;

    }

    // Execute the display code.

    // Track if any of our items produce non-empty output.

    if (!empty($display_output) || is_numeric($display_output)) {

      $data_to_display = TRUE;

    }

    // Output the formatted display item.

  // If all items are empty then we should not return anything. This helps

  // ensure that empty fields are not displayed at all. This check does not

  // apply to fields stored in the DB as those are instead checked on save.

  if (isset($field['settings']['store']) && !$field['settings']['store'] && !$data_to_display) {

    return;

  }

 * Implements hook_field_is_empty().

  unset($empty);

  // This will depend on the class of data type.

  switch ($field['settings']['database']['data_type']) {

    case 'int':

    case 'float':

    case 'numeric':

      // For numbers, the field is empty if the value isn't numeric.

      $empty = !is_numeric($item['value']);

      break;

    case 'varchar':

    case 'text':

    case 'longtext':

      // For strings, the field is empty if it doesn't match the empty string.

      $empty = ($item['value'] === "");

      break;

  return $empty;

  // Setup a variable with the field values.

  // Setup a variable with the entity language if available.

  if (isset($entity->language)) {

    $entity_lang = $entity->language;

  }

  else {

    $entity_lang = LANGUAGE_NONE;

  }

  // Allow the value to be computed from code not stored in DB.