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

Same name and namespace in other branches

6.3 handlers/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

File

handlers/views_handler_area.inc, line 47: Definition of views_handler_area and views_handler_area_broken.

Class

views_handler_area: Base class for area handlers.

Code

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

You are here

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

Return value

See also

File

Class

Code

API Navigation