Class humhub\modules\ui\filter\widgets\FilterInput

Inheritancehumhub\modules\ui\filter\widgets\FilterInput » humhub\components\Widget » yii\base\Widget
Subclasseshumhub\modules\ui\filter\widgets\CheckboxFilterInput, humhub\modules\ui\filter\widgets\CheckboxListFilterInput, humhub\modules\ui\filter\widgets\PickerFilterInput, humhub\modules\ui\filter\widgets\RadioFilterInput, humhub\modules\ui\filter\widgets\TextFilterInput
Available since version1.3

Widget for rendering a single filter.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$category string Defines the filter category, which is used as the key for filter requests as data e.g. {filters = [filter_id_x, filter_id_y]} humhub\modules\ui\filter\widgets\FilterInput
$filterClass string Css class used for this filter humhub\modules\ui\filter\widgets\FilterInput
$id string Filter id humhub\modules\ui\filter\widgets\FilterInput
$multiple boolean Defines if the filter category can consist of multiple filter values from different filter inputs humhub\modules\ui\filter\widgets\FilterInput
$options array Input options humhub\modules\ui\filter\widgets\FilterInput
$render boolean If set to false this widget won't be rendered humhub\components\Widget
$sortOrder integer Sort order definition humhub\modules\ui\filter\widgets\FilterInput
$title string Filter title humhub\modules\ui\filter\widgets\FilterInput
$type string Sets an identifier for this input type and is added as data-filter-type humhub\modules\ui\filter\widgets\FilterInput
$value mixed Input value humhub\modules\ui\filter\widgets\FilterInput
$view string View to render the input humhub\modules\ui\filter\widgets\FilterInput

Public Methods

Hide inherited methods

MethodDescriptionDefined By
process() Process is a wrapper for the run method humhub\components\Widget
run() humhub\modules\ui\filter\widgets\FilterInput
widget() Creates a widget instance and runs it. humhub\components\Widget

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_CREATE humhub\libs\WidgetCreateEvent An event raised before creating a widget. humhub\components\Widget

Property Details

$category public property

Defines the filter category, which is used as the key for filter requests as data e.g. {filters = [filter_id_x, filter_id_y]}

public string $category 'filters'
$filterClass public property

Css class used for this filter

public string $filterClass 'filterInput'
$id public property

Filter id

public string $id null
$multiple public property

Defines if the filter category can consist of multiple filter values from different filter inputs

public boolean $multiple false
$options public property

Input options

public array $options = []
$sortOrder public property

Sort order definition

public integer $sortOrder null
$title public property

Filter title

public string $title null
$type public property

Sets an identifier for this input type and is added as data-filter-type

public string $type null
$value public property

Input value

public mixed $value null
$view public property

View to render the input

public string $view null

Method Details

getWidgetOptions() protected method

protected void getWidgetOptions ( )
prepareOptions() protected method

protected void prepareOptions ( )
run() public method

public void run ( )