function views_handler_filter::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_filter.inc, line 105

@todo.

Class

views_handler_filter

Base class for filters.

Code

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

  $options['operator'] = array('default' => '=');
  $options['value'] = array('default' => '');
  $options['group'] = array('default' => '1');
  $options['exposed'] = array('default' => FALSE, 'bool' => TRUE);
  $options['expose'] = array(
    'contains' => array(
      'operator_id' => array('default' => FALSE),
      'label' => array('default' => '', 'translatable' => TRUE),
      'description' => array('default' => '', 'translatable' => TRUE),
      'use_operator' => array('default' => FALSE, 'bool' => TRUE),
      'operator' => array('default' => ''),
      'identifier' => array('default' => ''),
      'required' => array('default' => FALSE, 'bool' => TRUE),
      'remember' => array('default' => FALSE, 'bool' => TRUE),
      'multiple' => array('default' => FALSE, 'bool' => TRUE),
      'remember_roles' => array('default' => array(
        BACKDROP_AUTHENTICATED_ROLE => BACKDROP_AUTHENTICATED_ROLE,
      )),
    ),
  );

  // A group is a combination of a filter, an operator and a value
  // operating like a single filter.
  // Users can choose from a select box which group they want to apply.
  // Views will filter the view according to the defined values.
  // Because it acts as a standard filter, we have to define
  // an identifier and other settings like the widget and the label.
  // This settings are saved in another array to allow users to switch
  // between a normal filter and a group of filters with a single click.
  $options['is_grouped'] = array('default' => FALSE, 'bool' => TRUE);
  $options['group_info'] = array(
    'contains' => array(
      'label' => array('default' => '', 'translatable' => TRUE),
      'description' => array('default' => '', 'translatable' => TRUE),
      'identifier' => array('default' => ''),
      'optional' => array('default' => TRUE, 'bool' => TRUE),
      'widget' => array('default' => 'select'),
      'multiple' => array('default' => FALSE, 'bool' => TRUE),
      'remember' => array('default' => 0),
      'default_group' => array('default' => 'All'),
      'default_group_multiple' => array('default' => array()),
      'group_items' => array('default' => array()),
    ),
  );

  return $options;
}