public function views_handler_argument_string::option_definition in Views (for Drupal 7) 7.3

Same name and namespace in other branches

1. 6.3 handlers/views_handler_argument_string.inc \views_handler_argument_string::option_definition()
2. 6.2 handlers/views_handler_argument_string.inc \views_handler_argument_string::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_argument::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

1 call to views_handler_argument_string::option_definition()

views_handler_argument_field_list_string::option_definition in modules/field/views_handler_argument_field_list_string.inc

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

1 method overrides views_handler_argument_string::option_definition()

views_handler_argument_field_list_string::option_definition in modules/field/views_handler_argument_field_list_string.inc

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

File

handlers/views_handler_argument_string.inc, line 32

Definition of views_handler_argument_string.

Class

views_handler_argument_string

Argument handler to implement string arguments that may have length limits.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['glossary'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['limit'] = array(
    'default' => 0,
  );
  $options['case'] = array(
    'default' => 'none',
  );
  $options['path_case'] = array(
    'default' => 'none',
  );
  $options['transform_dash'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['break_phrase'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  $options['not'] = array(
    'default' => FALSE,
    'bool' => TRUE,
  );
  if (!empty($this->definition['many to one'])) {
    $options['add_table'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['require_value'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
  }
  return $options;
}