ButtonBar.php

Go to the documentation of this file.

<?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\Template\Components;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\FullyRenderedButton;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\InputButton;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\PositionInterface;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\SplitButton;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪ButtonBar
{
    public const ‪BUTTON_POSITION_LEFT = 'left';
 
    public const ‪BUTTON_POSITION_RIGHT = 'right';
 
    protected ‪$buttons = [];
 
    public function ‪addButton(
        ‪ButtonInterface $button,
        $buttonPosition = self::BUTTON_POSITION_LEFT,
        $buttonGroup = 1
    ) {
        if (!$button->‪isValid()) {
            throw new \InvalidArgumentException('Button "' . $button->‪getType() . '" is not valid', 1441706370);
        }
        // Determine the default button position
        if ($button instanceof ‪PositionInterface) {
            $buttonPosition = $button->getPosition();
            $buttonGroup = $button->getGroup();
        }
        // We make the button immutable here
        $this->buttons[$buttonPosition][$buttonGroup][] = clone $button;
        return $this;
    }
 
    public function ‪makeButton($button)
    {
        if (!in_array(ButtonInterface::class, class_implements($button) ?: [], true)) {
            throw new \InvalidArgumentException('A Button must implement ButtonInterface', 1441706378);
        }
        return GeneralUtility::makeInstance($button);
    }
 
    public function ‪makeInputButton()
    {
        return GeneralUtility::makeInstance(InputButton::class);
    }
 
    public function ‪makeSplitButton()
    {
        return GeneralUtility::makeInstance(SplitButton::class);
    }
 
    public function ‪makeDropDownButton()
    {
        return GeneralUtility::makeInstance(DropDownButton::class);
    }
 
    public function ‪makeLinkButton()
    {
        return GeneralUtility::makeInstance(LinkButton::class);
    }
 
    public function ‪makeFullyRenderedButton()
    {
        return GeneralUtility::makeInstance(FullyRenderedButton::class);
    }
 
    public function ‪makeShortcutButton()
    {
        return GeneralUtility::makeInstance(ShortcutButton::class);
    }
 
    public function ‪getButtons(): array
    {
        // here we need to call the sorting methods and stuff.
        foreach ($this->buttons as $position => $_) {
            ksort($this->buttons[$position]);
        }
 
        // Dispatch event for manipulating the docHeaderButtons
        $this->buttons = GeneralUtility::makeInstance(EventDispatcherInterface::class)->dispatch(
            new ModifyButtonBarEvent($this->buttons, $this)
        )->getButtons();
 
        return ‪$this->buttons;
    }
}