function views_handler_area::option_definition
3.x views_handler_area.inc | views_handler_area::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::option_definition
See also
views_object::export_option_always()
views_object::unpack_translatable()
3 calls to views_handler_area::option_definition()
- views_handler_area_result::option_definition in handlers/
views_handler_area_result.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_area_text::option_definition in handlers/
views_handler_area_text.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_area_view::option_definition in handlers/
views_handler_area_view.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
3 methods override views_handler_area::option_definition()
- views_handler_area_result::option_definition in handlers/
views_handler_area_result.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_area_text::option_definition in handlers/
views_handler_area_text.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_area_view::option_definition in handlers/
views_handler_area_view.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
File
- handlers/
views_handler_area.inc, line 45 - Views area handlers.
Class
- views_handler_area
- Base class for area handlers.
Code
function option_definition() {
$options = parent::option_definition();
$this->definition['field'] = !empty($this->definition['field']) ? $this->definition['field'] : '';
$label = !empty($this->definition['label']) ? $this->definition['label'] : $this->definition['field'];
$options['label'] = array('default' => $label, 'translatable' => TRUE);
$options['empty'] = array('default' => FALSE, 'bool' => TRUE);
return $options;
}