function views_handler_argument::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,
• '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 internal format to TRUE/FALSE instead of 1/0.

),

Return value

array: Returns the options of this handler/plugin.

Overrides views_handler::option_definition

See also

views_object::unpack_translatable()

File

modules/views/handlers/views_handler_argument.inc, line 182

@todo.

Class

views_handler_argument

Base class for arguments.

Code

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

  $options['default_action'] = array('default' => 'ignore');
  $options['exception'] = array(
    'contains' => array(
      'value' => array('default' => 'all'),
      'title_enable' => array('default' => FALSE, 'bool' => TRUE),
      'title' => array('default' => 'All', 'translatable' => TRUE),
    ),
  );
  $options['title_enable'] = array('default' => FALSE, 'bool' => TRUE);
  $options['title'] = array('default' => '', 'translatable' => TRUE);
  $options['breadcrumb_enable'] = array('default' => FALSE, 'bool' => TRUE);
  $options['breadcrumb'] = array('default' => '', 'translatable' => TRUE);
  $options['default_argument_type'] = array('default' => 'fixed');
  $options['default_argument_options'] = array('default' => array());
  $options['default_argument_skip_url'] = array('default' => FALSE, 'bool' => TRUE);
  $options['summary_options'] = array('default' => array());
  $options['summary'] = array(
    'contains' => array(
      'sort_order' => array('default' => 'asc'),
      'number_of_records' => array('default' => 0),
      'format' => array('default' => 'default_summary'),
    ),
  );
  $options['specify_validation'] = array('default' => FALSE, 'bool' => TRUE);
  $options['validate'] = array(
    'contains' => array(
      'type' => array('default' => 'none'),
      'fail' => array('default' => 'not found'),
    ),
  );
  $options['validate_options'] = array('default' => array());

  return $options;
}