function views_handler_sort::option_definition

3.x views_handler_sort.inc views_handler_sort::option_definition()
2.x views_handler_sort.inc views_handler_sort::option_definition()

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::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

2 calls to views_handler_sort::option_definition()
views_handler_sort_date::option_definition in handlers/views_handler_sort_date.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
views_handler_sort_menu_hierarchy::option_definition in handlers/views_handler_sort_menu_hierarchy.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
2 methods override views_handler_sort::option_definition()
views_handler_sort_date::option_definition in handlers/views_handler_sort_date.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
views_handler_sort_menu_hierarchy::option_definition in handlers/views_handler_sort_menu_hierarchy.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

File

handlers/views_handler_sort.inc, line 35
@todo.

Class

views_handler_sort
Base sort handler that has no options and performs a simple sort.

Code

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

  $options['order'] = array('default' => 'ASC');
  $options['exposed'] = array('default' => FALSE, 'bool' => TRUE);
  $options['expose'] = array(
    'contains' => array(
      'label' => array('default' => '', 'translatable' => TRUE),
    ),
  );
  return $options;
}