Skip to content

Commit 45c4514

Browse files
authored
[!!!][TASK] Remove deprecated DatabaseRecordList CSV hooks (TYPO3-Documentation#4916)
1 parent 80bad33 commit 45c4514

File tree

1 file changed

+1
-49
lines changed

1 file changed

+1
-49
lines changed

Documentation/ApiOverview/Events/Events/Backend/BeforeRecordDownloadIsExecutedEvent.rst

+1-49
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ BeforeRecordDownloadIsExecutedEvent
1111
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList']['customizeCsvHeader']`
1212
and
1313
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList']['customizeCsvRow']`,
14-
hooks, which have been deprecated with TYPO3 v13.2. See also
15-
:ref:`BeforeRecordDownloadIsExecutedEvent-migration`.
14+
hooks, which have been deprecated with TYPO3 v13.2.
1615

1716
The event :php:`TYPO3\CMS\Backend\RecordList\Event\BeforeRecordDownloadIsExecutedEvent`
1817
can be used to modify the result of a download / export initiated via
@@ -38,50 +37,3 @@ API of BeforeRecordDownloadIsExecutedEvent
3837
==========================================
3938

4039
.. include:: /CodeSnippets/Events/Backend/BeforeRecordDownloadIsExecutedEvent.rst.txt
41-
42-
.. _BeforeRecordDownloadIsExecutedEvent-migration:
43-
44-
Migration
45-
=========
46-
47-
.. deprecated:: 13.2
48-
The previously used hooks
49-
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList']['customizeCsvHeader']`
50-
and
51-
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList']['customizeCsvRow']`,
52-
used to manipulate the download / export configuration of records, triggered
53-
in the :guilabel:`Web > List` backend module, have been deprecated in favor of a
54-
new PSR-14 event :php:`TYPO3\CMS\Backend\RecordList\Event\BeforeRecordDownloadIsExecutedEvent`.
55-
56-
.. _BeforeRecordDownloadIsExecutedEvent-migration-customizeCsvHeader:
57-
58-
Migrating :php:`customizeCsvHeader`
59-
-----------------------------------
60-
61-
The prior hook parameter/variable :php:`fields` is now available via
62-
:php:`$event->getColumnsToRender()`. The actual record data
63-
(previously :php:`$this->recordList`, submitted to the hook as its object
64-
reference) is accessible via :php:`$event->getHeaderRow()`.
65-
66-
.. _BeforeRecordDownloadIsExecutedEvent-migration-customizeCsvRow:
67-
68-
Migrating :php:`customizeCsvRow`
69-
--------------------------------
70-
71-
The following prior hook parameters/variables have these substitutes:
72-
73-
:php:`databaseRow`
74-
is now available via :php:`$event->getRecords()` (see note below).
75-
:php:`tableName`
76-
is now available via :php:`$event->getTable()`.
77-
:php:`pageId`
78-
is now available via :php:`$event->getId()`.
79-
80-
The actual record data
81-
(previously :php:`$this->recordList`, submitted to the hook as its object
82-
reference) is accessible via :php:`$event->getRecords()`.
83-
84-
Please note that the hook was previously executed once per row retrieved
85-
from the database. The PSR-14 event however - due to performance reasons -
86-
is only executed for the full record list after database retrieval,
87-
thus allows post-processing on this whole dataset.

0 commit comments

Comments
 (0)