[TASK] Add clarification for link.editRecord ViewHelper 71/60571/3
authorSybille Peters <sypets@gmx.de>
Fri, 26 Apr 2019 12:06:40 +0000 (14:06 +0200)
committerSusanne Moog <look@susi.dev>
Sat, 27 Apr 2019 16:59:55 +0000 (18:59 +0200)
Resolves: #88223
Releases: master, 9.5
Change-Id: Ib6d13fcbfa4de1c0e28b6af95a26ec9fc90c4387
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/60571
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Susanne Moog <look@susi.dev>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Susanne Moog <look@susi.dev>
typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php

index 1d96544..237b9bf 100644 (file)
@@ -38,6 +38,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *    <a href="/typo3/index.php?route=/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')}">
  */
 class EditRecordViewHelper extends AbstractTagBasedViewHelper
 {
@@ -52,7 +56,7 @@ class EditRecordViewHelper extends AbstractTagBasedViewHelper
         $this->registerUniversalTagAttributes();
         $this->registerArgument('uid', 'int', 'uid of record to be edited', true);
         $this->registerArgument('table', 'string', 'target database table', true);
-        $this->registerArgument('returnUrl', 'string', '', false, '');
+        $this->registerArgument('returnUrl', 'string', 'return to this URL after closing the edit dialog', false, '');
     }
 
     /**
index cc12c66..a1286d7 100644 (file)
@@ -71,6 +71,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
  *      Edit 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">
  */
 class NewRecordViewHelper extends AbstractTagBasedViewHelper
 {
@@ -86,7 +90,7 @@ class NewRecordViewHelper extends AbstractTagBasedViewHelper
         $this->registerArgument('uid', 'int', 'uid < 0 will insert the record after the given uid', false);
         $this->registerArgument('pid', 'int', 'the page id where the record will be created', false);
         $this->registerArgument('table', 'string', 'target database table', true);
-        $this->registerArgument('returnUrl', 'string', '', false, '');
+        $this->registerArgument('returnUrl', 'string', 'return to this URL after closing the edit dialog', false, '');
     }
 
     /**