You are here

function views_handler::option_definition in Views (for Drupal 7) 6.3

Same name and namespace in other branches
  1. 7.3 includes/handlers.inc \views_handler::option_definition()

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


'option_name' => array(
 - 'default' => default value,
 - 'translatable' => TRUE/FALSE (wrap in t() on export if true),
 - 'contains' => array of items this contains, with its own defaults, etc.
     If contains is set, the default will be ignored and assumed to
     be array()

 ),
 

Each option may have any of the following functions:

  • export_option_OPTIONNAME -- Special export handling if necessary.
  • translate_option_OPTIONNAME -- Special handling for translating data within the option, if necessary.

Overrides views_object::option_definition

6 calls to views_handler::option_definition()
views_handler_area::option_definition in handlers/views_handler_area.inc
Information about options for all kinds of purposes will be held here.
views_handler_argument::option_definition in handlers/views_handler_argument.inc
Information about options for all kinds of purposes will be held here.
views_handler_field::option_definition in handlers/views_handler_field.inc
Information about options for all kinds of purposes will be held here.
views_handler_filter::option_definition in handlers/views_handler_filter.inc
Information about options for all kinds of purposes will be held here.
views_handler_relationship::option_definition in handlers/views_handler_relationship.inc
Information about options for all kinds of purposes will be held here.

... See full list

6 methods override views_handler::option_definition()
views_handler_area::option_definition in handlers/views_handler_area.inc
Information about options for all kinds of purposes will be held here.
views_handler_argument::option_definition in handlers/views_handler_argument.inc
Information about options for all kinds of purposes will be held here.
views_handler_field::option_definition in handlers/views_handler_field.inc
Information about options for all kinds of purposes will be held here.
views_handler_filter::option_definition in handlers/views_handler_filter.inc
Information about options for all kinds of purposes will be held here.
views_handler_relationship::option_definition in handlers/views_handler_relationship.inc
Information about options for all kinds of purposes will be held here.

... See full list

File

includes/handlers.inc, line 325
handlers.inc Defines the various handler objects to help build and display views.

Class

views_handler
Base handler, from which all the other handlers are derived. It creates a common interface to create consistency amongst handlers and data.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['id'] = array(
    'default' => '',
  );
  $options['table'] = array(
    'default' => '',
  );
  $options['field'] = array(
    'default' => '',
  );
  $options['relationship'] = array(
    'default' => 'none',
  );
  $options['group_type'] = array(
    'default' => 'group',
  );
  $options['ui_name'] = array(
    'default' => '',
  );
  return $options;
}