UploadedResourceViewHelper.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\Form\ViewHelpers\Form;
 
use ‪TYPO3\CMS\Core\Crypto\HashService;
use ‪TYPO3\CMS\Extbase\Domain\Model\FileReference;
use ‪TYPO3\CMS\Extbase\Property\PropertyMapper;
use ‪TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper;
use ‪TYPO3\CMS\Form\Security\HashScope;
 
final class ‪UploadedResourceViewHelper extends ‪AbstractFormFieldViewHelper
{
    protected ‪$tagName = 'input';
 
    protected ‪HashService ‪$hashService;
    protected ‪PropertyMapper ‪$propertyMapper;
 
    public function ‪injectHashService(‪HashService ‪$hashService)
    {
        $this->hashService = ‪$hashService;
    }
 
    public function ‪injectPropertyMapper(‪PropertyMapper ‪$propertyMapper)
    {
        $this->propertyMapper = ‪$propertyMapper;
    }
 
    public function ‪initializeArguments(): void
    {
        parent::initializeArguments();
        $this->registerArgument('as', 'string', '');
        $this->registerArgument('accept', 'array', 'Values for the accept attribute', false, []);
        $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this ViewHelper', false, 'f3-form-error');
        $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');
        $this->registerTagAttribute('multiple', 'string', 'Specifies that the file input element should allow multiple selection of files');
        $this->registerUniversalTagAttributes();
    }
 
    public function ‪render(): string
    {
        ‪$output = '';
 
        $name = $this->‪getName();
        $as = $this->arguments['as'];
        $accept = $this->arguments['accept'];
        $resource = $this->‪getUploadedResource();
 
        if (!empty($accept)) {
            $this->tag->addAttribute('accept', implode(',', $accept));
        }
 
        if ($resource !== null) {
            $resourcePointerIdAttribute = '';
            if ($this->hasArgument('id')) {
                $resourcePointerIdAttribute = ' id="' . htmlspecialchars($this->arguments['id']) . '-file-reference"';
            }
            $resourcePointerValue = $resource->getUid();
            if ($resourcePointerValue === null) {
                // Newly created file reference which is not persisted yet.
                // Use the file UID instead, but prefix it with "file:" to communicate this to the type converter
                $resourcePointerValue = 'file:' . $resource->getOriginalResource()->getOriginalFile()->getUid();
            }
            ‪$output .= '<input type="hidden" name="' . htmlspecialchars($this->‪getName()) . '[submittedFile][resourcePointer]" value="' . htmlspecialchars($this->hashService->appendHmac((string)$resourcePointerValue, HashScope::ResourcePointer->prefix())) . '"' . $resourcePointerIdAttribute . ' />';
 
            $this->templateVariableContainer->add($as, $resource);
            ‪$output .= $this->renderChildren();
            $this->templateVariableContainer->remove($as);
        }
 
        foreach (['name', 'type', 'tmp_name', 'error', 'size'] as $fieldName) {
            $this->‪registerFieldNameForFormTokenGeneration($name . '[' . $fieldName . ']');
        }
        $this->tag->addAttribute('type', 'file');
 
        if (isset($this->arguments['multiple'])) {
            $this->tag->addAttribute('name', $name . '[]');
        } else {
            $this->tag->addAttribute('name', $name);
        }
 
        $this->‪setErrorClassAttribute();
        ‪$output .= $this->tag->render();
 
        return ‪$output;
    }
 
    protected function ‪getUploadedResource(): ?‪FileReference
    {
        if ($this->‪getMappingResultsForProperty()->hasErrors()) {
            return null;
        }
        $resource = $this->‪getValueAttribute();
        if ($resource instanceof ‪FileReference) {
            return $resource;
        }
        return $this->propertyMapper->convert($resource, FileReference::class);
    }
}