function views_handler_filter::option_definition

Overrides views_handler::option_definition

File

handlers/views_handler_filter.inc, line 124

Class

views_handler_filter

Base class for filters.

Code

public 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_label' => array(
                'default' => '',
                'translatable' => TRUE,
            ),
            'operator' => array(
                'default' => '',
            ),
            'limit_operators' => array(
                'default' => FALSE,
                'bool' => TRUE,
            ),
            'available_operators' => array(
                'default' => array(),
            ),
            '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(
                    DRUPAL_AUTHENTICATED_RID => DRUPAL_AUTHENTICATED_RID,
                ),
            ),
        ),
    );
    // 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;
}