HumHub Documentation (unofficial)

ContentTypePicker extends MultiSelect

in package

• Application

Multiselect

Table of Contents

Constants

EVENT_AFTER_RUN  = 'afterRun'

EVENT_BEFORE_RUN  = 'beforeRun'

EVENT_CREATE  = 'create'

EVENT_INIT  = 'init'

Properties

$addOptions  : bool|null

If set to true, the picker will allow adding new options not included in the current search result.

$attribute  : string

Model attribute which holds the picker value. The referenced model attribute has to be an array.

$autoIdPrefix  : string

$behaviors  : array<string|int, Behavior>

$container  : string

$content  : string

$contentContainer  : ContentContainerActiveRecord|null

$defaultIcon  : string

$defaultResults  : array<string|int, mixed>

$defaultRoute  : string

Default route used for search queries.

$disabled  : bool

Disables the picker field

$disabledItems  : array<string|int, mixed>

Disabled items

$events  : mixed

Event action handler.

$fadeIn  : bool|string|int

If set to true or 'fast', 'slow' or a integer duration in milliseconds the jsWidget will fade in the root element after initialization.

$field  : ActiveField

$focus  : bool

If set to true the picker will be focused automatically.

$form  : ActiveForm

If the ActiveForm is set, it will be used to create the picker field, otherwise it's created by Html::activeDropDownList

$formName  : mixed

$id  : string

Defines the select input field id

$id  : string|null

$init  : bool

$itemClass  : string

The item class used to load items by means of the model attribute value.

$itemKey  : string

The item key used as option value and loading items by attribute value.

$items  : type

Possible values

$jsWidget  : string

Defines the javascript picker implementation.

$maxInput  : int

Minimum character input before triggering search query.

$maxSelection  : int

Maximum amount of selection items.

$minInput  : int

Minimum character input before triggering search query.

$model  : ActiveRecord

Model instance.

$name  : string

$options  : array<string|int, mixed>

$placeholder  : string

Can be used to overwrite the default placeholder.

$placeholderMore  : string

Can be used to overwrite the default add more placeholder.

$render  : bool

$selection  : array<string|int, mixed>

Array of item instances. If this array is set the picker will ignore the actual model attribute and instead use this array as selection.

$types  : array<string|int, ContentType>

$url  : string

Search url used to overwrite the $defaultRoute for a picker isntance.

$value  : string

$view  : View

$view  : View

$viewPath  : string

$visible  : bool

Used to hide/show the actual input element.

$widgetLayout  : string

$_behaviors  : array<string|int, Behavior>|null

$_events  : array<string|int, mixed>

$_eventWildcards  : array<string|int, mixed>

$_id  : mixed

$_view  : mixed

Methods

__call()  : mixed

Calls the named method which is not a class method.

__clone()  : mixed

This method is called after the object is created by cloning an existing one.

__construct()  : mixed

Constructor.

__get()  : mixed

Returns the value of a component property.

__isset()  : bool

Checks if a property is set, i.e. defined and not null.

__set()  : mixed

Sets the value of a component property.

__unset()  : mixed

Sets a component property to be null.

afterRun()  : mixed

This method is invoked right after a widget is executed.

attachBehavior()  : Behavior

Attaches a behavior to this component.

attachBehaviors()  : mixed

Attaches a list of behaviors to the component.

beforeRun()  : bool

Initializes the widget.

begin()  : static

Begins a widget.

behaviors()  : array<string|int, mixed>

Returns a list of behaviors that this component should behave as.

canGetProperty()  : bool

Returns a value indicating whether a property can be read.

canSetProperty()  : bool

Returns a value indicating whether a property can be set.

className()  : string

Returns the fully qualified name of this class.

detachBehavior()  : Behavior|null

Detaches a behavior from the component.

detachBehaviors()  : mixed

Detaches all behaviors from the component.

end()  : static

Ends a widget.

ensureBehaviors()  : mixed

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.

getBehavior()  : Behavior|null

Returns the named behavior object.

getBehaviors()  : array<string|int, Behavior>

Returns all behaviors attached to this component.

getId()  : string

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).

getLayoutViewParams()  : array<string|int, mixed>

Returns an array of view parameter used if [[layout]] is set.

getView()  : View

Returns the view object that can be used to render views or view files.

getViewPath()  : string

Returns the directory containing the view files for this widget.

hasEventHandlers()  : bool

Returns a value indicating whether there is any handler attached to the named event.

hasMethod()  : bool

Returns a value indicating whether a method is defined.

hasProperty()  : bool

Returns a value indicating whether a property is defined for this component.

init()  : mixed

Initializes the object.

loadItems()  : array<string|int, mixed>

Loads all items of the given $selection array.

off()  : bool

Detaches an existing event handler from this component.

on()  : mixed

Attaches an event handler to an event.

process()  : mixed

Process is a wrapper for the run method

render()  : string

Renders a view.

renderFile()  : string

Renders a view file.

run()  : string

Default implementation of JsWidget.

setDefaultOptions()  : mixed

Sets some default data options required by all widgets as the widget implementation and the widget events and initialization trigger.

setId()  : mixed

Sets the ID of the widget.

setView()  : mixed

Sets the view object to be used by this widget.

trigger()  : mixed

Triggers an event.

widget()  : string

Creates a widget instance and runs it.

buildItemOption()  : array<string|int, mixed>

Responsible for building the option data for an item.

emptyResult()  : string

Should be returned by [[run]] in order to prevent rendering the field.

getAttributes()  : mixed

Returns all html attributes for used by this widget and will normally inserted in the widgets root html element.

getData()  : array<string|int, mixed>

Returns an array of data attributes for this picker isntance.

getDefaultResultData()  : mixed

getItemImage()  : string|null

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

getItemKey()  : string

Returns the item key which is used as option value. By default we use the $itemKey attribibute of $item.

getItemText()  : string

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

getOptions()  : array<string|int, mixed>

Assembles all widget attributes and data settings of this widget.

getSelectedOptions()  : array<string|int, mixed>

Prepares the selected options either by using the $selection array or by loading the items by means of the model attribute value.

getUrl()  : string

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

getValue()  : string

hasModel()  : bool

attachBehaviorInternal()  : Behavior

Attaches a behavior to this component.

foreach($values as $value) {
    if(strpos($value, '_add:') === 0) {
        $newValue = substr($value, strlen('_add:'));
        // Save new item with newValue
    } else {
        $item = MyItem::findOne((int) $value);
        // ...
    }
}

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

function ($event)

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

public function run()
{
  if(!$this->shouldRender()) {
      return $this->emptyResult();
  }

  return parent::run();
}