Class Slider

Represents the default settings of a slider. Has got the slide settings as collection for every slide of a slider.

Slider implements SliderInterface

Package: Slider\Entities
Category: System
Located at Services/Core/Slider/Entities/Slider.inc.php

Methods summary

`public`	# `__construct( )`
`public SliderInterface`	# `setId( IdType $id )` Set the ID for the slider. Set the ID for the slider. Parameters `$id` Slider ID. Returns `SliderInterface` Same instance for chained method calls. Implementation of `SliderInterface::setId()`
`public integer`	# `getId( )` Return the ID of the slider. Return the ID of the slider. Returns integer Slider ID. Implementation of `SliderInterface::getId()`
`public SliderInterface`	# `setName( StringType $name )` Set the name for the slider. Set the name for the slider. Parameters `$name` Name for the slider. Returns `SliderInterface` Same instance for chained method calls. Implementation of `SliderInterface::setName()`
`public string`	# `getName( )` Return the Name of the slider. Return the Name of the slider. Returns string Name. Implementation of `SliderInterface::getName()`
`public SliderInterface`	# `setSpeed( DecimalType $speed )` Set the speed for the slider. Set the speed for the slider. Parameters `$speed` The speed in seconds for the slider. Returns `SliderInterface` Same instance for chained method calls. Implementation of `SliderInterface::setSpeed()`
`public float`	# `getSpeed( )` Return the speed of the slider. Return the speed of the slider. Returns float Speed. Implementation of `SliderInterface::getSpeed()`
`public boolean`	# `showOnStartPage( )` Return true when the slider is displayed on the start page, false otherwise. Return true when the slider is displayed on the start page, false otherwise. Returns boolean Implementation of `SliderInterface::showOnStartPage()`
`public SliderInterface`	# `setShowOnStartPage( BoolType $status )` Show or hides a slider on the start page. Show or hides a slider on the start page. Parameters `$status` True when it should be displayed, false otherwise. Returns `SliderInterface` Same instance for chained method calls. Implementation of `SliderInterface::setShowOnStartPage()`
`public SliderInterface`	# `setSlideCollection( SlideCollection $slideCollection )` Set the slide collection for the slider. Set the slide collection for the slider. Parameters `$slideCollection` Returns `SliderInterface` Same instance for chained method calls. Implementation of `SliderInterface::setSlideCollection()`
`public SlideCollection`	# `getSlideCollection( )` Return the slide collection of the slider. Return the slide collection of the slider. Returns `SlideCollection` Slide collection. Implementation of `SliderInterface::getSlideCollection()`
`public SliderInterface`	# `addSlide( SlideInterface $slide )` Adds a slide to the slide collection Adds a slide to the slide collection Parameters `$slide` Returns `SliderInterface` Same instance for chained method calls. Throws InvalidArgumentException Implementation of `SliderInterface::addSlide()`

Properties summary

`protected integer`	`$id` Slider ID Slider ID	# `0`
`protected string`	`$name` Slider Name Slider Name	# `''`
`protected float`	`$speed` Animation speed of the slider Animation speed of the slider	# `3`
`protected boolean`	`$startPage` Is it shown on start page? Is it shown on start page?	# `false`
`protected SlideCollection`	`$slideCollection` Collection of slides Collection of slides	#

Packages

Classes

Class Slider

Methods summary

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Properties summary