Class humhub\widgets\LayoutAddons
| Inheritance | humhub\widgets\LayoutAddons » humhub\widgets\BaseStack » humhub\components\Widget » yii\base\Widget |
|---|---|
| Available since version | 1.1 |
LayoutAddons are inserted at the end of all layouts (standard or login).
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $render | boolean | If set to false this widget won't be rendered | humhub\components\Widget |
| $seperator | string | humhub\widgets\BaseStack | |
| $template | string | humhub\widgets\BaseStack | |
| $widgetLayout | string | Defines an optional layout | humhub\components\Widget |
| $widgets | array | humhub\widgets\BaseStack |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| addWidget() | Adds a new widget | humhub\widgets\BaseStack |
| getLayoutViewParams() | Returns an array of view parameter used if \humhub\components\layout is set. | humhub\components\Widget |
| init() | Initializes the sidebar widget. | humhub\widgets\LayoutAddons |
| process() | Process is a wrapper for the run method | humhub\components\Widget |
| removeWidget() | Removes a widget from the stack | humhub\widgets\BaseStack |
| run() | Runs the Navigation | humhub\widgets\BaseStack |
| widget() | Creates a widget instance and runs it. | humhub\components\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| getWidgets() | Returns all widgets by sortorder | humhub\widgets\BaseStack |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_CREATE | humhub\libs\WidgetCreateEvent | An event raised before creating a widget. | humhub\components\Widget |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| EVENT_INIT | 'init' | humhub\widgets\BaseStack | |
| EVENT_RUN | 'run' | humhub\widgets\BaseStack |