Class humhub\modules\ui\filter\widgets\CheckboxListFilterInput

Inheritancehumhub\modules\ui\filter\widgets\CheckboxListFilterInput » humhub\modules\ui\filter\widgets\CheckboxFilterInput » humhub\modules\ui\filter\widgets\FilterInput » humhub\components\Widget » yii\base\Widget

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
$checked humhub\modules\ui\filter\widgets\CheckboxFilterInput
$clickAction string Data-action-click handler of the input event humhub\modules\ui\filter\widgets\CheckboxListFilterInput
$filterClass string Css class used for this filter humhub\modules\ui\filter\widgets\FilterInput
$iconActive humhub\modules\ui\filter\widgets\CheckboxFilterInput
$iconInActive humhub\modules\ui\filter\widgets\CheckboxFilterInput
$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\CheckboxListFilterInput
$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\CheckboxListFilterInput
$value mixed Input value humhub\modules\ui\filter\widgets\FilterInput
$view string View to render the input humhub\modules\ui\filter\widgets\CheckboxListFilterInput
$widgetLayout string Defines an optional layout humhub\components\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getLayoutViewParams() Returns an array of view parameter used if \humhub\components\layout is set. humhub\components\Widget
prepareOptions() humhub\modules\ui\filter\widgets\CheckboxListFilterInput
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

$clickAction public property

Data-action-click handler of the input event

public string $clickAction 'toggleFilter'
$multiple public property

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

public boolean $multiple true
$type public property

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

public string $type 'checkbox'
$view public property

View to render the input

public string $view 'checkboxInput'

Method Details

prepareOptions() public method

public void prepareOptions ( )