From 16e41e7a5c0aac35eb22048181508c3d858e8e3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Chris=20M=C3=BCller?= <2566282+brotkrueml@users.noreply.github.com> Date: Mon, 11 Mar 2024 20:31:45 +0100 Subject: [PATCH 1/3] [TASK] Revise DataHandler introduction Releases: main, 12.4, 11.5 --- .../DataHandler/Introduction/Index.rst | 45 ++++++++++--------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/Documentation/ApiOverview/DataHandler/Introduction/Index.rst b/Documentation/ApiOverview/DataHandler/Introduction/Index.rst index 95669e8236..67d207bfd9 100644 --- a/Documentation/ApiOverview/DataHandler/Introduction/Index.rst +++ b/Documentation/ApiOverview/DataHandler/Introduction/Index.rst @@ -1,31 +1,32 @@ -.. include:: /Includes.rst.txt -.. _tce-introduction: +.. include:: /Includes.rst.txt +.. _tce-introduction: +.. _datahandler-introduction: ============ Introduction ============ - -.. index:: - pair: DataHandler; Database - pair: DataHandler; TCA -.. _tce-database: +.. index:: + pair: DataHandler; Database + pair: DataHandler; TCA +.. _tce-database: +.. _datahandler-database: Database ======== -The TYPO3 Core engine is the class that handles *all* ***data*** -*writing to database tables configured in $TCA*. In addition the -class handles **commands** such as copy, move, delete. It will handle +The DataHandler is the class that handles **all** :ref:`data ` +writing to database tables configured in TCA. In addition the class handles +:ref:`commands ` such as copy, move, delete. It will handle undo/history and versioning of records and everything will be logged -to the sys\_log. And it will make sure that write permissions are -evaluated correctly for the user trying to write to the database. -Generally, any processing specific option in the $TCA array is handled +to the `sys_log` table. It will make sure that write permissions are +evaluated correctly for the user trying to write to the database. Generally, +any processing specific option in the `$GLOBALS['TCA']` array is handled by DataHandler. -Using DataHandler for manipulation of the database content in the $TCA-configured +Using DataHandler for manipulation of the database content in the TCA-configured tables guarantees that the data integrity of TYPO3 is -respected. This cannot be safely guaranteed if you write to $TCA-configured +respected. This cannot be safely guaranteed, if you write to TCA-configured database tables directly. It will also manage the relations to files and other records. @@ -35,19 +36,19 @@ to evaluate against. This means you cannot use DataHandler from the frontend scope. Thus writing to tables (such as a guestbook) will have to be done from the frontend *without* DataHandler. -The features of the $TCA are described in the :ref:`TCA Reference `. - +.. seealso:: + The features of TCA are described in the :ref:`TCA Reference `. -.. index:: pair: DataHandler; Files -.. _tce-files: +.. index:: pair: DataHandler; Files +.. _tce-files: +.. _datahandler-files: Files ===== -DataHandler also has a part for handling files. The file operations are -normally performed in the :guilabel:`File > Filelist` module where you can manage a +DataHandler can also handle files. The file operations are normally +performed in the :guilabel:`File > Filelist` module where you can manage a directory on the server by copying, moving, deleting and editing files and directories. The file operations are managed by two Core classes, :php:`\TYPO3\CMS\Core\Utility\File\BasicFileUtility` and :php:`\TYPO3\CMS\Core\Utility\File\ExtendedFileUtility`. - From 72ceec452cc612054f57a34b3332017a121de7cd Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Tue, 12 Mar 2024 19:23:40 +0100 Subject: [PATCH 2/3] Update Documentation/ApiOverview/DataHandler/Introduction/Index.rst Co-authored-by: Garvin Hicking --- Documentation/ApiOverview/DataHandler/Introduction/Index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ApiOverview/DataHandler/Introduction/Index.rst b/Documentation/ApiOverview/DataHandler/Introduction/Index.rst index 67d207bfd9..0834346cdc 100644 --- a/Documentation/ApiOverview/DataHandler/Introduction/Index.rst +++ b/Documentation/ApiOverview/DataHandler/Introduction/Index.rst @@ -19,7 +19,7 @@ The DataHandler is the class that handles **all** :ref:`data ` writing to database tables configured in TCA. In addition the class handles :ref:`commands ` such as copy, move, delete. It will handle undo/history and versioning of records and everything will be logged -to the `sys_log` table. It will make sure that write permissions are +to the :sql:`sys_log` table. It will make sure that write permissions are evaluated correctly for the user trying to write to the database. Generally, any processing specific option in the `$GLOBALS['TCA']` array is handled by DataHandler. From d2b100982bf93fa5ee7bc1f8182c3ca04c69d9d4 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Tue, 12 Mar 2024 19:23:46 +0100 Subject: [PATCH 3/3] Update Documentation/ApiOverview/DataHandler/Introduction/Index.rst Co-authored-by: Garvin Hicking --- Documentation/ApiOverview/DataHandler/Introduction/Index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ApiOverview/DataHandler/Introduction/Index.rst b/Documentation/ApiOverview/DataHandler/Introduction/Index.rst index 0834346cdc..1316aecc67 100644 --- a/Documentation/ApiOverview/DataHandler/Introduction/Index.rst +++ b/Documentation/ApiOverview/DataHandler/Introduction/Index.rst @@ -21,7 +21,7 @@ writing to database tables configured in TCA. In addition the class handles undo/history and versioning of records and everything will be logged to the :sql:`sys_log` table. It will make sure that write permissions are evaluated correctly for the user trying to write to the database. Generally, -any processing specific option in the `$GLOBALS['TCA']` array is handled +any processing specific option in the :php:`$GLOBALS['TCA']` array is handled by DataHandler. Using DataHandler for manipulation of the database content in the TCA-configured