Your IP : 216.73.217.13
<?php
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Backend\View\BackendLayout;
use TYPO3\CMS\Backend\View\BackendLayoutView;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Class to represent a backend layout.
*/
class BackendLayout
{
/**
* @var string
*/
protected $identifier;
/**
* @var string
*/
protected $title;
/**
* @var string
*/
protected $description;
/**
* @var string
*/
protected $iconPath;
/**
* @var string
*/
protected $configuration;
/**
* The structured data of the configuration represented as array.
*
* @var array
*/
protected $structure = [];
/**
* @var array
*/
protected $data;
/**
* @param string $identifier
* @param string $title
* @param string|array $configuration
* @return BackendLayout
*/
public static function create($identifier, $title, $configuration)
{
return GeneralUtility::makeInstance(
static::class,
$identifier,
$title,
$configuration
);
}
/**
* @param string $identifier
* @param string $title
* @param string|array $configuration
*/
public function __construct($identifier, $title, $configuration)
{
$this->setIdentifier($identifier);
$this->setTitle($title);
if (is_array($configuration)) {
$this->structure = $configuration;
$this->configuration = $configuration['config'] ?? '';
} else {
$this->setConfiguration($configuration);
}
}
/**
* @return string
*/
public function getIdentifier()
{
return $this->identifier;
}
/**
* @param string $identifier
* @throws \UnexpectedValueException
*/
public function setIdentifier($identifier)
{
if (str_contains($identifier, '__')) {
throw new \UnexpectedValueException(
'Identifier "' . $identifier . '" must not contain "__"',
1381597630
);
}
$this->identifier = $identifier;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getIconPath()
{
return $this->iconPath;
}
/**
* @param string $iconPath
*/
public function setIconPath($iconPath)
{
$this->iconPath = $iconPath;
}
/**
* @return string
*/
public function getConfiguration()
{
return $this->configuration;
}
/**
* @param string $configuration
*/
public function setConfiguration($configuration)
{
$this->configuration = $configuration;
$this->structure = GeneralUtility::makeInstance(BackendLayoutView::class)->parseStructure($this);
}
/**
* Returns the columns registered for this layout as $key => $value pair where the key is the colPos
* and the value is the title.
* "1" => "Left" etc.
* Please note that the title can contain LLL references ready for translation.
*/
public function getUsedColumns(): array
{
return $this->structure['usedColumns'] ?? [];
}
public function getColCount(): int
{
return $this->structure['colCount'] ?? 0;
}
public function getRowCount(): int
{
return $this->structure['rowCount'] ?? 0;
}
/**
* @return array
*/
public function getData()
{
return $this->data;
}
public function setData(array $data)
{
$this->data = $data;
}
public function setStructure(array $structure)
{
$this->structure = $structure;
}
public function getStructure(): array
{
return $this->structure;
}
/**
* @return string[]
*/
public function getColumnPositionNumbers(): array
{
return $this->structure['__colPosList'];
}
}