Class humhub\modules\ui\filter\widgets\RadioFilterInput

All Classes | Properties | Methods | Events | Constants
Inheritancehumhub\modules\ui\filter\widgets\RadioFilterInput » 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\RadioFilterInput
$filterClass string Css class used for this filter humhub\modules\ui\filter\widgets\FilterInput
$force humhub\modules\ui\filter\widgets\RadioFilterInput
$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\FilterInput
$options array Input options humhub\modules\ui\filter\widgets\FilterInput
$radioGroup string Radio group humhub\modules\ui\filter\widgets\RadioFilterInput
$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
$style humhub\modules\ui\filter\widgets\RadioFilterInput
$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\RadioFilterInput
$value mixed Input value humhub\modules\ui\filter\widgets\FilterInput
$view string View to render the input humhub\modules\ui\filter\widgets\CheckboxFilterInput
$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
init() humhub\modules\ui\filter\widgets\RadioFilterInput
prepareOptions() humhub\modules\ui\filter\widgets\RadioFilterInput
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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getWidgetOptions() humhub\modules\ui\filter\widgets\CheckboxFilterInput

Events

Hide inherited events

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

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
STYLE_CHECKBOX 'checkbox' humhub\modules\ui\filter\widgets\RadioFilterInput
STYLE_CUSTOM 'custom' humhub\modules\ui\filter\widgets\RadioFilterInput
STYLE_RADIO 'radio' humhub\modules\ui\filter\widgets\RadioFilterInput

Property Details

$clickAction public property

Data-action-click handler of the input event

public string $clickAction = 'toggleFilter'
$force public property
public $force = false
$radioGroup public property

Radio group

public string $radioGroup = null
$style public property
public $style = null
$type public property

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

public string $type = 'radio'

Method Details

init() public method

public void init ( )
prepareOptions() public method

public void prepareOptions ( )