RequestTest.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\Extbase\Tests\Unit\Mvc;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentNameException;
use ‪TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters;
use ‪TYPO3\CMS\Extbase\Mvc\Request;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪RequestTest extends UnitTestCase
{
    #[Test]
    public function ‪aSingleArgumentCanBeSetWithWithArgumentAndRetrievedWithGetArgument(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('someArgumentName', 'theValue');
        self::assertEquals('theValue', $request->getArgument('someArgumentName'));
    }
 
    #[Test]
    public function ‪withArgumentThrowsExceptionIfTheGivenArgumentNameIsAnEmptyString(): void
    {
        $this->expectException(InvalidArgumentNameException::class);
        $this->expectExceptionCode(1210858767);
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request->withArgument('', 'theValue');
    }
 
    #[Test]
    public function ‪withArgumentsOverridesAllExistingArguments(): void
    {
        $arguments = ['key1' => 'value1', 'key2' => 'value2'];
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('someKey', 'shouldBeOverridden');
        $request = $request->withArguments($arguments);
        $actualResult = $request->getArguments();
        self::assertEquals($arguments, $actualResult);
    }
 
    #[Test]
    public function ‪withArgumentCanNotSetAtExtension(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('@extension', 'MyExtension');
        self::assertFalse($request->hasArgument('@extension'));
    }
 
    #[Test]
    public function ‪withArgumentCanNotSetAtController(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('@controller', 'MyController');
        self::assertFalse($request->hasArgument('@controller'));
    }
 
    #[Test]
    public function ‪withArgumentCanNotSetAtAction(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('@action', 'foo');
        self::assertFalse($request->hasArgument('@action'));
    }
 
    #[Test]
    public function ‪withArgumentCanNotSetAtFormat(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('@format', 'txt');
        self::assertFalse($request->hasArgument('@format'));
    }
 
    #[Test]
    public function ‪internalArgumentsIsNotReturnedAsNormalArgument(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('__referrer', 'foo');
        self::assertFalse($request->hasArgument('__referrer'));
    }
 
    #[Test]
    public function ‪multipleArgumentsCanBeSetWithWithArgumentsAndRetrievedWithGetArguments(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $arguments = [
            'firstArgument' => 'firstValue',
            'dænishÅrgument' => 'görman välju',
            '3a' => '3v',
        ];
        $request = $request->withArguments($arguments);
        self::assertEquals($arguments, $request->getArguments());
    }
 
    #[Test]
    public function ‪hasArgumentTellsIfAnArgumentExists(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withArgument('existingArgument', 'theValue');
        self::assertTrue($request->hasArgument('existingArgument'));
        self::assertFalse($request->hasArgument('notExistingArgument'));
    }
 
    #[Test]
    public function ‪theActionNameCanBeSetAndRetrieved(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withControllerActionName('theAction');
        self::assertEquals('theAction', $request->getControllerActionName());
    }
 
    #[Test]
    public function ‪theRepresentationFormatCanBeSetAndRetrieved(): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withFormat('html');
        self::assertEquals('html', $request->getFormat());
    }
 
    public static function ‪controllerArgumentsAndExpectedObjectName(): array
    {
        return [
            'Vendor TYPO3\CMS, extension, controller given' => [
                [
                    'extensionName' => 'Ext',
                    'controllerName' => 'Foo',
                ],
                'TYPO3\\CMS\\Ext\\Controller\\FooController',
            ],
            'Vendor TYPO3\CMS, extension, subpackage, controller given' => [
                [
                    'extensionName' => 'Fluid',
                    'controllerName' => 'Paginate',
                ],
                'TYPO3\\CMS\\Fluid\\ViewHelpers\\Widget\\Controller\\PaginateController',
            ],
            'Vendor VENDOR, extension, controller given' => [
                [
                    'extensionName' => 'Ext',
                    'controllerName' => 'Foo',
                ],
                'VENDOR\\Ext\\Controller\\FooController',
            ],
            'Vendor VENDOR, extension subpackage, controller given' => [
                [
                    'extensionName' => 'Ext',
                    'controllerName' => 'Foo',
                ],
                'VENDOR\\Ext\\ViewHelpers\\Widget\\Controller\\FooController',
            ],
        ];
    }
 
    #[DataProvider('controllerArgumentsAndExpectedObjectName')]
    #[Test]
    public function ‪withControllerObjectNameResolvesControllerObjectNameArgumentsCorrectly(array $controllerArguments, string $controllerObjectName): void
    {
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $request = $request->withControllerObjectName($controllerObjectName);
        $actualControllerArguments = [
            'extensionName' => $request->getControllerExtensionName(),
            'controllerName' => $request->getControllerName(),
        ];
        self::assertSame($controllerArguments, $actualControllerArguments);
    }
}