Class lispa\amos\core\forms\AmosOwlCarouselWidget
Class AmosOwlCarouselWidget
Public Properties
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $widgetView | string | The widget view. | lispa\amos\core\forms\AmosOwlCarouselWidget |
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() | Returns the ID of the widget. | yii\base\Widget |
| getItems() | lispa\amos\core\forms\AmosOwlCarouselWidget | |
| 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() | Initializes the object. | lispa\amos\core\forms\AmosOwlCarouselWidget |
| 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. | lispa\amos\core\forms\AmosOwlCarouselWidget |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setItems() | lispa\amos\core\forms\AmosOwlCarouselWidget | |
| 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 |
|---|---|---|
| composeOwlCarouselItems() | This method take the models present in the widget variable "items" and transform these models in carousel items. | lispa\amos\core\forms\AmosOwlCarouselWidget |
| composeOwlCarouselOptions() | This method make the owl carousel options. | lispa\amos\core\forms\AmosOwlCarouselWidget |
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
The view for a single owl carousel item.
The widget view.
protected string $widgetView = "@vendor/lispa/amos-core/forms/views/widgets/amos_owl_carousel_widget"
Method Details
This method take the models present in the widget variable "items" and transform these models in carousel items.
| protected boolean composeOwlCarouselItems ( ) |
This method make the owl carousel options.
| protected array composeOwlCarouselOptions ( ) |
| public array getItems ( ) |
Initializes the object.
This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event.
| public void init ( ) |
Executes the widget.
| public string run ( ) | ||
| return | string | The result of widget execution to be outputted. |
|---|---|---|
| public void setItems ( $items ) | ||
| $items | array | |
| throws | lispa\amos\core\exceptions\AmosException | |
|---|---|---|