API Documentation
Back to top  

SliderInterface

Extends

Interface SliderInterface

category

System
package

Slider
subpackage

Interfaces

Methods

Adds a slide to the slide collection

addSlide(\SlideInterface $slide) : \SliderInterface
Throws
\InvalidArgumentException

Arguments

$slide

\SlideInterface

Response

\SliderInterface

Same instance for chained method calls.

Return the ID of the slider.

getId() : integer

Response

integer

Slider ID.

Return the Name of the slider.

getName() : string

Response

string

Name.

Return the slide collection of the slider.

getSlideCollection() : \SlideCollection

Response

\SlideCollection

Slide collection.

Return the speed of the slider.

getSpeed() : double

Response

double

Speed.

Set the ID for the slider.

setId(\IdType $sliderId) : \SliderInterface

Arguments

$sliderId

\IdType

Slider ID.

Response

\SliderInterface

Same Instance for chained method calls.

Set the name for the slider.

setName(\StringType $name) : \SliderInterface

Arguments

$name

\StringType

Name for the slider.

Response

\SliderInterface

Same instance for chained method calls.

Show or hides a slider on the start page.

setShowOnStartPage(\BoolType $status) : \SliderInterface

Arguments

$status

\BoolType

True when it should be displayed, false otherwise.

Response

\SliderInterface

Same instance for chained method calls.

Set the slide collection for the slider.

setSlideCollection(\SlideCollection $slideCollection) : \SliderInterface

Arguments

$slideCollection

\SlideCollection

Response

\SliderInterface

Same instance for chained method calls.

Set the speed for the slider.

setSpeed(\DecimalType $speed) : \SliderInterface

Arguments

$speed

\DecimalType

The speed in seconds for the slider.

Response

\SliderInterface

Same instance for chained method calls.

Return true when the slider is displayed on the start page, false otherwise.

showOnStartPage() : boolean

Response

boolean