Class humhub\modules\space\widgets\Picker

Inheritancehumhub\modules\space\widgets\Picker » yii\base\Widget
Available since version0.5
Deprecated since version since version 1.2 use SpacePickerField instead

Picker displays a space picker instead of an input field.

To use this widget, you may insert the following code in a view:

echo humhub\modules\space\widgets\Picker::widget([ 'inputId' => 'space_filter', 'value' => $spaceGuidsString, 'maxSpaces' => 3 ]);

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attribute string The attribute associated with this widget. humhub\modules\space\widgets\Picker
$inputId string The id of input element which should replaced humhub\modules\space\widgets\Picker
$maxSpaces integer The maximum of spaces humhub\modules\space\widgets\Picker
$model \yii\base\Model The data model associated with this widget. humhub\modules\space\widgets\Picker
$placeholder string Placeholder message, when no space is set humhub\modules\space\widgets\Picker
$spaceSearchUrl string The search url humhub\modules\space\widgets\Picker
$value string The initial value of comma separated space guids humhub\modules\space\widgets\Picker

Public Methods

Hide inherited methods

MethodDescriptionDefined By
run() Displays / Run the Widgets humhub\modules\space\widgets\Picker

Property Details

$attribute public property

The attribute associated with this widget. (Optional)

public string $attribute null
$inputId public property

The id of input element which should replaced

public string $inputId ''
$maxSpaces public property

The maximum of spaces

public integer $maxSpaces 10
$model public property

The data model associated with this widget. (Optional)

public \yii\base\Model $model null
$placeholder public property

Placeholder message, when no space is set

public string $placeholder null
$spaceSearchUrl public property

The search url

public string $spaceSearchUrl ''
$value public property

The initial value of comma separated space guids

public string $value ''

Method Details

run() public method

Displays / Run the Widgets

public void run ( )