You are here

Home » API reference » Commerce Core 7 » commerce_order_handler_area_order_total.inc » commerce_order_handler_area_order_total

function commerce_order_handler_area_order_total::option_definition in Commerce Core 7

Information about options for all kinds of purposes will be held here.

@code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_handler_area::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

modules/order/includes/views/handlers/commerce_order_handler_area_order_total.inc, line 8

Class

commerce_order_handler_area_order_total
Defines an area handler that renders an order's total field.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['label_display'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['label_custom'] = array(
    'default' => t('Order total'),
    'translatable' => TRUE,
  );
  $options['label_position'] = array(
    'default' => 'inline',
  );
  $options['formatter'] = array(
    'default' => 'commerce_price_formatted_components',
  );
  return $options;
}