function views_handler_area_text::option_definition

3.x views_handler_area_text.inc views_handler_area_text::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_area::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

1 call to views_handler_area_text::option_definition()
views_handler_area_text_custom::option_definition in handlers/views_handler_area_text_custom.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
1 method overrides views_handler_area_text::option_definition()
views_handler_area_text_custom::option_definition in handlers/views_handler_area_text_custom.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

File

handlers/views_handler_area_text.inc, line 15
Definition of views_handler_area_text.

Class

views_handler_area_text
Views area text handler.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['content'] = array('default' => '', 'translatable' => TRUE, 'format_key' => 'format');
  $options['format'] = array('default' => NULL);
  $options['tokenize'] = array('default' => FALSE, 'bool' => TRUE);
  return $options;
}