Slider
in package
implements
SliderInterface
Class Slider
Represents the default settings of a slider. Has got the slide settings as collection for every slide of a slider.
Tags
Interfaces, Classes and Traits
- SliderInterface
- Interface SliderInterface
Table of Contents
- $id : int
- Slider ID
- $name : string
- Slider Name
- $slideCollection : SlideCollection
- Collection of slides
- $speed : float
- Animation speed of the slider
- $startPage : bool
- Is it shown on start page?
- __construct() : mixed
- addSlide() : SliderInterface
- Adds a slide to the slide collection
- getId() : int
- Return the ID of the slider.
- getName() : string
- Return the Name of the slider.
- getSlideCollection() : SlideCollection
- Return the slide collection of the slider.
- getSpeed() : float
- Return the speed of the slider.
- setId() : SliderInterface
- Set the ID for the slider.
- setName() : SliderInterface
- Set the name for the slider.
- setShowOnStartPage() : SliderInterface
- Show or hides a slider on the start page.
- setSlideCollection() : SliderInterface
- Set the slide collection for the slider.
- setSpeed() : SliderInterface
- Set the speed for the slider.
- showOnStartPage() : bool
- Return true when the slider is displayed on the start page, false otherwise.
Properties
$id
Slider ID
protected
int
$id
= 0
$name
Slider Name
protected
string
$name
= ''
$slideCollection
Collection of slides
protected
SlideCollection
$slideCollection
$speed
Animation speed of the slider
protected
float
$speed
= 3
$startPage
Is it shown on start page?
protected
bool
$startPage
= alse
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addSlide()
Adds a slide to the slide collection
public
addSlide(SlideInterface $slide) : SliderInterface
Parameters
- $slide : SlideInterface
Tags
Return values
SliderInterface —Same instance for chained method calls.
getId()
Return the ID of the slider.
public
getId() : int
Return values
int —Slider ID.
getName()
Return the Name of the slider.
public
getName() : string
Return values
string —Name.
getSlideCollection()
Return the slide collection of the slider.
public
getSlideCollection() : SlideCollection
Return values
SlideCollection —Slide collection.
getSpeed()
Return the speed of the slider.
public
getSpeed() : float
Return values
float —Speed.
setId()
Set the ID for the slider.
public
setId(IdType $id) : SliderInterface
Parameters
- $id : IdType
-
Slider ID.
Return values
SliderInterface —Same instance for chained method calls.
setName()
Set the name for the slider.
public
setName(StringType $name) : SliderInterface
Parameters
- $name : StringType
-
Name for the slider.
Return values
SliderInterface —Same instance for chained method calls.
setShowOnStartPage()
Show or hides a slider on the start page.
public
setShowOnStartPage(BoolType $status) : SliderInterface
Parameters
- $status : BoolType
-
True when it should be displayed, false otherwise.
Return values
SliderInterface —Same instance for chained method calls.
setSlideCollection()
Set the slide collection for the slider.
public
setSlideCollection(SlideCollection $slideCollection) : SliderInterface
Parameters
- $slideCollection : SlideCollection
Return values
SliderInterface —Same instance for chained method calls.
setSpeed()
Set the speed for the slider.
public
setSpeed(DecimalType $speed) : SliderInterface
Parameters
- $speed : DecimalType
-
The speed in seconds for the slider.
Return values
SliderInterface —Same instance for chained method calls.
showOnStartPage()
Return true when the slider is displayed on the start page, false otherwise.
public
showOnStartPage() : bool