From 5fe67e8b9a0454a18572f7df5844ac1910197ec6 Mon Sep 17 00:00:00 2001
From: Benni Mack <benni@typo3.org>
Date: Wed, 29 Mar 2023 15:02:25 +0200
Subject: [PATCH] [TASK] Deprecate BackendUtility::getRecordToolTip()
This method is just a wrapper for a title=""
attribute and is very inflexible. Thus, it is marked
as deprecated.
Resolves: #100459
Releases: main
Change-Id: Ic8e7f5fca9176fdf76a9723a702705dd4fce56b5
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/78321
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Oliver Bartsch <bo@cedev.de>
Tested-by: core-ci <typo3@b13.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Oliver Bartsch <bo@cedev.de>
---
.../ContentElement/MoveElementController.php | 4 +-
.../Classes/RecordList/DatabaseRecordList.php | 2 +-
.../Template/Components/MetaInformation.php | 3 +-
.../View/ContentCreationPagePositionMap.php | 4 +-
.../View/ContentMovingPagePositionMap.php | 2 +-
.../Classes/Tree/View/PagePositionMap.php | 5 +-
.../Classes/Utility/BackendUtility.php | 2 +
.../BackendLayout/Grid/GridColumnItem.php | 3 +-
.../Templates/ContentElement/MoveElement.html | 4 +-
...-100459-BackendUtilitygetRecordToolTip.rst | 50 +++++++++++++++++++
.../Controller/PageInformationController.php | 3 +-
.../Php/MethodCallStaticMatcher.php | 7 +++
12 files changed, 73 insertions(+), 16 deletions(-)
create mode 100644 typo3/sysext/core/Documentation/Changelog/12.4/Deprecation-100459-BackendUtilitygetRecordToolTip.rst
diff --git a/typo3/sysext/backend/Classes/Controller/ContentElement/MoveElementController.php b/typo3/sysext/backend/Classes/Controller/ContentElement/MoveElementController.php
index 33f19a411122..ea4bc710bac6 100644
--- a/typo3/sysext/backend/Classes/Controller/ContentElement/MoveElementController.php
+++ b/typo3/sysext/backend/Classes/Controller/ContentElement/MoveElementController.php
@@ -93,7 +93,7 @@ class MoveElementController
// Headerline: Icon, record title:
$assigns['table'] = $this->table;
$assigns['elRow'] = $elRow;
- $assigns['recordTooltip'] = BackendUtility::getRecordToolTip($elRow, $this->table);
+ $assigns['recordTooltip'] = BackendUtility::getRecordIconAltText($elRow, $this->table);
$assigns['recordTitle'] = BackendUtility::getRecordTitle($this->table, $elRow, true);
// Make-copy checkbox (clicking this will reload the page with the GET var makeCopy set differently):
$assigns['makeCopyChecked'] = (bool)$this->makeCopy;
@@ -137,7 +137,7 @@ class MoveElementController
$contentPositionMap->cur_sys_language = $this->sys_language;
$contentPositionMap->R_URI = $this->R_URI;
// Headerline for the parent page: Icon, record title:
- $assigns['ttContent']['recordTooltip'] = BackendUtility::getRecordToolTip($pageInfo);
+ $assigns['ttContent']['recordTooltip'] = BackendUtility::getRecordIconAltText($pageInfo, 'pages');
$assigns['ttContent']['recordTitle'] = BackendUtility::getRecordTitle('pages', $pageInfo, true);
// Adding parent page-header and the content element columns from position-map:
$assigns['contentElementColumns'] = $contentPositionMap->printContentElementColumns($this->page_id);
diff --git a/typo3/sysext/backend/Classes/RecordList/DatabaseRecordList.php b/typo3/sysext/backend/Classes/RecordList/DatabaseRecordList.php
index 2ace33a83b6b..b0bd4a8abcb9 100644
--- a/typo3/sysext/backend/Classes/RecordList/DatabaseRecordList.php
+++ b/typo3/sysext/backend/Classes/RecordList/DatabaseRecordList.php
@@ -1024,7 +1024,7 @@ class DatabaseRecordList
}
} elseif ($fCol === 'icon') {
$iconImg = '
- <span ' . BackendUtility::getRecordToolTip($row, $table) . ' ' . ($indent ? ' style="margin-left: ' . $indent . 'px;"' : '') . '>
+ <span title="' . BackendUtility::getRecordIconAltText($row, $table) . '" ' . ($indent ? ' style="margin-left: ' . $indent . 'px;"' : '') . '>
' . $this->iconFactory->getIconForRecord($table, $row, Icon::SIZE_SMALL)->render() . '
</span>';
$theData[$fCol] = ($this->clickMenuEnabled && !$this->isRecordDeletePlaceholder($row)) ? BackendUtility::wrapClickMenuOnIcon($iconImg, $table, $row['uid']) : $iconImg;
diff --git a/typo3/sysext/backend/Classes/Template/Components/MetaInformation.php b/typo3/sysext/backend/Classes/Template/Components/MetaInformation.php
index 33e0f5769ed9..61279b1830e4 100644
--- a/typo3/sysext/backend/Classes/Template/Components/MetaInformation.php
+++ b/typo3/sysext/backend/Classes/Template/Components/MetaInformation.php
@@ -225,8 +225,7 @@ class MetaInformation
}
} elseif (is_array($pageRecord) && !empty($pageRecord['uid'])) {
// If there IS a real page
- $toolTip = BackendUtility::getRecordToolTip($pageRecord, 'pages');
- $theIcon = '<span ' . $toolTip . '>' . $iconFactory->getIconForRecord('pages', $pageRecord, Icon::SIZE_SMALL)->render() . '</span>';
+ $theIcon = '<span title="' . BackendUtility::getRecordIconAltText($pageRecord) . '">' . $iconFactory->getIconForRecord('pages', $pageRecord, Icon::SIZE_SMALL)->render() . '</span>';
// Make Icon:
$theIcon = BackendUtility::wrapClickMenuOnIcon($theIcon, 'pages', $pageRecord['uid']);
$uid = $pageRecord['uid'];
diff --git a/typo3/sysext/backend/Classes/Tree/View/ContentCreationPagePositionMap.php b/typo3/sysext/backend/Classes/Tree/View/ContentCreationPagePositionMap.php
index 0e460083cecf..1b38e87681fa 100644
--- a/typo3/sysext/backend/Classes/Tree/View/ContentCreationPagePositionMap.php
+++ b/typo3/sysext/backend/Classes/Tree/View/ContentCreationPagePositionMap.php
@@ -92,7 +92,7 @@ class ContentCreationPagePositionMap extends AbstractContentPagePositionMap
}
return '
- <button type="button" class="btn btn-link" data-target="' . htmlspecialchars($target) . '" title="' . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:insertNewRecordHere')) . '">
+ <button type="button" class="btn btn-link" data-target="' . htmlspecialchars($target) . '" title="' . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:insertNewRecordHere')) . '">
' . $this->iconFactory->getIcon('actions-arrow-left-alt', Icon::SIZE_SMALL)->render() . '
</button>';
}
@@ -103,7 +103,7 @@ class ContentCreationPagePositionMap extends AbstractContentPagePositionMap
protected function getRecordHeader(array $row): string
{
return '
- <span class="py-2" ' . BackendUtility::getRecordToolTip($row, 'tt_content') . '>
+ <span class="py-2" title="' . BackendUtility::getRecordIconAltText($row, 'tt_content') . '">
' . $this->iconFactory->getIconForRecord('tt_content', $row, Icon::SIZE_SMALL)->render() . '
' . BackendUtility::getRecordTitle('tt_content', $row, true) . '
</span>';
diff --git a/typo3/sysext/backend/Classes/Tree/View/ContentMovingPagePositionMap.php b/typo3/sysext/backend/Classes/Tree/View/ContentMovingPagePositionMap.php
index 89899f62b4d0..a1013479c4cd 100644
--- a/typo3/sysext/backend/Classes/Tree/View/ContentMovingPagePositionMap.php
+++ b/typo3/sysext/backend/Classes/Tree/View/ContentMovingPagePositionMap.php
@@ -87,7 +87,7 @@ class ContentMovingPagePositionMap extends AbstractContentPagePositionMap
protected function getRecordHeader(array $row): string
{
return '
- <span class="py-2" ' . BackendUtility::getRecordToolTip($row, 'tt_content') . '>
+ <span class="py-2" title="' . BackendUtility::getRecordIconAltText($row, 'tt_content') . '">
' . $this->iconFactory->getIconForRecord('tt_content', $row, Icon::SIZE_SMALL)->render() . '
' . ($this->moveUid === (int)$row['uid'] ? '<strong>' : '') . '
' . BackendUtility::getRecordTitle('tt_content', $row, true) . '
diff --git a/typo3/sysext/backend/Classes/Tree/View/PagePositionMap.php b/typo3/sysext/backend/Classes/Tree/View/PagePositionMap.php
index e1e6def70016..7ce76558b36a 100644
--- a/typo3/sysext/backend/Classes/Tree/View/PagePositionMap.php
+++ b/typo3/sysext/backend/Classes/Tree/View/PagePositionMap.php
@@ -176,8 +176,9 @@ class PagePositionMap
$lines[] = '<span class="text-nowrap"><a href="' . htmlspecialchars($this->getActionLink($prevPid, $dat['row']['pid'])) . '" title="' . $this->insertlabel() . '">' . $this->iconFactory->getIcon('actions-arrow-left-alt', Icon::SIZE_SMALL)->render() . '</a></span>';
}
// The line with the icon and title:
- $toolTip = BackendUtility::getRecordToolTip($dat['row'], 'pages');
- $icon = '<span ' . $toolTip . '>' . $this->iconFactory->getIconForRecord('pages', $dat['row'], Icon::SIZE_SMALL)->render() . '</span>';
+ $icon = '<span title="' . BackendUtility::getRecordIconAltText($dat['row'], 'pages') . '">'
+ . $this->iconFactory->getIconForRecord('pages', $dat['row'], Icon::SIZE_SMALL)->render()
+ . '</span>';
$lines[] = '<span class="text-nowrap">' . $icon . ' ' . $this->linkPageTitle($this->boldTitle(htmlspecialchars(GeneralUtility::fixed_lgd_cs($dat['row']['title'], (int)$this->getBackendUser()->uc['titleLen'])), $dat, $id), $dat['row']) . '</span>';
}
diff --git a/typo3/sysext/backend/Classes/Utility/BackendUtility.php b/typo3/sysext/backend/Classes/Utility/BackendUtility.php
index 5b72faea0847..c09ddabc1caa 100644
--- a/typo3/sysext/backend/Classes/Utility/BackendUtility.php
+++ b/typo3/sysext/backend/Classes/Utility/BackendUtility.php
@@ -1200,9 +1200,11 @@ class BackendUtility
*
* @param string $table
* @return string
+ * @deprecated will be removed in TYPO3 v13.0 - use getRecordIconAltText directly
*/
public static function getRecordToolTip(array $row, $table = 'pages')
{
+ trigger_error('BackendUtility::getRecordToolTip() will be removed in TYPO3 v13.0 - use getRecordIconAltText() instead', E_USER_DEPRECATED);
return 'title="' . self::getRecordIconAltText($row, $table) . '"';
}
diff --git a/typo3/sysext/backend/Classes/View/BackendLayout/Grid/GridColumnItem.php b/typo3/sysext/backend/Classes/View/BackendLayout/Grid/GridColumnItem.php
index fc28ae880932..b84904c52cce 100644
--- a/typo3/sysext/backend/Classes/View/BackendLayout/Grid/GridColumnItem.php
+++ b/typo3/sysext/backend/Classes/View/BackendLayout/Grid/GridColumnItem.php
@@ -174,8 +174,7 @@ class GridColumnItem extends AbstractGridObject
$row = $this->record;
$icons = [];
- $toolTip = BackendUtility::getRecordToolTip($row, $table);
- $icon = '<span ' . $toolTip . '>' . $this->iconFactory->getIconForRecord($table, $row, Icon::SIZE_SMALL)->render() . '</span>';
+ $icon = '<span title="' . BackendUtility::getRecordIconAltText($row, $table) . '">' . $this->iconFactory->getIconForRecord($table, $row, Icon::SIZE_SMALL)->render() . '</span>';
if ($this->getBackendUser()->recordEditAccessInternals($table, $row)) {
$icon = BackendUtility::wrapClickMenuOnIcon($icon, $table, $row['uid']);
}
diff --git a/typo3/sysext/backend/Resources/Private/Templates/ContentElement/MoveElement.html b/typo3/sysext/backend/Resources/Private/Templates/ContentElement/MoveElement.html
index 30fc365a7a60..8259f5c09f25 100644
--- a/typo3/sysext/backend/Resources/Private/Templates/ContentElement/MoveElement.html
+++ b/typo3/sysext/backend/Resources/Private/Templates/ContentElement/MoveElement.html
@@ -10,7 +10,7 @@
<h1><f:translate key="LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:movingElement" /></h1>
<h3 class="mb-2">
- <span {recordTooltip -> f:format.raw()}><core:iconForRecord table="{table}" row="{elRow}" /></span>
+ <span title="{recordTooltip -> f:format.raw()}"><core:iconForRecord table="{table}" row="{elRow}" /></span>
{recordTitle -> f:format.raw()}
</h3>
<div class="pt-2">
@@ -37,7 +37,7 @@
</f:if>
<f:if condition="{table} == 'tt_content'">
<f:if condition="{pageInfo}">
- <span {ttContent.recordTooltip -> f:format.raw()}><core:iconForRecord table="pages" row="{pageInfo}" /></span>
+ <span title="{ttContent.recordTooltip -> f:format.raw()}"><core:iconForRecord table="pages" row="{pageInfo}" /></span>
</f:if>
{ttContent.recordTitle}<br />
{contentElementColumns -> f:format.raw()}<br />
diff --git a/typo3/sysext/core/Documentation/Changelog/12.4/Deprecation-100459-BackendUtilitygetRecordToolTip.rst b/typo3/sysext/core/Documentation/Changelog/12.4/Deprecation-100459-BackendUtilitygetRecordToolTip.rst
new file mode 100644
index 000000000000..ea4fe53bced8
--- /dev/null
+++ b/typo3/sysext/core/Documentation/Changelog/12.4/Deprecation-100459-BackendUtilitygetRecordToolTip.rst
@@ -0,0 +1,50 @@
+.. include:: /Includes.rst.txt
+
+.. _deprecation-100459-1680683235:
+
+=========================================================
+Deprecation: #100459 - BackendUtility::getRecordToolTip()
+=========================================================
+
+See :issue:`100459`
+
+Description
+===========
+
+The method :php:`TYPO3\CMS\Backend\Utility\BackendUtility::getRecordToolTip()`
+has been marked as deprecated.
+
+
+Impact
+======
+
+Calling this method will trigger a PHP deprecation warning.
+
+
+Affected installations
+======================
+
+TYPO3 installations with custom extensions using this method. This is usually
+the case for old installations where Fluid templates or Extbase backend modules
+were not common.
+
+
+Migration
+=========
+
+As this method is just a wrapper around :php:`BackendUtility::getRecordIconAltText()`
+with a "title" attribute for the markup, the replacement is straightforward:
+
+Before:
+
+.. code-block:: php
+
+ $link = '<a href="..." ' . BackendUtility::getRecordToolTip(...) . '>my link</a>';
+
+After:
+
+.. code-block:: php
+
+ $link = '<a href="..." title="' . BackendUtility::getRecordIconAltText(...) . '">my link</a>';
+
+.. index:: Backend, PHP-API, FullyScanned, ext:backend
diff --git a/typo3/sysext/info/Classes/Controller/PageInformationController.php b/typo3/sysext/info/Classes/Controller/PageInformationController.php
index d011395812d2..222b17c27e3b 100644
--- a/typo3/sysext/info/Classes/Controller/PageInformationController.php
+++ b/typo3/sysext/info/Classes/Controller/PageInformationController.php
@@ -422,8 +422,7 @@ class PageInformationController extends InfoModuleController
protected function getIcon(array $row): string
{
// Initialization
- $toolTip = BackendUtility::getRecordToolTip($row);
- $icon = '<span ' . $toolTip . '>' . $this->iconFactory->getIconForRecord('pages', $row, Icon::SIZE_SMALL)->render() . '</span>';
+ $icon = '<span title="' . BackendUtility::getRecordIconAltText($row, 'pages') . '">' . $this->iconFactory->getIconForRecord('pages', $row, Icon::SIZE_SMALL)->render() . '</span>';
// The icon with link
if ($this->getBackendUser()->recordEditAccessInternals('pages', $row)) {
$icon = BackendUtility::wrapClickMenuOnIcon($icon, 'pages', $row['uid']);
diff --git a/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallStaticMatcher.php b/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallStaticMatcher.php
index 843f7f23dedd..d027581975e1 100644
--- a/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallStaticMatcher.php
+++ b/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallStaticMatcher.php
@@ -1471,4 +1471,11 @@ return [
'Deprecation-100053-GeneralUtility_GP.rst',
],
],
+ 'TYPO3\CMS\Backend\Utility\BackendUtility::getRecordToolTip' => [
+ 'numberOfMandatoryArguments' => 1,
+ 'maximumNumberOfArguments' => 2,
+ 'restFiles' => [
+ 'Deprecation-100459-BackendUtilitygetRecordToolTip.rst',
+ ],
+ ],
];
--
GitLab