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

All Classes | Properties | Methods | Events

Inheritance	humhub\modules\ui\filter\widgets\FilterBlock » humhub\components\Widget » yii\base\Widget
Available since version	1.3

Widget for rendering stream filter blocks.

Stream filter blocks are used to categorize filters.

Public Properties

Property	Type	Description	Defined 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
$widgetLayout	string	Defines an optional layout	humhub\components\Widget

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

Event	Type	Description	Defined By
EVENT_CREATE	humhub\libs\WidgetCreateEvent	An event raised before creating a widget.	humhub\components\Widget

$filters public property

Of active filter definitions

public array $filters = []

$options public property

Html options for container

public array $options = []

$sortOrder public property

Sort order

$title public property

Block title

public string $title = null

$view public property

View to render

public string $view = 'filterListBlock'

addFilter() public method

public void addFilter ( $filter )
$filter

run() public method

public void run ( )