function commerce_order_ui_handler_area_view_order_form::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_ui_handler_area_view_order_form.inc, line 9

Class

commerce_order_ui_handler_area_view_order_form

Defines an area handler that displays a "View order" form allowing the user to enter an order number and redirect to that order's view page.

Code

function option_definition() {
  $options = parent::option_definition();

  // Undefine the empty option.
  unset($options['empty']);

  // Define an option to control the order identifier and redirect page.
  $options['identifier'] = array(
    'default' => 'order_number',
  );
  $options['redirect_page'] = array(
    'default' => 'admin',
  );
  return $options;
}