Class lispa\amos\core\forms\AmosCarouselWidget

All Classes | Properties | Methods | Events

Inheritance	lispa\amos\core\forms\AmosCarouselWidget » yii\base\Widget » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Subclasses	lispa\amos\discussioni\widgets\DiscussionsCarouselWidget, lispa\amos\news\widgets\NewsCarouselWidget

Class AmosCarouselWidget

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$additionalCarouselClass	string		lispa\amos\core\forms\AmosCarouselWidget
$additionalOptions	array		lispa\amos\core\forms\AmosCarouselWidget
$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
$carouselId	string		lispa\amos\core\forms\AmosCarouselWidget
$controls	array		lispa\amos\core\forms\AmosCarouselWidget
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$id	string	ID of the widget.	yii\base\Widget
$items	array		lispa\amos\core\forms\AmosCarouselWidget
$showControls	boolean		lispa\amos\core\forms\AmosCarouselWidget
$showIndicators	boolean		lispa\amos\core\forms\AmosCarouselWidget
$singleItemView	string	The view for a single carousel item.	lispa\amos\core\forms\AmosCarouselWidget
$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

Hide inherited 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
getContentDateArray()	This static method returns the content model date array.	lispa\amos\core\forms\AmosCarouselWidget
getContentImageAlt()	This static method returns the content model image alt.	lispa\amos\core\forms\AmosCarouselWidget
getContentImageUrl()	This static method returns the content model image url.	lispa\amos\core\forms\AmosCarouselWidget
getContentReadAllLinkTitle()	This static method returns the content model read all link title.	lispa\amos\core\forms\AmosCarouselWidget
getContentShortDescription()	This static method returns the content model short description.	lispa\amos\core\forms\AmosCarouselWidget
getContentTitle()	This static method returns the content model title.	lispa\amos\core\forms\AmosCarouselWidget
getContentViewUrl()	This static method returns the content model view url.	lispa\amos\core\forms\AmosCarouselWidget
getId()	Returns the ID of the widget.	yii\base\Widget
getItems()		lispa\amos\core\forms\AmosCarouselWidget
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\AmosCarouselWidget
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\AmosCarouselWidget
setId()	Sets the ID of the widget.	yii\base\Widget
setItems()		lispa\amos\core\forms\AmosCarouselWidget
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

Hide inherited methods

Method	Description	Defined By
composeCarouselItems()	This method take the models present in the widget variable "items" and transform these models in carousel items.	lispa\amos\core\forms\AmosCarouselWidget
composeCarouselOptions()	This method make the carousel options.	lispa\amos\core\forms\AmosCarouselWidget

Events

Hide inherited 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

$additionalCarouselClass public property

public string $additionalCarouselClass = ''

$additionalOptions public property

public array $additionalOptions = []

$carouselId public property

public string $carouselId = 'carouselWidget'

$controls public property

public array $controls = []

$items public property

public array getItems ( )
public void setItems ( $items )

$showControls public property

public boolean $showControls = true

$showIndicators public property

public boolean $showIndicators = true

$singleItemView public property

The view for a single carousel item.

public string $singleItemView = "@vendor/lispa/amos-core/forms/views/widgets/amos_carousel_widget_item"

Method Details

composeCarouselItems() protected method

This method take the models present in the widget variable "items" and transform these models in carousel items.

protected boolean composeCarouselItems ( )

composeCarouselOptions() protected method

This method make the carousel options.

protected array composeCarouselOptions ( )

getContentDateArray() public static method

This static method returns the content model date array.

public static array getContentDateArray ( $model )
$model	lispa\amos\core\record\Record
throws	yii\base\InvalidConfigException

getContentImageAlt() public static method

This static method returns the content model image alt.

public static string getContentImageAlt ( $model )
$model	lispa\amos\core\record\Record

getContentImageUrl() public static method

This static method returns the content model image url.

public static string getContentImageUrl ( $model )
$model	lispa\amos\core\record\Record

getContentReadAllLinkTitle() public static method

This static method returns the content model read all link title.

public static string getContentReadAllLinkTitle ( $model )
$model	lispa\amos\core\record\Record

getContentShortDescription() public static method

This static method returns the content model short description.

public static string getContentShortDescription ( $model )
$model	lispa\amos\core\record\Record

getContentTitle() public static method

This static method returns the content model title.

public static string getContentTitle ( $model )
$model	lispa\amos\core\record\Record

getContentViewUrl() public static method

This static method returns the content model view url.

public static string getContentViewUrl ( $model )
$model	lispa\amos\core\record\Record

getItems() public method

public array getItems ( )

init() public method

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

run() public method

Executes the widget.

public string run ( )
return	string	The result of widget execution to be outputted.

setItems() public method

public void setItems ( $items )
$items	array
throws	lispa\amos\core\exceptions\AmosException