Class humhub\modules\notification\widgets\OverviewWidget

Inheritancehumhub\modules\notification\widgets\OverviewWidget » humhub\widgets\JsWidget » humhub\components\Widget » yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getId() Returns the html id of this widget, if no id is set this function will generate an id if $autoGenerate is set to true (default). humhub\widgets\JsWidget
getLayoutViewParams() Returns an array of view parameter used if \humhub\components\layout is set. humhub\components\Widget
getReloadUrl() humhub\modules\notification\widgets\OverviewWidget
process() Process is a wrapper for the run method humhub\components\Widget
run() Default implementation of JsWidget. humhub\modules\notification\widgets\OverviewWidget
setDefaultOptions() Sets some default data options required by all widgets as the widget implementation and the widget events and initialization trigger. humhub\widgets\JsWidget
widget() Creates a widget instance and runs it. humhub\components\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getAttributes() Returns all html attributes for used by this widget and will normally inserted in the widgets root html element. humhub\widgets\JsWidget
getData() Returns an array of data-* attributes to configure your clientside js widget. humhub\widgets\JsWidget
getOptions() Assembles all widget attributes and data settings of this widget. humhub\widgets\JsWidget


Hide inherited events

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

Property Details

$id public property
public $id 'notification_overview_list'
$init public property
public $init true
$notifications public property
public $notifications null
$pagination public property
public $pagination null

Method Details

getReloadUrl() public method

public string|array getReloadUrl ( )
return string|array

Url used to reload this widget

run() public method

Default implementation of JsWidget.

This will render a widget html element specified by $container and $content and the given $options/$event attributes. This function should be overwritten for widgets with a more complex rendering.

public string run ( )