function FilterPluginBase::defineOptions

Overrides HandlerBase::defineOptions

File

core/modules/views/src/Plugin/views/filter/FilterPluginBase.php, line 147

Class

FilterPluginBase

Base class for Views filters handler plugins.

Namespace

Code

protected function defineOptions() {
    $options = parent::defineOptions();
    $options['operator'] = [
        'default' => '=',
    ];
    $options['value'] = [
        'default' => '',
    ];
    $options['group'] = [
        'default' => '1',
    ];
    $options['exposed'] = [
        'default' => FALSE,
    ];
    $options['expose'] = [
        'contains' => [
            'operator_id' => [
                'default' => FALSE,
            ],
            'label' => [
                'default' => '',
            ],
            'description' => [
                'default' => '',
            ],
            'use_operator' => [
                'default' => FALSE,
            ],
            'operator' => [
                'default' => '',
            ],
            'operator_limit_selection' => [
                'default' => FALSE,
            ],
            'operator_list' => [
                'default' => [],
            ],
            'identifier' => [
                'default' => '',
            ],
            'required' => [
                'default' => FALSE,
            ],
            'remember' => [
                'default' => FALSE,
            ],
            'multiple' => [
                'default' => FALSE,
            ],
            'remember_roles' => [
                'default' => [
                    RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
                ],
            ],
        ],
    ];
    // 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'] = [
        'default' => FALSE,
    ];
    $options['group_info'] = [
        'contains' => [
            'label' => [
                'default' => '',
            ],
            'description' => [
                'default' => '',
            ],
            'identifier' => [
                'default' => '',
            ],
            'optional' => [
                'default' => TRUE,
            ],
            'widget' => [
                'default' => 'select',
            ],
            'multiple' => [
                'default' => FALSE,
            ],
            'remember' => [
                'default' => 0,
            ],
            'default_group' => [
                'default' => 'All',
            ],
            'default_group_multiple' => [
                'default' => [],
            ],
            'group_items' => [
                'default' => [],
            ],
        ],
    ];
    return $options;
}