FormViewHelperTest.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\Fluid\Tests\Functional\ViewHelpers;
 
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters;
use ‪TYPO3\CMS\Extbase\Mvc\Request;
use ‪TYPO3\CMS\Fluid\Tests\Functional\Fixtures\ViewHelpers\ExtendsAbstractEntity;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪FormViewHelperTest extends FunctionalTestCase
{
    public function ‪isRenderedDataProvider(): array
    {
        return [
            '#1' => [
                '<f:form action="{action}" method="{method}" fieldNamePrefix="{fieldNamePrefix}" />',
                [
                    'action' => 'fieldNamePrefix<>&"\'',
                    'method' => 'fieldNamePrefix<>&"\'',
                    'fieldNamePrefix' => 'fieldNamePrefix<>&"\'',
                ],
                // first element having "@extension" in name attribute
                // check against correct value regarding php 8.1 change of default argument values of flags for ex. htmlspecialchars()
                // @todo remove conditional values when php 8.1 is min requirement
                (PHP_VERSION_ID < 80100
                    // before php 8.1 - remove this for >php8.1 only
                    ? '<input type="hidden" name="fieldNamePrefix&lt;&gt;&amp;&quot;\'[__referrer][@extension]" value="" />'
                    // for php 8.1
                    : '<input type="hidden" name="fieldNamePrefix&lt;&gt;&amp;&quot;&#039;[__referrer][@extension]" value="" />'),
            ],
            '#2' => [
                '{f:form(action:action, method:method, fieldNamePrefix:fieldNamePrefix)}',
                [
                    'action' => 'fieldNamePrefix<>&"\'',
                    'method' => 'fieldNamePrefix<>&"\'',
                    'fieldNamePrefix' => 'fieldNamePrefix<>&"\'',
                ],
                // first element having "@extension" in name attribute
                // check against correct value regarding php 8.1 change of default argument values of flags for ex. htmlspecialchars()
                // @todo remove conditional values when php 8.1 is min requirement
                (PHP_VERSION_ID < 80100
                    // before php 8.1 - remove this for >php8.1 only
                    ? '<input type="hidden" name="fieldNamePrefix&lt;&gt;&amp;&quot;\'[__referrer][@extension]" value="" />'
                    // for php 8.1
                    : '<input type="hidden" name="fieldNamePrefix&lt;&gt;&amp;&quot;&#039;[__referrer][@extension]" value="" />'),
            ],
        ];
    }
 
    public function ‪isRendered(string $source, array $variables, string $expectation): void
    {
        $view = new ‪StandaloneView();
        $view->setTemplateSource($source);
        $view->assignMultiple($variables);
        $body = $view->render();
        $actual = null;
        if (preg_match('#<input[^>]+name=".+\[@extension\]"[^>]+>#m', $body, $matches)) {
            $actual = $matches[0];
        }
        self::assertSame($expectation, $actual);
    }
 
    public function ‪renderHiddenIdentityFieldReturnsAHiddenInputFieldContainingTheObjectsUID(): void
    {
        $extendsAbstractEntity = new ‪ExtendsAbstractEntity();
        $extendsAbstractEntity->_setProperty('uid', 123);
        $view = new ‪StandaloneView();
        $view->assign('object', $extendsAbstractEntity);
        $view->setTemplateSource('<f:form fieldNamePrefix="prefix" objectName="myObjectName" object="{object}" />');
        $expected = '<input type="hidden" name="prefix[myObjectName][__identity]" value="123" />';
        self::assertStringContainsString($expected, $view->render());
    }
 
    public function ‪setFormActionUriRespectsOverriddenArgument(): void
    {
        $view = new ‪StandaloneView();
        $view->setTemplateSource('<f:form actionUri="foobar" />');
        $expected = '<form action="foobar" method="post">';
        self::assertStringContainsString($expected, $view->render());
    }
 
    public function ‪nameArgumentIsUsedFormHiddenIdentityName(): void
    {
        $extendsAbstractEntity = new ‪ExtendsAbstractEntity();
        $extendsAbstractEntity->_setProperty('uid', 123);
        $view = new ‪StandaloneView();
        $view->assign('object', $extendsAbstractEntity);
        $view->setTemplateSource('<f:form name="formName" fieldNamePrefix="prefix" object="{object}" />');
        $expected = '<input type="hidden" name="prefix[formName][__identity]" value="123" />';
        self::assertStringContainsString($expected, $view->render());
    }
 
    public function ‪objectNameArgumentOverrulesNameArgument(): void
    {
        $extendsAbstractEntity = new ‪ExtendsAbstractEntity();
        $extendsAbstractEntity->_setProperty('uid', 123);
        $view = new ‪StandaloneView();
        $view->assign('object', $extendsAbstractEntity);
        $view->setTemplateSource('<f:form name="formName" fieldNamePrefix="prefix" objectName="myObjectName" object="{object}" />');
        $expected = '<input type="hidden" name="prefix[myObjectName][__identity]" value="123" />';
        self::assertStringContainsString($expected, $view->render());
    }
 
    public function ‪renderWrapsHiddenFieldsWithDivForXhtmlCompatibilityWithRewrittenPropertyMapper(): void
    {
        $extendsAbstractEntity = new ‪ExtendsAbstractEntity();
        $extendsAbstractEntity->_setProperty('uid', 123);
        $view = new ‪StandaloneView();
        $view->assign('object', $extendsAbstractEntity);
        $view->setTemplateSource('<f:form fieldNamePrefix="prefix" objectName="myObjectName" object="{object}" />');
        $expected = '<form action="" method="post">' . chr(10) . '<div>';
        self::assertStringContainsString($expected, $view->render());
    }
 
    public function ‪renderWrapsHiddenFieldsWithDivAndAnAdditionalClassForXhtmlCompatibilityWithRewrittenPropertyMapper(): void
    {
        $extendsAbstractEntity = new ‪ExtendsAbstractEntity();
        $extendsAbstractEntity->_setProperty('uid', 123);
        $view = new ‪StandaloneView();
        $view->assign('object', $extendsAbstractEntity);
        $view->setTemplateSource('<f:form hiddenFieldClassName="hidden" fieldNamePrefix="prefix" objectName="myObjectName" object="{object}" />');
        $expected = '<form action="" method="post">' . chr(10) . '<div class="hidden">';
        self::assertStringContainsString($expected, $view->render());
    }
 
    public function ‪renderHiddenReferrerFieldsAddCurrentControllerAndActionAsHiddenFields(): void
    {
        $extbaseRequestParameters = new ‪ExtbaseRequestParameters();
        $extbaseRequestParameters->setControllerActionName('controllerActionName');
        $extbaseRequestParameters->setControllerName('controllerName');
        $extbaseRequestParameters->setControllerExtensionName('extensionName');
        $psr7Request = (new ‪ServerRequest())->withAttribute('extbase', $extbaseRequestParameters);
        $extbaseRequest = new ‪Request($psr7Request);
        GeneralUtility::addInstance(Request::class, $extbaseRequest);
 
        $extendsAbstractEntity = new ‪ExtendsAbstractEntity();
        $extendsAbstractEntity->_setProperty('uid', 123);
        $view = new ‪StandaloneView();
        $view->assign('object', $extendsAbstractEntity);
        $view->setTemplateSource('<f:form fieldNamePrefix="prefix" objectName="myObjectName" object="{object}" />');
        $expected = '<form action="" method="post">
<div>
<input type="hidden" name="prefix[myObjectName][__identity]" value="123" />
 
<input type="hidden" name="prefix[__referrer][@extension]" value="extensionName" />
<input type="hidden" name="prefix[__referrer][@controller]" value="controllerName" />
<input type="hidden" name="prefix[__referrer][@action]" value="controllerActionName" />
<input type="hidden" name="prefix[__referrer][arguments]" value="YTowOnt97e22094095b617b0604f3fe5b48446b0dfa46c8c" />
<input type="hidden" name="prefix[__referrer][@request]" value="{&quot;@extension&quot;:&quot;extensionName&quot;,&quot;@controller&quot;:&quot;controllerName&quot;,&quot;@action&quot;:&quot;controllerActionName&quot;}a85f8e01ed64daa6bd0910d3c3fafe3519eed791" />
<input type="hidden" name="prefix[__trustedProperties]" value="{&quot;myObjectName&quot;:{&quot;__identity&quot;:1}}c5603abb8f2ebaef799efd6ba9f46ea7edc650ea" />
</div>
</form>';
        self::assertSame($expected, $view->render());
    }
}