Class humhub\modules\ui\filter\widgets\FilterBlock

All Classes | Properties | Methods | Events
Inheritancehumhub\modules\ui\filter\widgets\FilterBlock » humhub\components\Widget » yii\base\Widget
Available since version1.3

Widget for rendering stream filter blocks.

Stream filter blocks are used to categorize filters.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$filters array Of active filter definitions humhub\modules\ui\filter\widgets\FilterBlock
$options array Html options for container humhub\modules\ui\filter\widgets\FilterBlock
$render boolean If set to false this widget won't be rendered humhub\components\Widget
$sortOrder integer Sort order humhub\modules\ui\filter\widgets\FilterBlock
$title string Block title humhub\modules\ui\filter\widgets\FilterBlock
$view string View to render humhub\modules\ui\filter\widgets\FilterBlock

Public Methods

Hide inherited methods

MethodDescriptionDefined By
addFilter() humhub\modules\ui\filter\widgets\FilterBlock
process() Process is a wrapper for the run method humhub\components\Widget
run() humhub\modules\ui\filter\widgets\FilterBlock
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

$filters public property

Of active filter definitions

See also humhub\modules\ui\filter\widgets\FilterInput.

public array $filters = []
$options public property

Html options for container

public array $options = []
$sortOrder public property

Sort order

public integer $sortOrder = null
$title public property

Block title

public string $title = null
$view public property

View to render

public string $view = 'filterListBlock'

Method Details

addFilter() public method

public void addFilter ( $filter )
$filter
run() public method

public void run ( )