81 lines
2.3 KiB
PHP
81 lines
2.3 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
* Copyright (C) 2023 Xibo Signage Ltd
|
||
|
|
*
|
||
|
|
* Xibo - Digital Signage - https://xibosignage.com
|
||
|
|
*
|
||
|
|
* This file is part of Xibo.
|
||
|
|
*
|
||
|
|
* Xibo is free software: you can redistribute it and/or modify
|
||
|
|
* it under the terms of the GNU Affero General Public License as published by
|
||
|
|
* the Free Software Foundation, either version 3 of the License, or
|
||
|
|
* any later version.
|
||
|
|
*
|
||
|
|
* Xibo is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
* GNU Affero General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Affero General Public License
|
||
|
|
* along with Xibo. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Xibo\Widget\Definition;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @SWG\Definition()
|
||
|
|
* A Stencil is a template which is rendered in the server and/or client
|
||
|
|
* it can optionally have properties and/or elements
|
||
|
|
*/
|
||
|
|
class Stencil implements \JsonSerializable
|
||
|
|
{
|
||
|
|
/** @var \Xibo\Widget\Definition\Element[] */
|
||
|
|
public $elements = [];
|
||
|
|
|
||
|
|
/** @var string|null */
|
||
|
|
public $twig;
|
||
|
|
|
||
|
|
/** @var string|null */
|
||
|
|
public $hbs;
|
||
|
|
|
||
|
|
/** @var string|null */
|
||
|
|
public $head;
|
||
|
|
|
||
|
|
/** @var string|null */
|
||
|
|
public $style;
|
||
|
|
|
||
|
|
/** @var string|null */
|
||
|
|
public $hbsId;
|
||
|
|
|
||
|
|
/** @var double Optional positional information if contained as part of an element group */
|
||
|
|
public $width;
|
||
|
|
|
||
|
|
/** @var double Optional positional information if contained as part of an element group */
|
||
|
|
public $height;
|
||
|
|
|
||
|
|
/** @var double Optional positional information if contained as part of an element group */
|
||
|
|
public $gapBetweenHbs;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @SWG\Property(description="An array of element groups")
|
||
|
|
* @var \Xibo\Widget\Definition\ElementGroup[]
|
||
|
|
*/
|
||
|
|
public $elementGroups = [];
|
||
|
|
|
||
|
|
/** @inheritDoc */
|
||
|
|
public function jsonSerialize(): array
|
||
|
|
{
|
||
|
|
return [
|
||
|
|
'hbsId' => $this->hbsId,
|
||
|
|
'hbs' => $this->hbs,
|
||
|
|
'head' => $this->head,
|
||
|
|
'style' => $this->style,
|
||
|
|
'width' => $this->width,
|
||
|
|
'height' => $this->height,
|
||
|
|
'gapBetweenHbs' => $this->gapBetweenHbs,
|
||
|
|
'elements' => $this->elements,
|
||
|
|
'elementGroups' => $this->elementGroups
|
||
|
|
];
|
||
|
|
}
|
||
|
|
}
|