BackendLayout.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\View\BackendLayout;

/*
 * 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!
 */

class BackendLayout
{
    protected $identifier;

    protected $title;

    protected $description;

    protected $iconPath;

    protected $configuration;

    protected $data;

    public static function create($identifier, $title, $configuration)
    {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
            BackendLayout::class,
            $identifier,
            $title,
            $configuration
        );
    }

    public function __construct($identifier, $title, $configuration)
    {
        $this->setIdentifier($identifier);
        $this->setTitle($title);
        $this->setConfiguration($configuration);
    }

    public function getIdentifier()
    {
        return $this->identifier;
    }

    public function setIdentifier($identifier)
    {
        if (strpos($identifier, '__') !== false) {
            throw new \UnexpectedValueException(
                'Identifier "' . $identifier . '" must not contain "__"',
                1381597630
            );
        }

        $this->identifier = $identifier;
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function setTitle($title)
    {
        $this->title = $title;
    }

    public function getDescription()
    {
        return $this->description;
    }

    public function setDescription($description)
    {
        $this->description = $description;
    }

    public function getIconPath()
    {
        return $this->iconPath;
    }

    public function setIconPath($iconPath)
    {
        $this->iconPath = $iconPath;
    }

    public function getConfiguration()
    {
        return $this->configuration;
    }

    public function setConfiguration($configuration)
    {
        $this->configuration = $configuration;
    }

    public function getData()
    {
        return $this->data;
    }

    public function setData(array $data)
    {
        $this->data = $data;
    }
}