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
<?php
/* --------------------------------------------------------------
SliderInterface.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]
--------------------------------------------------------------
*/
/**
* Interface SliderInterface
*
* @category System
* @package Slider
* @subpackage Interfaces
*/
interface SliderInterface
{
/**
* Set the ID for the slider.
*
* @param IdType $sliderId Slider ID.
*
* @return SliderInterface Same Instance for chained method calls.
*/
public function setId(IdType $sliderId);
/**
* Return the ID of the slider.
*
* @return int Slider ID.
*/
public function getId();
/**
* 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);
/**
* Return the Name of the slider.
*
* @return string Name.
*/
public function getName();
/**
* 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);
/**
* Return the speed of the slider.
*
* @return double Speed.
*/
public function getSpeed();
/**
* Return true when the slider is displayed on the start page, false otherwise.
*
* @return bool
*/
public function showOnStartPage();
/**
* 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);
/**
* Set the slide collection for the slider.
*
* @param SlideCollection $slideCollection
*
* @return SliderInterface Same instance for chained method calls.
*/
public function setSlideCollection(SlideCollection $slideCollection);
/**
* Return the slide collection of the slider.
*
* @return SlideCollection Slide collection.
*/
public function getSlideCollection();
/**
* 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);
}