Files
iTop/sources/Application/UI/Base/Layout/Dashboard/DashboardLayout.php
2024-05-06 18:35:31 +02:00

102 lines
2.1 KiB
PHP

<?php
/**
* @copyright Copyright (C) 2010-2024 Combodo SAS
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Application\UI\Base\Layout\Dashboard;
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
use Combodo\iTop\Application\UI\Base\UIBlock;
class DashboardLayout extends UIBlock
{
public const BLOCK_CODE = 'ibo-dashboard';
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/layouts/dashboard/layout';
/** @var string */
protected $sTitle;
/** @var \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock */
protected $oToolbar;
/** @var DashboardRow[] */
protected $aDashboardRows;
/** @var int */
protected $iRows;
public function __construct(?string $sId = null)
{
parent::__construct($sId);
$this->aDashboardRows = [];
$this->iRows = 0;
$this->sTitle = '';
$this->oToolbar = new UIContentBlock(null, ['ibo-dashboard--top-bar-toolbar']);
}
/**
*
* @param \Combodo\iTop\Application\UI\Base\Layout\Dashboard\DashboardRow $oDashboardRow
*
* @return $this
*/
public function AddDashboardRow(DashboardRow $oDashboardRow)
{
$oDashboardRow->SetRowIndex($this->iRows);
$this->aDashboardRows[] = $oDashboardRow;
$this->iRows++;
return $this;
}
public function GetSubBlocks(): array
{
return array_merge($this->aDashboardRows, [$this->oToolbar]);
}
/**
* @see static::$sTitle
* @return bool
*/
public function HasTitle(): bool
{
return strlen($this->sTitle) > 0;
}
/**
* @return string
*/
public function GetTitle(): string
{
return $this->sTitle;
}
/**
* @see static::$oToolbar
* @return bool
*/
public function HasToolbar(): bool
{
return $this->oToolbar->HasSubBlocks();
}
/**
* @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
*/
public function GetToolbar()
{
return $this->oToolbar;
}
public function SetTitle(string $sTitle)
{
$this->sTitle = $sTitle;
}
/**
* @return \Combodo\iTop\Application\UI\Base\Layout\Dashboard\DashboardRow[]
*/
public function GetDashboardRows(): array
{
return $this->aDashboardRows;
}
}