DropDownButton.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\Buttons;
 
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\DropDown\DropDownItemInterface;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\DropDown\DropDownRadio;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconSize;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪DropDownButton implements ‪ButtonInterface
{
    protected ?‪Icon ‪$icon = null;
    protected string ‪$label = '';
    protected ?string ‪$title = null;
    protected array ‪$items = [];
    protected bool ‪$showLabelText = false;
 
    public function ‪getIcon(): ?‪Icon
    {
        return ‪$this->icon;
    }
 
    public function ‪setIcon(?‪Icon ‪$icon): self
    {
        ‪$icon?->‪setSize(IconSize::SMALL);
        $this->icon = ‪$icon;
        return $this;
    }
 
    public function ‪getLabel(): string
    {
        return ‪$this->label;
    }
 
    public function ‪setLabel(string ‪$label): self
    {
        $this->label = ‪$label;
        return $this;
    }
 
    public function ‪getTitle(): string
    {
        return $this->title ?? ‪$this->label;
    }
 
    public function ‪setTitle(?string ‪$title): self
    {
        $this->title = ‪$title;
        return $this;
    }
 
    public function ‪getShowLabelText(): bool
    {
        return ‪$this->showLabelText;
    }
 
    public function ‪setShowLabelText(bool ‪$showLabelText): self
    {
        $this->showLabelText = ‪$showLabelText;
        return $this;
    }
 
    public function ‪addItem(‪DropDownItemInterface $item): self
    {
        if (!$item->‪isValid()) {
            throw new \InvalidArgumentException(
                'Only valid items may be assigned to a DropdownButton. "' .
                $item->‪getType() .
                '" did not pass validation',
                1667645426
            );
        }
 
        $this->items[] = clone $item;
 
        return $this;
    }
 
    public function ‪getItems(): array
    {
        return ‪$this->items;
    }
 
    public function ‪isValid()
    {
        return !empty($this->‪getLabel())
            && ($this->‪getShowLabelText() || $this->‪getIcon())
            && !empty($this->‪getItems());
    }
 
    public function ‪getType()
    {
        return static::class;
    }
 
    public function ‪render()
    {
        ‪$items = $this->‪getItems();
 
        $activeItems = array_filter(‪$items, function (‪DropDownItemInterface $item): bool {
            return $item instanceof ‪DropDownRadio && $item->isActive();
        });
        if (!empty($activeItems)) {
            $activeItem = array_shift($activeItems);
            if ($activeItem->getIcon()) {
                $this->‪setIcon($activeItem->getIcon());
            }
        }
 
        $attributes = [
            'type' => 'button',
            'class' => 'btn btn-sm btn-default dropdown-toggle',
            'data-bs-toggle' => 'dropdown',
            'aria-expanded' => 'false',
        ];
        if ($this->‪getTitle()) {
            $attributes['title'] = $this->‪getTitle();
        }
 
        $labelText = '';
        if ($this->‪getShowLabelText()) {
            $labelText = ' ' . $this->‪getLabel();
        }
 
        $content = '<div class="btn-group">'
            . '<button ' . GeneralUtility::implodeAttributes($attributes, true) . '>'
            . ($this->‪getIcon() !== null ? $this->‪getIcon()->render() : '')
            . htmlspecialchars($labelText)
            . '</button>'
            . '<ul class="dropdown-menu">';
 
        foreach (‪$items as $item) {
            $content .= '<li>' . $item->render() . '</li>';
        }
        $content .= '
            </ul>
        </div>';
        return $content;
    }
 
    public function ‪__toString(): string
    {
        return $this->‪render();
    }
}