function views_handler_relationship::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

core/modules/views/handlers/views_handler_relationship.inc, line 64

Views' relationship handlers.

Class

views_handler_relationship

Simple relationship handler that allows a new version of the primary table to be linked in.

Code

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


  // Relationships definitions should define a default label, but if they aren't get another default value.
  if (!empty($this->definition['label'])) {
    $label = $this->definition['label'];
  }
  else {
    $label = !empty($this->definition['field']) ? $this->definition['field'] : $this->definition['base field'];
  }

  $options['label'] = array('default' => $label, 'translatable' => TRUE);
  $options['required'] = array('default' => FALSE, 'bool' => TRUE);

  return $options;
}