RequestTest.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\Extbase\Tests\Unit\Mvc;
 
use ‪TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentNameException;
use ‪TYPO3\CMS\Extbase\Mvc\Request;
use ‪TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller\PaginateController;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪RequestTest extends UnitTestCase
{
    public function ‪aSingleArgumentCanBeSetWithSetArgumentAndRetrievedWithGetArgument(): void
    {
        $request = new ‪Request();
        $request->setArgument('someArgumentName', 'theValue');
        self::assertEquals('theValue', $request->getArgument('someArgumentName'));
    }
 
    public function ‪setArgumentThrowsExceptionIfTheGivenArgumentNameIsNoString(): void
    {
        $this->expectException(InvalidArgumentNameException::class);
        $this->expectExceptionCode(1210858767);
        $request = new ‪Request();
        $request->setArgument(123, 'theValue');
    }
 
    public function ‪setArgumentThrowsExceptionIfTheGivenArgumentNameIsAnEmptyString(): void
    {
        $this->expectException(InvalidArgumentNameException::class);
        $this->expectExceptionCode(1210858767);
        $request = new ‪Request();
        $request->setArgument('', 'theValue');
    }
 
    public function ‪setArgumentsOverridesAllExistingArguments(): void
    {
        $arguments = ['key1' => 'value1', 'key2' => 'value2'];
        $request = new ‪Request();
        $request->setArgument('someKey', 'shouldBeOverridden');
        $request->setArguments($arguments);
        $actualResult = $request->getArguments();
        self::assertEquals($arguments, $actualResult);
    }
 
    public function ‪setArgumentsCallsSetArgumentForEveryArrayEntry(): void
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['setArgument'])
            ->getMock();
        $request->expects(self::exactly(2))->method('setArgument')
            ->withConsecutive(
                ['key1', 'value1'],
                ['key2', 'value2']
            );
        $request->setArguments(['key1' => 'value1', 'key2' => 'value2']);
    }
 
    public function ‪setArgumentShouldSetControllerExtensionNameIfPackageKeyIsGiven(): void
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['setControllerExtensionName'])
            ->getMock();
        $request->method('setControllerExtensionName')->with('MyExtension');
        $request->setArgument('@extension', 'MyExtension');
        self::assertFalse($request->hasArgument('@extension'));
    }
 
    public function ‪setArgumentShouldSetControllerSubpackageKeyIfSubpackageKeyIsGiven(): void
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['setControllerSubpackageKey'])
            ->getMock();
        $request->method('setControllerSubpackageKey')->with('MySubPackage');
        $request->setArgument('@subpackage', 'MySubPackage');
        self::assertFalse($request->hasArgument('@subpackage'));
    }
 
    public function ‪setArgumentShouldSetControllerNameIfControllerIsGiven(): void
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['setControllerName'])
            ->getMock();
        $request->method('setControllerName')->with('MyController');
        $request->setArgument('@controller', 'MyController');
        self::assertFalse($request->hasArgument('@controller'));
    }
 
    public function ‪setArgumentShouldSetControllerActionNameIfActionIsGiven(): void
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['setControllerActionName'])
            ->getMock();
        $request->method('setControllerActionName')->with('foo');
        $request->setArgument('@action', 'foo');
        self::assertFalse($request->hasArgument('@action'));
    }
 
    public function ‪setArgumentShouldSetFormatIfFormatIsGiven(): void
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['setFormat'])
            ->getMock();
        $request->method('setFormat')->with('txt');
        $request->setArgument('@format', 'txt');
        self::assertFalse($request->hasArgument('@format'));
    }
 
    public function ‪internalArgumentsShouldNotBeReturnedAsNormalArgument(): void
    {
        $request = new ‪Request();
        $request->setArgument('__referrer', 'foo');
        self::assertFalse($request->hasArgument('__referrer'));
    }
 
    public function ‪internalArgumentsShouldBeStoredAsInternalArguments(): void
    {
        $request = new ‪Request();
        $request->setArgument('__referrer', 'foo');
        self::assertSame('foo', $request->getInternalArgument('__referrer'));
    }
 
    public function ‪hasInternalArgumentShouldReturnNullIfArgumentNotFound(): void
    {
        $request = new ‪Request();
        self::assertNull($request->getInternalArgument('__nonExistingInternalArgument'));
    }
 
    public function ‪setArgumentAcceptsObjectIfArgumentIsInternal(): void
    {
        $request = new ‪Request();
        $object = new \stdClass();
        $request->setArgument('__theKey', $object);
        self::assertSame($object, $request->getInternalArgument('__theKey'));
    }
 
    public function ‪multipleArgumentsCanBeSetWithSetArgumentsAndRetrievedWithGetArguments(): void
    {
        $arguments = [
            'firstArgument' => 'firstValue',
            'dænishÅrgument' => 'görman välju',
            '3a' => '3v'
        ];
        $request = new ‪Request();
        $request->setArguments($arguments);
        self::assertEquals($arguments, $request->getArguments());
    }
 
    public function ‪hasArgumentTellsIfAnArgumentExists(): void
    {
        $request = new ‪Request();
        $request->setArgument('existingArgument', 'theValue');
        self::assertTrue($request->hasArgument('existingArgument'));
        self::assertFalse($request->hasArgument('notExistingArgument'));
    }
 
    public function ‪theActionNameCanBeSetAndRetrieved()
    {
        $request = $this->getMockBuilder(Request::class)
            ->onlyMethods(['getControllerObjectName'])
            ->disableOriginalConstructor()
            ->getMock();
        $request->expects(self::once())->method('getControllerObjectName')->willReturn('');
        $request->setControllerActionName('theAction');
        self::assertEquals('theAction', $request->getControllerActionName());
    }
 
    public function ‪theRepresentationFormatCanBeSetAndRetrieved(): void
    {
        $request = new ‪Request();
        $request->setFormat('html');
        self::assertEquals('html', $request->getFormat());
    }
 
    public function ‪aFlagCanBeSetIfTheRequestNeedsToBeDispatchedAgain(): void
    {
        $request = new ‪Request();
        self::assertFalse($request->isDispatched());
        $request->setDispatched(true);
        self::assertTrue($request->isDispatched());
    }
 
    public function ‪controllerArgumentsAndExpectedObjectName(): array
    {
        return [
            'Vendor TYPO3\CMS, extension, controller given' => [
                [
                    'extensionName' => 'Ext',
                    'subpackageKey' => '',
                    'controllerName' => 'Foo',
                ],
                'TYPO3\\CMS\\Ext\\Controller\\FooController',
            ],
            'Vendor TYPO3\CMS, extension, subpackage, controller given' => [
                [
                    'extensionName' => 'Fluid',
                    'subpackageKey' => 'ViewHelpers\\Widget',
                    'controllerName' => 'Paginate',
                ],
                PaginateController::class,
            ],
            'Vendor VENDOR, extension, controller given' => [
                [
                    'extensionName' => 'Ext',
                    'subpackageKey' => '',
                    'controllerName' => 'Foo',
                ],
                'VENDOR\\Ext\\Controller\\FooController',
            ],
            'Vendor VENDOR, extension subpackage, controller given' => [
                [
                    'extensionName' => 'Ext',
                    'subpackageKey' => 'ViewHelpers\\Widget',
                    'controllerName' => 'Foo',
                ],
                'VENDOR\\Ext\\ViewHelpers\\Widget\\Controller\\FooController',
            ],
        ];
    }
 
    public function ‪setControllerObjectNameResolvesControllerObjectNameArgumentsCorrectly($controllerArguments, $controllerObjectName): void
    {
        $request = new ‪Request();
        $request->setControllerObjectName($controllerObjectName);
 
        $actualControllerArguments = [
            'extensionName' => $request->getControllerExtensionName(),
            'subpackageKey' => $request->getControllerSubpackageKey(),
            'controllerName' => $request->getControllerName(),
        ];
 
        self::assertSame($controllerArguments, $actualControllerArguments);
    }
}