1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
<?php
/* --------------------------------------------------------------
Slider.inc.php 2016-08-12
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Class Slider
*
* Represents the default settings of a slider. Has got the slide settings as collection for every
* slide of a slider.
*
* @category System
* @package Slider
* @subpackage Entities
*/
class Slider implements SliderInterface
{
/**
* Slider ID
*
* @var int
*/
protected $id = 0;
/**
* Slider Name
*
* @var string
*/
protected $name = '';
/**
* Animation speed of the slider
*
* @var double
*/
protected $speed = 3;
/**
* Is it shown on start page?
*
* @var bool
*/
protected $startPage = false;
/**
* Collection of slides
*
* @var SlideCollection
*/
protected $slideCollection;
public function __construct()
{
// Set SlideCollection items.
$slideCollection = MainFactory::create('SlideCollection', []);
$this->setSlideCollection($slideCollection);
}
/**
* Set the ID for the slider.
*
* @param IdType $id Slider ID.
*
* @return SliderInterface Same instance for chained method calls.
*/
public function setId(IdType $id)
{
$this->id = $id->asInt();
return $this;
}
/**
* Return the ID of the slider.
*
* @return int Slider ID.
*/
public function getId()
{
return $this->id;
}
/**
* Set the name for the slider.
*
* @param StringType $name Name for the slider.
*
* @return SliderInterface Same instance for chained method calls.
*/
public function setName(StringType $name)
{
$this->name = $name->asString();
return $this;
}
/**
* Return the Name of the slider.
*
* @return string Name.
*/
public function getName()
{
return $this->name;
}
/**
* Set the speed for the slider.
*
* @param DecimalType $speed The speed in seconds for the slider.
*
* @return SliderInterface Same instance for chained method calls.
*/
public function setSpeed(DecimalType $speed)
{
$this->speed = $speed->asDecimal();
return $this;
}
/**
* Return the speed of the slider.
*
* @return double Speed.
*/
public function getSpeed()
{
return $this->speed;
}
/**
* Return true when the slider is displayed on the start page, false otherwise.
*
* @return bool
*/
public function showOnStartPage()
{
return $this->startPage;
}
/**
* Show or hides a slider on the start page.
*
* @param BoolType $status True when it should be displayed, false otherwise.
*
* @return SliderInterface Same instance for chained method calls.
*/
public function setShowOnStartPage(BoolType $status)
{
$this->startPage = $status->asBool();
return $this;
}
/**
* Set the slide collection for the slider.
*
* @param SlideCollection $slideCollection
*
* @return SliderInterface Same instance for chained method calls.
*/
public function setSlideCollection(SlideCollection $slideCollection)
{
$this->slideCollection = $slideCollection;
return $this;
}
/**
* Return the slide collection of the slider.
*
* @return SlideCollection Slide collection.
*/
public function getSlideCollection()
{
return $this->slideCollection;
}
/**
* Adds a slide to the slide collection
*
* @param SlideInterface $slide
*
* @throws InvalidArgumentException
*
* @return SliderInterface Same instance for chained method calls.
*/
public function addSlide(SlideInterface $slide)
{
$this->slideCollection->addItem($slide);
return $this;
}
}