Class humhub\modules\ui\form\widgets\MultiSelect

Inheritancehumhub\modules\ui\form\widgets\MultiSelect » humhub\modules\ui\form\widgets\BasePicker » humhub\modules\ui\form\widgets\JsInputWidget » humhub\widgets\JsWidget » humhub\components\Widget » yii\base\Widget
Subclasseshumhub\modules\content\widgets\ContentTypePicker, humhub\widgets\MultiSelectField
Available since version1.3

Multiselect

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$addOptions boolean|null humhub\modules\ui\form\widgets\BasePicker
$attribute string humhub\modules\ui\form\widgets\BasePicker
$container string Html container element. humhub\widgets\JsWidget
$content string Html content. humhub\widgets\JsWidget
$defaultResults array Array of item instances used as long the minInput is not exceed. humhub\modules\ui\form\widgets\BasePicker
$defaultRoute string humhub\modules\ui\form\widgets\BasePicker
$disabledItems Disabled items humhub\modules\ui\form\widgets\BasePicker
$events [] humhub\widgets\JsWidget
$fadeIn boolean|string|integer humhub\widgets\JsWidget
$focus boolean humhub\modules\ui\form\widgets\BasePicker
$form \yii\widgets\ActiveForm humhub\modules\ui\form\widgets\BasePicker
$formName humhub\modules\ui\form\widgets\BasePicker
$id string humhub\widgets\JsWidget
$init mixed humhub\widgets\JsWidget
$itemClass string humhub\modules\ui\form\widgets\BasePicker
$itemKey string humhub\modules\ui\form\widgets\BasePicker
$items \humhub\modules\ui\form\widgets\type humhub\modules\ui\form\widgets\MultiSelect
$jsWidget string humhub\widgets\JsWidget
$maxInput integer humhub\modules\ui\form\widgets\BasePicker
$maxSelection integer humhub\modules\ui\form\widgets\BasePicker
$minInput humhub\modules\ui\form\widgets\MultiSelect
$model \yii\db\ActiveRecord humhub\modules\ui\form\widgets\BasePicker
$name string The input name. humhub\modules\ui\form\widgets\JsInputWidget
$options humhub\widgets\JsWidget
$placeholder string humhub\modules\ui\form\widgets\BasePicker
$placeholderMore string humhub\modules\ui\form\widgets\BasePicker
$render boolean If set to false this widget won't be rendered humhub\components\Widget
$selection array humhub\modules\ui\form\widgets\BasePicker
$url string humhub\modules\ui\form\widgets\BasePicker
$value string The input value. humhub\modules\ui\form\widgets\JsInputWidget
$visible boolean humhub\widgets\JsWidget
$widgetLayout string Defines an optional layout humhub\components\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
beforeRun() humhub\modules\ui\form\widgets\BasePicker
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
loadItems() Loads all items of the given $selection array. humhub\modules\ui\form\widgets\BasePicker
process() Process is a wrapper for the run method humhub\components\Widget
run() Default implementation of JsWidget. humhub\widgets\JsWidget
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

Events

Hide inherited events

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

Property Details

$items public property
public \humhub\modules\ui\form\widgets\type $items = []
$minInput public property
public $minInput 0

Method Details

getData() protected method

protected void getData ( )
getItemImage() protected method

Used to retrieve the option image url of a given $item.

protected string|null getItemImage ( $item )
$item \yii\db\ActiveRecord

Selected item

return string|null

Image url or null if no selection image required.

getItemKey() protected method

protected void getItemKey ( $item )
$item
getItemText() protected method

Used to retrieve the option text of a given $item.

protected string getItemText ( $item )
$item \yii\db\ActiveRecord

Selected item

return string

Item option text

getSelectedOptions() protected method

protected void getSelectedOptions ( )
getUrl() protected method

protected void getUrl ( )