You are here

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

Same name and namespace in other branches
  1. 6.3 handlers/views_handler_argument_many_to_one.inc \views_handler_argument_many_to_one::option_definition()
  2. 6.2 handlers/views_handler_argument_many_to_one.inc \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 (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_many_to_one::option_definition()
views_handler_argument_term_node_tid::option_definition in modules/taxonomy/views_handler_argument_term_node_tid.inc
Information about options for all kinds of purposes will be held here.
1 method overrides views_handler_argument_many_to_one::option_definition()
views_handler_argument_term_node_tid::option_definition in modules/taxonomy/views_handler_argument_term_node_tid.inc
Information about options for all kinds of purposes will be held here.

File

handlers/views_handler_argument_many_to_one.inc, line 41
Definition of views_handler_argument_many_to_one.

Class

views_handler_argument_many_to_one
Argument handler for fields that have many-to-one table relationships.

Code

public 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;
}