function views_handler_argument_many_to_one::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_argument::option_definition

See also

views_object::unpack_translatable()

File

core/modules/views/handlers/views_handler_argument_many_to_one.inc, line 30

Definition of views_handler_argument_many_to_one.

Class

views_handler_argument_many_to_one

An argument handler for use in fields that have a many to one relationship with the table(s) to the left. This adds a bunch of options that are reasonably common with this type of relationship. Definition terms:

Code

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

  if (!empty($this->definition['numeric'])) {
    $options['break_phrase'] = array('default' => FALSE, 'bool' => TRUE);
  }

  $options['add_table'] = array('default' => FALSE, 'bool' => TRUE);
  $options['require_value'] = array('default' => FALSE, 'bool' => TRUE);

  if (isset($this->helper)) {
    $this->helper->option_definition($options);
  }
  else {
    $helper = new views_many_to_one_helper($this);
    $helper->option_definition($options);
  }

  return $options;
}