SplitButton.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;
 
class ‪SplitButton extends ‪AbstractButton
{
    protected ‪$containsPrimaryAction = false;
 
    protected ‪$items = [];
 
    public function ‪addItem(‪AbstractButton $item, $primaryAction = false)
    {
        if (!$item->‪isValid()) {
            throw new \InvalidArgumentException(
                'Only valid items may be assigned to a split Button. "' .
                $item->‪getType() .
                '" did not pass validation',
                1441706330
            );
        }
        if ($primaryAction && $this->containsPrimaryAction) {
            throw new \InvalidArgumentException('A splitButton may only contain one primary action', 1441706340);
        }
        if ($primaryAction) {
            $this->containsPrimaryAction = true;
            $this->items['primary'] = clone $item;
        } else {
            $this->items['options'][] = clone $item;
        }
        return $this;
    }
 
    public function ‪getButton()
    {
        if (!isset($this->items['primary']) && isset($this->items['options'])) {
            $primaryAction = array_shift($this->items['options']);
            $this->items['primary'] = $primaryAction;
        }
        return ‪$this->items;
    }
 
    public function ‪isValid()
    {
        $subject = $this->‪getButton();
        return isset($subject['primary'])
               && ($subject['primary'] instanceof ‪AbstractButton)
               && isset($subject['options']);
    }
 
    public function ‪render()
    {
        ‪$items = $this->‪getButton();
        $attributes = [
            'type' => 'submit',
            'class' => 'btn btn-sm btn-default ' . ‪$items['primary']->getClasses(),
        ];
        if (method_exists(‪$items['primary'], 'getName')) {
            $attributes['name'] = ‪$items['primary']->getName();
        }
        if (method_exists(‪$items['primary'], 'getValue')) {
            $attributes['value'] = ‪$items['primary']->getValue();
        }
        if (method_exists(‪$items['primary'], 'getForm') && !empty(‪$items['primary']->getForm())) {
            $attributes['form'] = ‪$items['primary']->getForm();
        }
        $attributesString = '';
        foreach ($attributes as $key => $value) {
            $attributesString .= ' ' . htmlspecialchars($key) . '="' . htmlspecialchars($value) . '"';
        }
        $content = '
        <div class="btn-group t3js-splitbutton">
            <button' . $attributesString . '>
                ' . ‪$items['primary']->getIcon()->render('inline') . '
                ' . htmlspecialchars(‪$items['primary']->‪getTitle()) . '
            </button>
            <button type="button" class="btn btn-sm btn-default dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
                <span class="visually-hidden">Toggle Dropdown</span>
            </button>
            <ul class="dropdown-menu">';
 
        foreach (‪$items['options'] as $option) {
            if ($option instanceof ‪InputButton) {
                // if the option is an InputButton we have to create a custom rendering
                $optionAttributes = [
                    'href' => '#',
                    'data-name' => $option->getName(),
                    'data-value' => $option->getValue(),
                    'data-form' => $option->getForm(),
                ];
 
                if (!empty($option->getClasses())) {
                    $optionAttributes['class'] = $option->getClasses();
                }
                $optionAttributes['class'] = implode(' ', [$optionAttributes['class'] ?? '', 'dropdown-item']);
                $optionAttributesString = '';
                foreach ($optionAttributes as $key => $value) {
                    $optionAttributesString .= ' ' . htmlspecialchars($key) . '="' . htmlspecialchars($value) . '"';
                }
                $html = '' .
                    '<a' . $optionAttributesString . '>' .
                        '<span class="dropdown-item-columns">' .
                            '<span class="dropdown-item-column dropdown-item-column-icon" aria-hidden="true">' .
                                $option->getIcon()->render('inline') .
                            '</span>' .
                            '<span class="dropdown-item-column dropdown-item-column-title">' .
                                htmlspecialchars($option->getTitle()) .
                            '</span>' .
                        '</span>' .
                    '</a>';
            } else {
                // for any other kind of button we simply use what comes along (e.g. LinkButton)
                $html = $option->render();
            }
 
            $content .= '
                <li>
                   ' . $html . '
                </li>
            ';
        }
        $content .= '
            </ul>
        </div>
        ';
        return $content;
    }
 
    public function ‪__toString(): string
    {
        return $this->‪render();
    }
}