TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,161 @@
|
||||
<?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 TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
|
||||
use TYPO3Fluid\Fluid\Core\ViewHelper\InvalidArgumentException;
|
||||
use TYPO3Fluid\Fluid\Core\ViewHelper\InvalidArgumentValueException;
|
||||
|
||||
/**
|
||||
* Use this ViewHelper to provide 'create new record' links.
|
||||
* The ViewHelper will pass the command to FormEngine.
|
||||
*
|
||||
* The table argument is mandatory, it decides what record is to be created.
|
||||
*
|
||||
* The pid argument will put the new record on this page, if ``0`` given it will
|
||||
* be placed to the root page.
|
||||
*
|
||||
* The uid argument accepts only negative values. If this is given, the new
|
||||
* record will be placed (by sorting field) behind the record with the uid.
|
||||
* It will end up on the same pid as this given record, so the pid must not
|
||||
* be given explicitly by pid argument.
|
||||
*
|
||||
* An exception will be thrown, if both uid and pid are given.
|
||||
* An exception will be thrown, if the uid argument is not a negative integer.
|
||||
*
|
||||
* To edit records, use the :ref:`<be:link.editRecordViewHelper> <typo3-backend-link-editrecord>`.
|
||||
*
|
||||
* Examples
|
||||
* ========
|
||||
*
|
||||
* Link to create a new record of a_table after record 17 on the same pid::
|
||||
*
|
||||
* <be:link.newRecord table="a_table" returnUrl="foo/bar" uid="-17"/>
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[a_table][-17]=new&returnUrl=foo/bar">
|
||||
* New record
|
||||
* </a>
|
||||
*
|
||||
* Link to create a new record of a_table on root page::
|
||||
*
|
||||
* <be:link.newRecord table="a_table" returnUrl="foo/bar""/>
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[a_table][]=new&returnUrl=foo/bar">
|
||||
* New record
|
||||
* </a>
|
||||
*
|
||||
* Link to create a new record of a_table on page 17::
|
||||
*
|
||||
* <be:link.newRecord table="a_table" returnUrl="foo/bar" pid="17"/>
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[a_table][17]=new&returnUrl=foo/bar">
|
||||
* New record
|
||||
* </a>
|
||||
*
|
||||
* Link to create a new record then return back to the BE module "web_MyextensionList"::
|
||||
*
|
||||
* <be:link.newRecord table="a_table" returnUrl="{f:be.uri(route: 'web_MyextensionList')}" pid="17">
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[a_table][17]=new&returnUrl=/typo3/module/web/MyextensionList">
|
||||
* New record
|
||||
* </a>
|
||||
*
|
||||
* Link to create a new record of a_table on page 17 with a default value::
|
||||
*
|
||||
* <be:link.newRecord table="a_table" returnUrl="foo/bar" pid="17" defaultValues="{a_table: {a_field: 'value'}}">
|
||||
*
|
||||
* Output::
|
||||
*
|
||||
* <a href="/typo3/record/edit?edit[a_table][17]=new&returnUrl=foo/bar&defVals[a_table][a_field]=value">
|
||||
* New record
|
||||
* </a>
|
||||
*
|
||||
* @see https://docs.typo3.org/permalink/t3viewhelper:typo3-backend-link-newrecord
|
||||
*/
|
||||
final class NewRecordViewHelper 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 < 0 will insert the record after the given uid');
|
||||
$this->registerArgument('pid', 'int', 'the page id where the record will be created');
|
||||
$this->registerArgument('table', 'string', 'target database table', true);
|
||||
$this->registerArgument('module', 'string', 'Set module identifier for context - marking as acitve when editing the record', false, '');
|
||||
$this->registerArgument('returnUrl', 'string', 'return to this URL after closing the new record dialog', false, '');
|
||||
$this->registerArgument('defaultValues', 'array', 'default values for fields of the new record', false, []);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidArgumentException
|
||||
* @throws RouteNotFoundException
|
||||
*/
|
||||
public function render(): string
|
||||
{
|
||||
if ($this->arguments['uid'] && $this->arguments['pid']) {
|
||||
throw new InvalidArgumentException('Can\'t handle both uid and pid for new records', 1526129969);
|
||||
}
|
||||
if (isset($this->arguments['uid']) && $this->arguments['uid'] >= 0) {
|
||||
throw new InvalidArgumentValueException('Uid must be negative integer, ' . $this->arguments['uid'] . ' given', 1526134901);
|
||||
}
|
||||
|
||||
$request = $this->renderingContext->hasAttribute(ServerRequestInterface::class)
|
||||
? $this->renderingContext->getAttribute(ServerRequestInterface::class) : null;
|
||||
if (empty($this->arguments['returnUrl']) && $request !== null) {
|
||||
$this->arguments['returnUrl'] = $request->getAttribute('normalizedParams')->getRequestUri();
|
||||
}
|
||||
|
||||
$params = [
|
||||
'edit' => [$this->arguments['table'] => [$this->arguments['uid'] ?? $this->arguments['pid'] ?? 0 => 'new']],
|
||||
// @todo add module argument to this view helper
|
||||
'module' => ($this->arguments['module'] ?? '') ?: ($request?->getAttribute('module')?->getIdentifier() ?? ''),
|
||||
'returnUrl' => $this->arguments['returnUrl'],
|
||||
];
|
||||
|
||||
if ($this->arguments['defaultValues']) {
|
||||
$params['defVals'] = $this->arguments['defaultValues'];
|
||||
}
|
||||
|
||||
$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