From 62f2c36f128c596eda04121a4d363b34f5b44ed0 Mon Sep 17 00:00:00 2001
From: Tymoteusz Motylewski <t.motylewski@gmail.com>
Date: Wed, 20 May 2020 00:13:34 +0200
Subject: [PATCH] [TASK] Improve descriptions of the rootline related methods
To highlight difference between BackendUtility::BEgetRootLine()
and RootlineUtility->get()
Resolves: #91455
Releases: 9.5, master
Change-Id: I63d7ca395d5a052d29d718316474b69d6519ebc9
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/64554
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Richard Haeser <richard@maxserv.com>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Richard Haeser <richard@maxserv.com>
---
typo3/sysext/backend/Classes/Utility/BackendUtility.php | 2 +-
typo3/sysext/core/Classes/Utility/RootlineUtility.php | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/typo3/sysext/backend/Classes/Utility/BackendUtility.php b/typo3/sysext/backend/Classes/Utility/BackendUtility.php
index ef793f282e80..eb5612f6e9e2 100644
--- a/typo3/sysext/backend/Classes/Utility/BackendUtility.php
+++ b/typo3/sysext/backend/Classes/Utility/BackendUtility.php
@@ -338,7 +338,7 @@ class BackendUtility
* @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is
* usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
* @param string[] $additionalFields Additional Fields to select for rootline records
- * @return array Root line array, all the way to the page tree root (or as far as $clause allows!)
+ * @return array Root line array, all the way to the page tree root uid=0 (or as far as $clause allows!), including the page given as $uid
*/
public static function BEgetRootLine($uid, $clause = '', $workspaceOL = false, array $additionalFields = [])
{
diff --git a/typo3/sysext/core/Classes/Utility/RootlineUtility.php b/typo3/sysext/core/Classes/Utility/RootlineUtility.php
index 1469595206b6..ac22ce40e662 100644
--- a/typo3/sysext/core/Classes/Utility/RootlineUtility.php
+++ b/typo3/sysext/core/Classes/Utility/RootlineUtility.php
@@ -197,7 +197,7 @@ class RootlineUtility
}
/**
- * Returns the actual rootline
+ * Returns the actual rootline without the tree root (uid=0), including the page with $this->pageUid
*
* @return array
*/
--
GitLab