uc_extra_fields_pane.api.php in Extra Fields Checkout Pane 7

These hooks are invoked by the Extra Fields Pane module.

File

uc_extra_fields_pane.api.php

<?php

/**
 * @file
 * These hooks are invoked by the Extra Fields Pane module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Perform actions when something happens with a field.
 * Note that this only about the field itself, not about filled in values by
 * customers.
 *
 * @param UCXF_Field $field
 *   An instance of UCXF_Field, representing a row from the uc_extra_fields
 *   table.
 * @param string $op
 *   The action that is occurring. Possible values:
 *   - load: called when the field data is loaded. This hook is invoked in
 *     uc_extra_fields_pane_field_load().
 *   - insert: called when a new field is created. This hook is invoked in the
 *     method save() from the UCXF_Field class.
 *   - update: called when a field's settings is updated. This hook is invoked
 *     in the method save() from the UCXF_Field class.
 *   - delete: called when a field is deleted.  This hook is invoked in the
 *     method delete() from the UCXF_Field class.
 * @return void
 */
function hook_ucxf_field($field, $op) {
  switch ($op) {
    case 'delete':

      // The field is deleted, delete previous filled in values (this does not
      // happen by default).
      db_delete('uc_extra_fields_values')
        ->condition('field_id', $field->field_id)
        ->execute();
      break;
  }
}

/**
 * Add display options for a field or a field value.
 * Useful if you have additional places where you display a value filled
 * in by the customer.
 *
 * When you have a display option like in the example below, you can ask the
 * instance of UCXF_Field whether the value (or field) may displayed like this:
 * $field->may_display('invoice');
 *
 * @param UCXF_Field $field
 *   An instance of UCXF_Field, representing a row from the uc_extra_fields
 *   table.
 * @return array
 */
function hook_ucxf_display_options($field) {
  $options = array(
    'invoice' => array(
      'title' => t('Invoice'),
      'description' => t('When checked, this value will be shown on my custom created invoice.'),
    ),
  );
  return $options;
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_ucxf_display_options	Add display options for a field or a field value. Useful if you have additional places where you display a value filled in by the customer.
hook_ucxf_field	Perform actions when something happens with a field. Note that this only about the field itself, not about filled in values by customers.