Class humhub\modules\file\widgets\FileHandlerButtonDropdown

Inheritancehumhub\modules\file\widgets\FileHandlerButtonDropdown » humhub\components\Widget » yii\base\Widget
Available since version1.2

FileHandlerButtonWidget shows a dropdown with different file handlers

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$cssButtonClass string The default css bootstrap button class humhub\modules\file\widgets\FileHandlerButtonDropdown
$handlers humhub\modules\file\handler\BaseFileHandler[] The handlers to show humhub\modules\file\widgets\FileHandlerButtonDropdown
$primaryButton string The primary button html code, if not set the first handler will be used humhub\modules\file\widgets\FileHandlerButtonDropdown
$pullRight boolean If true the dropdown-menu will be assigned with an dropdown-menu-right class. humhub\modules\file\widgets\FileHandlerButtonDropdown
$render boolean If set to false this widget won't be rendered humhub\components\Widget
$widgetLayout string Defines an optional layout humhub\components\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
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\file\widgets\FileHandlerButtonDropdown
widget() Creates a widget instance and runs it. humhub\components\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
renderLink() Renders the file handle link humhub\modules\file\widgets\FileHandlerButtonDropdown

Events

Hide inherited events

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

Property Details

$cssButtonClass public property

The default css bootstrap button class

public string $cssButtonClass 'btn-success'
$handlers public property

The handlers to show

$primaryButton public property

The primary button html code, if not set the first handler will be used

public string $primaryButton null
$pullRight public property

If true the dropdown-menu will be assigned with an dropdown-menu-right class.

public boolean $pullRight false

Method Details

renderLink() protected method

Renders the file handle link

protected string renderLink ( $options )
$options array

The HTML options

return string

The rendered HTML tag

run() public method

public void run ( )