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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
<?php
/* --------------------------------------------------------------
Slide.inc.php 2016-10-31
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 Slide
*
* Represents the default settings of a single slide in a slider. Has got the slider image settings as collection for
* every image of a slide.
*
* @category System
* @package Slider
* @subpackage Entities
*/
class Slide implements SlideInterface
{
/**
* Slide ID
*
* @var int
*/
protected $id = 0;
/**
* Language ID
*
* @var int
*/
protected $languageId = 0;
/**
* Thumbnail
*
* @var string
*/
protected $thumbnail = '';
/**
* Title
*
* @var string
*/
protected $title = '';
/**
* Image alt text
*
* @var string
*/
protected $altText = '';
/**
* Link url
*
* @var string
*/
protected $url = '';
/**
* Link target (e.g. _blank or _self)
*
* @var string
*/
protected $urlTarget = '';
/**
* Collection of Slide Images
*
* @var SlideImageCollection
*/
protected $slideImageCollection;
/**
* Sort order
*
* @var int
*/
protected $sortOrder = 0;
public function __construct()
{
// Set SlideImageCollection items.
$slideImageCollection = MainFactory::create('SlideImageCollection', []);
$this->setSlideImageCollection($slideImageCollection);
}
/**
* Set the slide ID for the slide.
*
* @param IdType $id Slide ID.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setId(IdType $id)
{
$this->id = $id->asInt();
return $this;
}
/**
* Return the slide ID.
*
* @return int Slide ID.
*/
public function getId()
{
return $this->id;
}
/**
* Set the language ID for the slide.
*
* @param IdType $languageId Language ID.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setLanguageId(IdType $languageId)
{
$this->languageId = $languageId->asInt();
return $this;
}
/**
* Return the language ID.
*
* @return int Language ID.
*/
public function getLanguageId()
{
return $this->languageId;
}
/**
* Set the thumbnail for the slide.
*
* @param StringType $thumbnail Thumbnail to set.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setThumbnail(StringType $thumbnail)
{
$this->thumbnail = $thumbnail->asString();
return $this;
}
/**
* Return the thumbnail of the slide.
*
* @return string Thumbnail.
*/
public function getThumbnail()
{
return $this->thumbnail;
}
/**
* Set the title for the slide.
*
* @param StringType $title Title for the slide.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setTitle(StringType $title)
{
$this->title = $title->asString();
return $this;
}
/**
* Return the title of the slide.
*
* @return string Title.
*/
public function getTitle()
{
return $this->title;
}
/**
* Set the alt text for the slide.
*
* @param StringType $altText .
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setAltText(StringType $altText)
{
$this->altText = $altText->asString();
return $this;
}
/**
* Return the alt text of the slide.
*
* @return string Alt text of the slide.
*/
public function getAltText()
{
return $this->altText;
}
/**
* Set the URL for the slide.
*
* @param StringType $url URL.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setUrl(StringType $url)
{
$this->url = $url->asString();
return $this;
}
/**
* Return the URL of the slide.
*
* @return string URL.
*/
public function getUrl()
{
return $this->url;
}
/**
* Set the url target property for the slide.
*
* @param StringType $urlTarget URL target e.g. '_blank'.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setUrlTarget(StringType $urlTarget)
{
$validUrlTargets = ['_self', '_blank'];
if(!in_array($urlTarget->asString(), $validUrlTargets))
{
throw new InvalidArgumentException('Slide: Unsupported link target. ' . 'Supported link targets are: "'
. implode('","', $validUrlTargets) . '". ' . 'Got "'
. $urlTarget->asString() . '".');
}
$this->urlTarget = $urlTarget->asString();
return $this;
}
/**
* Return the url target property.
*
* @return string URL target e.g. '_blank'.
*/
public function getUrlTarget()
{
return $this->urlTarget;
}
/**
* Set the slide image collection for the slide.
*
* @param SlideImageCollection $slideImageCollection
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setSlideImageCollection(SlideImageCollection $slideImageCollection)
{
$this->slideImageCollection = $slideImageCollection;
return $this;
}
/**
* Return the slide image collection of the slide.
*
* @return SlideImageCollection Slide image collection.
*/
public function getSlideImageCollection()
{
return $this->slideImageCollection;
}
/**
* Adds a slide image to the slide image collection
*
* @param SlideImageInterface $slideImage
*
* @throws InvalidArgumentException
*
* @return SlideInterface Same instance for chained method calls.
*/
public function addSlideImage(SlideImageInterface $slideImage)
{
$this->slideImageCollection->addItem($slideImage);
return $this;
}
/**
* Set the sort order for the slide.
*
* @param IntType $sortOrder Slide sort order.
*
* @return SlideInterface Same instance for chained method calls.
*/
public function setSortOrder(IntType $sortOrder)
{
$this->sortOrder = $sortOrder->asInt();
return $this;
}
/**
* Return the slide sort order.
*
* @return int sort order.
*/
public function getSortOrder()
{
return $this->sortOrder;
}
}