TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,121 @@
|
||||
<?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\ViewHelpers\Link;
|
||||
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException;
|
||||
use TYPO3\CMS\Backend\Routing\UriBuilder;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
|
||||
use TYPO3Fluid\Fluid\Core\ViewHelper\InvalidArgumentValueException;
|
||||
|
||||
/**
|
||||
* Use this ViewHelper to provide edit links to records. The ViewHelper will
|
||||
* pass the uid and table to FormEngine.
|
||||
*
|
||||
* The uid must be given as a positive integer.
|
||||
* For new records, use the :ref:`<be:link.newRecordViewHelper> <typo3-backend-link-newrecord>`.
|
||||
*
|
||||
* Examples
|
||||
* ========
|
||||
*
|
||||
* Link to the record-edit action passed to FormEngine::
|
||||
*
|
||||
* <be:link.editRecord uid="42" table="a_table" returnUrl="foo/bar" />
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[a_table][42]=edit&returnUrl=foo/bar">
|
||||
* Edit record
|
||||
* </a>
|
||||
*
|
||||
* Link to edit page uid=3 and then return back to the BE module "web_MyextensionList"::
|
||||
*
|
||||
* <be:link.editRecord uid="3" table="pages" returnUrl="{f:be.uri(route: 'web_MyextensionList')}">
|
||||
*
|
||||
* Link to edit only the fields title and subtitle of page uid=42 and return to foo/bar::
|
||||
*
|
||||
* <be:link.editRecord uid="42" table="pages" fields="title,subtitle" returnUrl="foo/bar">
|
||||
* Edit record
|
||||
* </be:link.editRecord>
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[pages][42]=edit&returnUrl=foo/bar&columnsOnly[pages]=title,subtitle">
|
||||
* Edit record
|
||||
* </a>
|
||||
*
|
||||
* @see https://docs.typo3.org/permalink/t3viewhelper:typo3-backend-link-editrecord
|
||||
*/
|
||||
final class EditRecordViewHelper extends AbstractTagBasedViewHelper
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $tagName = 'a';
|
||||
|
||||
public function __construct(
|
||||
private readonly UriBuilder $uriBuilder
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
public function initializeArguments(): void
|
||||
{
|
||||
parent::initializeArguments();
|
||||
$this->registerArgument('uid', 'int', 'uid of record to be edited', true);
|
||||
$this->registerArgument('table', 'string', 'target database table', true);
|
||||
$this->registerArgument('fields', 'string', 'Edit only these fields (comma separated list)');
|
||||
$this->registerArgument('module', 'string', 'Set module identifier for context - marking as active when editing the record', false, '');
|
||||
$this->registerArgument('returnUrl', 'string', 'return to this URL after closing the edit dialog', false, '');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \InvalidArgumentException
|
||||
* @throws RouteNotFoundException
|
||||
*/
|
||||
public function render(): string
|
||||
{
|
||||
if ($this->arguments['uid'] < 1) {
|
||||
throw new InvalidArgumentValueException('Uid must be a positive integer, ' . $this->arguments['uid'] . ' given.', 1526127158);
|
||||
}
|
||||
$request = $this->renderingContext->hasAttribute(ServerRequestInterface::class)
|
||||
? $this->renderingContext->getAttribute(ServerRequestInterface::class) : null;
|
||||
|
||||
if (empty($this->arguments['returnUrl']) && $request !== null) {
|
||||
// @todo: We may want to deprecate fetching returnUrl from request
|
||||
$this->arguments['returnUrl'] = $request->getAttribute('normalizedParams')->getRequestUri();
|
||||
}
|
||||
|
||||
$params = [
|
||||
'edit' => [$this->arguments['table'] => [$this->arguments['uid'] => 'edit']],
|
||||
'module' => ($this->arguments['module'] ?? '') ?: ($request?->getAttribute('module')?->getIdentifier() ?? ''),
|
||||
'returnUrl' => $this->arguments['returnUrl'],
|
||||
];
|
||||
if ($this->arguments['fields'] ?? false) {
|
||||
$params['columnsOnly'] = [
|
||||
$this->arguments['table'] => GeneralUtility::trimExplode(',', $this->arguments['fields'], true),
|
||||
];
|
||||
}
|
||||
$uri = (string)$this->uriBuilder->buildUriFromRoute('record_edit', $params);
|
||||
$this->tag->addAttribute('href', $uri);
|
||||
$this->tag->setContent((string)$this->renderChildren());
|
||||
$this->tag->forceClosingTag(true);
|
||||
return $this->tag->render();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user