Class yii\bootstrap\Widget
\yii\bootstrap\Widget is the base class for all bootstrap widgets.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $clientEvents | array | The event handlers for the underlying Bootstrap JS plugin. | yii\bootstrap\Widget |
| $clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap\Widget |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string | ID of the widget. | yii\base\Widget |
| $options | array | The HTML attributes for the widget container tag. | yii\bootstrap\Widget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $view | yii\web\View | The view object that can be used to render views or view files. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Object |
| __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 an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| 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\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| 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() | Returns the ID of the widget. | yii\base\Widget |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget |
| 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\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Initializes the widget. | yii\bootstrap\Widget |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view. | yii\base\Widget |
| renderFile() | Renders a view file. | yii\base\Widget |
| run() | Executes the widget. | yii\base\Widget |
| 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 |
|---|---|---|
| registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap\Widget |
| registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap\Widget |
Property Details
The event handlers for the underlying Bootstrap JS plugin. Please refer to the corresponding Bootstrap plugin Web page for possible events. For example, this page shows how to use the "Modal" plugin and the supported events (e.g. "shown").
The options for the underlying Bootstrap JS plugin. Please refer to the corresponding Bootstrap plugin Web page for possible options. For example, this page shows how to use the "Modal" plugin and the supported options (e.g. "remote").
The HTML attributes for the widget container tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Method Details
Initializes the widget.
This method will register the bootstrap asset bundle. If you override this method, make sure you call the parent implementation first.
| void init( ) |
Registers JS event handlers that are listed in $clientEvents.
| void registerClientEvents( ) |
Registers a specific Bootstrap plugin and the related events
| void registerPlugin( $name ) | ||
| $name | string | The name of the Bootstrap plugin |