Class lispa\amos\favorites\widgets\FavoriteWidget
| Inheritance | lispa\amos\favorites\widgets\FavoriteWidget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
Class FavoriteWidget
Widget to show the favorite icon.
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 |
| $containerId | string | lispa\amos\favorites\widgets\FavoriteWidget | |
| $containerOptions | array | Default to ['id' => 'favorite-container-MODEL_ID'] | lispa\amos\favorites\widgets\FavoriteWidget |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string | ID of the widget. | yii\base\Widget |
| $layout | lispa\amos\favorites\widgets\FavoriteWidget | ||
| $model | lispa\amos\core\record\Record | lispa\amos\favorites\widgets\FavoriteWidget | |
| $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\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 |
| favoriteBtnTitle() | Return the favorite button title. | lispa\amos\favorites\widgets\FavoriteWidget |
| favoriteButton() | Method that render the section of the comment container. | lispa\amos\favorites\widgets\FavoriteWidget |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getContainerId() | Return the container id. | lispa\amos\favorites\widgets\FavoriteWidget |
| getId() | Returns the ID of the widget. | yii\base\Widget |
| getLayout() | lispa\amos\favorites\widgets\FavoriteWidget | |
| 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\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | lispa\amos\favorites\widgets\FavoriteWidget | |
| 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 |
| renderSection() | Renders a section of the specified name. | lispa\amos\favorites\widgets\FavoriteWidget |
| run() | Executes the widget. | lispa\amos\favorites\widgets\FavoriteWidget |
| 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 |
|---|---|---|
| renderBeginContainerSection() | This method render the beginning part of the container. | lispa\amos\favorites\widgets\FavoriteWidget |
| renderEndContainerSection() | This method render the end part of the container. | lispa\amos\favorites\widgets\FavoriteWidget |
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
Default to ['id' => 'favorite-container-MODEL_ID']
Method Details
Return the favorite button title.
| public static string favoriteBtnTitle ( $isAlreadyFavorite = false ) | ||
| $isAlreadyFavorite | ||
Method that render the section of the comment container.
| public string favoriteButton ( ) |
Return the container id.
| public string getContainerId ( ) |
| public string getLayout ( ) |
| public void init ( ) | ||
| throws | lispa\amos\favorites\exceptions\FavoritesException | |
|---|---|---|
This method render the beginning part of the container.
| protected string renderBeginContainerSection ( ) |
This method render the end part of the container.
| protected string renderEndContainerSection ( ) |
Renders a section of the specified name.
If the named section is not supported, false will be returned.
| public string|boolean renderSection ( $name ) | ||
| $name | string | The section name, e.g., |
| return | string|boolean | The rendering result of the section, or false if the named section is not supported. |
|---|---|---|
Executes the widget.
| public string run ( ) | ||
| return | string | The result of widget execution to be outputted. |
|---|---|---|