Class lispa\amos\chat\widgets\MessageWidget
Class MessageWidget
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $MESSAGE_TEMPLATE | string | lispa\amos\chat\widgets\MessageWidget | |
| $afterItem | Closure | An anonymous function that is called once AFTER rendering each data model. | yii\widgets\ListView |
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $beforeItem | Closure | An anonymous function that is called once BEFORE rendering each data model. | yii\widgets\ListView |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $clientOptions | array | lispa\amos\chat\widgets\MessageWidget | |
| $contact | array | lispa\amos\chat\widgets\MessageWidget | |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $dataProvider | yii\data\DataProviderInterface | The data provider for the view. | yii\widgets\BaseListView |
| $emptyText | string|false | The HTML content to be displayed when $dataProvider does not have any data. | yii\widgets\BaseListView |
| $emptyTextOptions | array | The HTML attributes for the emptyText of the list view. | yii\widgets\BaseListView |
| $formParams | array | lispa\amos\chat\widgets\MessageWidget | |
| $formView | lispa\amos\chat\widgets\MessageWidget | ||
| $id | string | lispa\amos\chat\widgets\MessageWidget | |
| $itemOptions | array|Closure | The HTML attributes for the container of the rendering result of each data model. | yii\widgets\ListView |
| $itemView | string|callable | The name of the view for rendering each data item, or a callback (e.g. an anonymous function) for rendering each data item. | yii\widgets\ListView |
| $layout | string | The layout that determines how different sections of the list view should be organized. | yii\widgets\BaseListView |
| $liveOptions | array | lispa\amos\chat\widgets\MessageWidget | |
| $options | array | The HTML attributes for the container tag of the list view. | yii\widgets\ListView |
| $pager | array | The configuration for the pager widget. | yii\widgets\BaseListView |
| $separator | string | The HTML code to be displayed between any two consecutive items. | yii\widgets\ListView |
| $showOnEmpty | boolean | Whether to show an empty list view if $dataProvider returns no data. | yii\widgets\BaseListView |
| $sorter | array | The configuration for the sorter widget. | yii\widgets\BaseListView |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $summary | string | The HTML content to be displayed as the summary of the list view. | yii\widgets\BaseListView |
| $summaryOptions | array | The HTML attributes for the summary of the list view. | yii\widgets\BaseListView |
| $user | array | lispa\amos\chat\widgets\MessageWidget | |
| $view | yii\web\View | The view object that can be used to render views or view files. | yii\base\Widget |
| $viewParams | array | Additional parameters to be passed to $itemView when it is being rendered. | yii\widgets\ListView |
| $viewPath | string | The view path that may be prefixed to a relative view name. | yii\base\ViewContextInterface |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | Begins a widget. | yii\base\Widget |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| end() | Ends a widget. | yii\base\Widget |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getId() | lispa\amos\chat\widgets\MessageWidget | |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | yii\base\ViewContextInterface | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the view. | lispa\amos\chat\widgets\MessageWidget |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| registerJs() | lispa\amos\chat\widgets\MessageWidget | |
| render() | Renders a view. | yii\base\Widget |
| renderEmpty() | Renders the HTML content indicating that the list view has no data. | yii\widgets\BaseListView |
| renderFile() | Renders a view file. | yii\base\Widget |
| renderForm() | lispa\amos\chat\widgets\MessageWidget | |
| renderItem() | lispa\amos\chat\widgets\MessageWidget | |
| renderItems() | lispa\amos\chat\widgets\MessageWidget | |
| renderPager() | Renders the pager. | yii\widgets\BaseListView |
| renderSection() | lispa\amos\chat\widgets\MessageWidget | |
| renderSorter() | Renders the sorter. | yii\widgets\BaseListView |
| renderSummary() | Renders the summary text. | yii\widgets\BaseListView |
| run() | Runs the widget. | lispa\amos\chat\widgets\MessageWidget |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setView() | Sets the view object to be used by this widget. | yii\base\Widget |
| trigger() | Triggers an event. | yii\base\Component |
| widget() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| renderAfterItem() | Calls $afterItem closure, returns execution result. | yii\widgets\ListView |
| renderBeforeItem() | Calls $beforeItem closure, returns execution result. | yii\widgets\ListView |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget |
Property Details
Method Details
| public string getId ( $autoGenerate = true ) | ||
| $autoGenerate | boolean | |
Initializes the view.
| public void init ( ) |
| public void registerJs ( ) |
| public mixed|string renderForm ( ) |
| public mixed|string renderItem ( $model, $key, $index ) | ||
| $model | mixed | |
| $key | mixed | |
| $index | integer | |
| public string renderItems ( ) |
| public boolean|mixed|string renderSection ( $name ) | ||
| $name | string | |
Runs the widget.
| public void run ( ) |