ShortcutButtonTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Tests\Functional\Template\Components\Buttons\Action;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton;
use ‪TYPO3\CMS\Core\Core\SystemEnvironmentBuilder;
use ‪TYPO3\CMS\Core\Http\NormalizedParams;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Localization\LanguageServiceFactory;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪ShortcutButtonTest extends FunctionalTestCase
{
    private const ‪FIXTURES_PATH_PATTERN = __DIR__ . '/../../../Fixtures/%s.html';
 
    #[Test]
    public function ‪isButtonValid(): void
    {
        self::assertFalse((new ‪ShortcutButton())->isValid());
        self::assertFalse((new ‪ShortcutButton())->setRouteIdentifier('web_list')->isValid());
        self::assertFalse((new ‪ShortcutButton())->setDisplayName('Some module anme')->isValid());
        self::assertTrue((new ‪ShortcutButton())->setRouteIdentifier('web_list')->setDisplayName('Some module anme')->isValid());
    }
 
    #[Test]
    public function ‪buttonIsNotRenderedForUserWithInsufficientPermissions(): void
    {
        $this->importCSVDataSet(__DIR__ . '/../../../../Fixtures/be_users_no_bookmarks.csv');
        $backendUser = $this->setUpBackendUser(1);
        ‪$GLOBALS['LANG'] = $this->get(LanguageServiceFactory::class)->createFromUserPreferences($backendUser);
        self::assertEmpty(
            (new ‪ShortcutButton())->setRouteIdentifier('web_list')->setDisplayName('Some module anme')->render()
        );
    }
 
    #[DataProvider('rendersCorrectMarkupDataProvider')]
    #[Test]
    public function ‪rendersCorrectMarkup(‪ShortcutButton $button, string $expectedMarkupFile): void
    {
        $this->importCSVDataSet(__DIR__ . '/../../../../Fixtures/be_users.csv');
        $backendUser = $this->setUpBackendUser(1);
        ‪$GLOBALS['LANG'] = $this->get(LanguageServiceFactory::class)->createFromUserPreferences($backendUser);
        $serverParams = array_replace(‪$_SERVER, ['HTTP_HOST' => 'example.com', 'SCRIPT_NAME' => '/index.php']);
        $request = new ‪ServerRequest('http://example.com/typo3/index.php', 'GET', null, $serverParams);
        ‪$GLOBALS['TYPO3_REQUEST'] = $request
            ->withAttribute('applicationType', ‪SystemEnvironmentBuilder::REQUESTTYPE_BE)
            ->withAttribute('normalizedParams', ‪NormalizedParams::createFromServerParams($serverParams));
 
        self::assertEquals(
            $this->‪normalizeSpaces(file_get_contents(sprintf(self::FIXTURES_PATH_PATTERN, $expectedMarkupFile))),
            $this->‪normalizeSpaces($button->‪render())
        );
    }
 
    public static function ‪rendersCorrectMarkupDataProvider(): \Generator
    {
        yield 'Recordlist' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('web_list')
                ->setDisplayName('Recordlist')
                ->setCopyUrlToClipboard(false),
            'RecordList',
        ];
        yield 'Recordlist with copyToClipboard action' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('web_list')
                ->setDisplayName('Recordlist'),
            'RecordListCopyToClipboard',
        ];
        yield 'Recordlist - single table view' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('web_list')
                ->setDisplayName('Recordlist - single table view')
                ->setCopyUrlToClipboard(false)
                ->setArguments([
                    'id' => 123,
                    'table' => 'some_table',
                    'GET' => [
                        'clipBoard' => 1,
                    ],
                ]),
            'RecordListSingleTable',
        ];
        yield 'Recordlist - single table view with copyToClipboard action' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('web_list')
                ->setDisplayName('Recordlist - single table view')
                ->setArguments([
                    'id' => 123,
                    'table' => 'some_table',
                    'GET' => [
                        'clipBoard' => 1,
                    ],
                ]),
            'RecordListSingleTableCopyToClipboard',
        ];
        yield 'With special route identifier' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('record_edit')
                ->setDisplayName('Edit record')
                ->setCopyUrlToClipboard(false),
            'SpecialRouteIdentifier',
        ];
        yield 'With special route identifier and arguments' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('record_edit')
                ->setDisplayName('Edit record')
                ->setCopyUrlToClipboard(false)
                ->setArguments([
                    'id' => 123,
                    'edit' => [
                        'pages' => [
                            123 => 'edit',
                        ],
                        'overrideVals' => [
                            'pages' => [
                                'sys_language_uid' => 1,
                            ],
                        ],
                    ],
                    'returnUrl' => 'some/url',
                ]),
            'SpecialRouteIdentifierWithArguments',
        ];
        yield 'With special route identifier and arguments - copyToClipboard' => [
            (new ‪ShortcutButton())
                ->setRouteIdentifier('record_edit')
                ->setDisplayName('Edit record')
                ->setArguments([
                    'id' => 123,
                    'edit' => [
                        'pages' => [
                            123 => 'edit',
                        ],
                        'overrideVals' => [
                            'pages' => [
                                'sys_language_uid' => 1,
                            ],
                        ],
                    ],
                    'returnUrl' => 'some/url',
                ]),
            'SpecialRouteIdentifierWithArgumentsCopyToClipboard',
        ];
    }
 
    private function ‪normalizeSpaces(string $html): string
    {
        return preg_replace(
            ['/^\s+(?=<)/m', '/^\s+(?!<)/m', '/\v+/'],
            ['', ' ', ''],
            $html
        );
    }
}