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

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 Methods

Hide inherited methods

MethodDescriptionDefined 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

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 ( )