Class humhub\modules\user\widgets\UserPickerField

Inheritancehumhub\modules\user\widgets\UserPickerField » humhub\modules\ui\form\widgets\BasePicker » humhub\modules\ui\form\widgets\JsInputWidget » humhub\widgets\JsWidget » humhub\components\Widget » yii\base\Widget
Available since version1.2

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\user\widgets\UserPickerField
$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 boolean humhub\modules\ui\form\widgets\BasePicker
$itemClass string humhub\modules\ui\form\widgets\BasePicker
$itemKey string humhub\modules\user\widgets\UserPickerField
$jsWidget string humhub\modules\user\widgets\UserPickerField
$maxInput integer humhub\modules\ui\form\widgets\BasePicker
$maxSelection integer humhub\modules\ui\form\widgets\BasePicker
$minInput integer humhub\modules\ui\form\widgets\BasePicker
$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
getUrl() Returns the url for this picker instance. If no $url is set we use the $defaultRoute for creating the url. humhub\modules\user\widgets\UserPickerField
init() humhub\modules\user\widgets\UserPickerField
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() humhub\modules\ui\form\widgets\BasePicker
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
buildItemOption() Responsible for building the option data for an item. humhub\modules\ui\form\widgets\BasePicker
getAttributes() humhub\modules\ui\form\widgets\BasePicker
getData() Returns an array of data attributes for this picker isntance. humhub\modules\user\widgets\UserPickerField
getDefaultResultData() humhub\modules\ui\form\widgets\BasePicker
getItemImage() Used to retrieve the option image url of a given $item. humhub\modules\user\widgets\UserPickerField
getItemKey() Returns the item key which is used as option value. By default we use the $itemKey attribibute of $item. humhub\modules\ui\form\widgets\BasePicker
getItemText() Used to retrieve the option text of a given $item. humhub\modules\user\widgets\UserPickerField
getOptions() Assembles all widget attributes and data settings of this widget. humhub\widgets\JsWidget
getSelectedOptions() Prepares the selected options either by using the $selection array or by loading the items by means of the model attribute value. humhub\modules\ui\form\widgets\BasePicker
getValue() humhub\modules\ui\form\widgets\JsInputWidget
hasModel() humhub\modules\ui\form\widgets\JsInputWidget


Hide inherited events

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

Property Details

$defaultRoute public property
public string $defaultRoute '/user/search/json'
$itemKey public property

The 'guid' value is default for UserPickerField

public string $itemKey 'guid'
$jsWidget public property
public string $jsWidget 'user.picker.UserPicker'

Method Details

getData() protected method

Returns an array of data attributes for this picker isntance.

Following data attributes can be configured by default:

  • data-placeholder: Placeholder text if no value is set.
  • data-placeholder-more: Placeholder text displayed if at least one item is set.
  • data-maximum-selected: Info message displayed if $maxSelection is exceed.
  • data-no-result: Empty result message.
  • data-format-ajax-error: Ajax error message.
  • data-load-more: Load more items text.
  • data-input-too-short: Info message displayed if $minInput characters is not exceed.
  • data-input-too-long: Info message displayed if $maxInput characters is exceed.
protected array 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.

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

getUrl() public method

Returns the url for this picker instance. If no $url is set we use the $defaultRoute for creating the url.

public string getUrl ( )
init() public method

public void init ( )