Class humhub\components\Widget

Inheritancehumhub\components\Widget » yii\base\Widget
Subclasseshumhub\modules\activity\widgets\Activity, humhub\modules\activity\widgets\ActivityStreamViewer, humhub\modules\activity\widgets\Stream, humhub\modules\admin\widgets\DashboardApproval, humhub\modules\admin\widgets\ExportButton, humhub\modules\admin\widgets\IncompleteSetupWarning, humhub\modules\admin\widgets\TrackingWidget, humhub\modules\comment\widgets\Comment, humhub\modules\content\widgets\ContentTagDropDown, humhub\modules\content\widgets\ContentTagPicker, humhub\modules\content\widgets\ContentTypePicker, humhub\modules\content\widgets\MoveContentLink, humhub\modules\content\widgets\Stream, humhub\modules\content\widgets\WallCreateContentForm, humhub\modules\content\widgets\WallEntry, humhub\modules\content\widgets\WallEntryAddons, humhub\modules\content\widgets\WallEntryControlLink, humhub\modules\content\widgets\WallEntryControls, humhub\modules\content\widgets\WallEntryLinks, humhub\modules\content\widgets\richtext\AbstractRichText, humhub\modules\content\widgets\richtext\AbstractRichTextEditor, humhub\modules\content\widgets\richtext\HumHubRichText, humhub\modules\content\widgets\richtext\HumHubRichTextEditor, humhub\modules\content\widgets\richtext\ProsemirrorRichText, humhub\modules\content\widgets\richtext\ProsemirrorRichTextEditor, humhub\modules\content\widgets\richtext\RichText, humhub\modules\content\widgets\richtext\RichTextField, humhub\modules\dashboard\widgets\DashboardContent, humhub\modules\dashboard\widgets\Sidebar, humhub\modules\directory\widgets\GroupUsers, humhub\modules\directory\widgets\MemberActionsButton, humhub\modules\directory\widgets\Sidebar, humhub\modules\directory\widgets\SpaceTagList, humhub\modules\directory\widgets\UserGroupList, humhub\modules\directory\widgets\UserTagList, humhub\modules\file\widgets\FileDownload, humhub\modules\file\widgets\FileHandlerButtonDropdown, humhub\modules\file\widgets\FilePreview, humhub\modules\file\widgets\Upload, humhub\modules\file\widgets\UploadButton, humhub\modules\file\widgets\UploadInput, humhub\modules\file\widgets\UploadProgress, humhub\modules\notification\widgets\Overview, humhub\modules\post\widgets\CreateForm, humhub\modules\post\widgets\Form, humhub\modules\post\widgets\WallEntry, humhub\modules\space\widgets\Chooser, humhub\modules\space\widgets\HeaderControls, humhub\modules\space\widgets\HeaderCounterSet, humhub\modules\space\widgets\MembershipButton, humhub\modules\space\widgets\Sidebar, humhub\modules\space\widgets\SpaceChooserItem, humhub\modules\space\widgets\SpaceContent, humhub\modules\space\widgets\SpaceNameColorInput, humhub\modules\space\widgets\SpacePickerField, humhub\modules\stream\widgets\StreamViewer, humhub\modules\stream\widgets\WallStreamFilterNavigation, humhub\modules\topic\widgets\ContentTopicButton, humhub\modules\topic\widgets\TopicLabel, humhub\modules\topic\widgets\TopicPicker, humhub\modules\tour\widgets\Tour, humhub\modules\ui\filter\widgets\CheckboxFilterInput, humhub\modules\ui\filter\widgets\CheckboxListFilterInput, humhub\modules\ui\filter\widgets\FilterBlock, humhub\modules\ui\filter\widgets\FilterInput, humhub\modules\ui\filter\widgets\FilterNavigation, humhub\modules\ui\filter\widgets\FilterPanel, humhub\modules\ui\filter\widgets\PickerFilterInput, humhub\modules\ui\filter\widgets\RadioFilterInput, humhub\modules\ui\filter\widgets\TextFilterInput, humhub\modules\ui\form\widgets\BasePicker, humhub\modules\ui\form\widgets\ColorPicker, humhub\modules\ui\form\widgets\DurationPicker, humhub\modules\ui\form\widgets\JsInputWidget, humhub\modules\ui\form\widgets\Markdown, humhub\modules\ui\form\widgets\MarkdownModals, humhub\modules\ui\form\widgets\MultiSelect, humhub\modules\ui\widgets\CounterSet, humhub\modules\user\widgets\Image, humhub\modules\user\widgets\ProfileHeaderControls, humhub\modules\user\widgets\ProfileHeaderCounterSet, humhub\modules\user\widgets\ProfileSidebar, humhub\modules\user\widgets\StreamViewer, humhub\modules\user\widgets\UserPickerField, humhub\widgets\BasePickerField, humhub\widgets\BaseSidebar, humhub\widgets\BaseSidebarItem, humhub\widgets\BaseStack, humhub\widgets\BootstrapComponent, humhub\widgets\Button, humhub\widgets\ColorPickerField, humhub\widgets\ContentTagDropDown, humhub\widgets\DurationPicker, humhub\widgets\FadeIn, humhub\widgets\GlobalModal, humhub\widgets\InputWidget, humhub\widgets\JPlayerPlaylistWidget, humhub\widgets\JsWidget, humhub\widgets\Label, humhub\widgets\LayoutAddons, humhub\widgets\Link, humhub\widgets\MarkdownField, humhub\widgets\MarkdownFieldModals, humhub\widgets\Modal, humhub\widgets\ModalButton, humhub\widgets\ModalDialog, humhub\widgets\MultiSelectField, humhub\widgets\NotificationArea, humhub\widgets\Pjax, humhub\widgets\PoweredBy, humhub\widgets\RichText, humhub\widgets\RichTextEditor, humhub\widgets\RichtextField, humhub\widgets\TimeZoneDropdownAddition, humhub\widgets\TopMenuRightStack

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$render boolean If set to false this widget won't be rendered humhub\components\Widget

Public Methods

Hide inherited methods

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

$render public property

If set to false this widget won't be rendered

public boolean $render true

Method Details

process() public method

Process is a wrapper for the run method

public void process ( )
widget() public static method

Creates a widget instance and runs it.

The widget rendering result is returned by this method.

public static string widget ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

return string

The rendering result of the widget.

throws Exception

Event Details

EVENT_CREATE event of type humhub\libs\WidgetCreateEvent

An event raised before creating a widget.