You are here

Home » API reference » Views (for Drupal 7) 7.3 » views_handler_field_boolean.inc » views_handler_field_boolean

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

Same name and namespace in other branches
  1. 6.3 handlers/views_handler_field_boolean.inc \views_handler_field_boolean::option_definition()
  2. 6.2 handlers/views_handler_field_boolean.inc \views_handler_field_boolean::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_field::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

handlers/views_handler_field_boolean.inc, line 29
Definition of views_handler_field_boolean.

Class

views_handler_field_boolean
A handler to provide proper displays for booleans.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['type'] = array(
    'default' => 'yes-no',
  );
  $options['type_custom_true'] = array(
    'default' => '',
    'translatable' => TRUE,
  );
  $options['type_custom_false'] = array(
    'default' => '',
    'translatable' => TRUE,
  );
  $options['not'] = array(
    'definition bool' => 'reverse',
  );
  return $options;
}