Maslosoft Staple API
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 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/staple
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @link http://maslosoft.com/staple/
*/
namespace Maslosoft\Staple\Widgets;
use Maslosoft\EmbeDi\EmbeDi;
use Maslosoft\MiniView\MiniView;
use Maslosoft\Staple\Widgets\Vo\CarouselItem;
/**
* Carousel
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class Carousel
{
const DefaultId = 'carousel';
/**
* Default image width and height. Should fit nicely on layouts
*/
const DefaultWidth = 1600;
const DefaultHeight = 1200;
public $id = self::DefaultId;
public $classic = false;
public $width = self::DefaultWidth;
public $height = self::DefaultHeight;
public $items = [];
public $options = [
'id' => self::DefaultId,
'width' => self::DefaultWidth,
'height' => self::DefaultHeight,
'items' => []
];
/**
* View
* @var MiniView
*/
private $mv = null;
private static $idCounter = 0;
public function __construct($options = [])
{
if (!empty($options))
{
$this->options = array_merge($this->options, $options);
}
// Apply configuration
EmbeDi::fly()->apply($this->options, $this);
// Setup view
$this->mv = new MiniView($this);
// Set auto id if id is default
if ($this->id === self::DefaultId && self::$idCounter > 0)
{
$this->id = sprintf('%s-%d', $this->id, self::$idCounter++);
}
}
public function getItems()
{
foreach ($this->items as $item)
{
yield new CarouselItem($item, $this);
}
}
public function getId()
{
return $this->id;
}
public function __toString()
{
return $this->mv->render('carousel', [], true);
}
}
API documentation generated by ApiGen