Configuration

public function getForm() : array

Returns the configuration fields of the filter.

Description

This method is used to define the list of fields used by the configuration of the filter.

The array to return should look like the following JSON representation.

{
    "param_1": {
        "type": "text",
        "value": "abc",
        "label": "Text Field"
    },
    "param_2": {
        "type": "select",
        "value": "one",
        "label": "Dropdown",
        "options": {
            "one": "One",
            "two": "Two",
            "three": "Three"
        }
    }
}

 Further details about all the supported fields can be found HERE.

 Return Value

Array. An associative array containing the configuration form of the conditional text filter.

Example

The example below explains how to support a dropdown to select multiple room tables.

/**
 * @inheritDoc
 */
public function getForm()
{
    return [
        'tables' => [
            'type'  => 'groupedlist',
            'label' => 'Tables',
            'value' => $this->options->get('tables', []),
            'multiple' => true,
            'options' => JHtml::_('vrehtml.admin.tables'),
        ],
    ];
}