SliderInterface
in
Interface SliderInterface
Tags
Table of Contents
- 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.
Methods
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 $sliderId) : SliderInterface
Parameters
- $sliderId : 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