From 1965d49b987ebeb084865175e2226c5a31d1ca9b Mon Sep 17 00:00:00 2001
From: jpmschuler <noreply@example.com>
Date: Thu, 26 Mar 2020 14:33:15 +0000
Subject: [PATCH] [DOCS] Clarify what to avoid in checks on TYPO3_MODE
With regards to
https://typo3.slack.com/archives/C025BQLFA/p1585231067123500 there seems
to be confusion in the paragraph about avoiding checks on TYPO3_MODE if
`defined('TYPO3_MODE') or die();` should be used or if that is forbidden
as well.
Releases: master
Resolves: #90843
Change-Id: If1ef849a72bd0aa5337c5c6e8758e69a2f53164b
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/63934
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Daniel Siepmann <coding@daniel-siepmann.de>
Reviewed-by: Susanne Moog <look@susi.dev>
Reviewed-by: Daniel Siepmann <coding@daniel-siepmann.de>
---
.../9.0/Important-82692-GuidelinesForExtensionFiles.rst | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/typo3/sysext/core/Documentation/Changelog/9.0/Important-82692-GuidelinesForExtensionFiles.rst b/typo3/sysext/core/Documentation/Changelog/9.0/Important-82692-GuidelinesForExtensionFiles.rst
index fc00d7f8904a..ef3fc626c1bc 100644
--- a/typo3/sysext/core/Documentation/Changelog/9.0/Important-82692-GuidelinesForExtensionFiles.rst
+++ b/typo3/sysext/core/Documentation/Changelog/9.0/Important-82692-GuidelinesForExtensionFiles.rst
@@ -50,11 +50,10 @@ These are the typical functions that should be placed inside :file:`ext_tables.p
Additionally, it is possible to extend TYPO3 in a lot of different ways (adding TCA, Backend Routes,
Symfony Console Commands etc) which do not need to touch these files.
-It is heavily recommended to AVOID any checks on :php:`TYPO3_MODE` or :php:`TYPO3_REQUESTTYPE` constants
-(e.g. `if(TYPO3_MODE === 'BE')`) within these files as it limits the functionality to cache the
+It is heavily recommended to AVOID checks on :php:`TYPO3_MODE` or :php:`TYPO3_REQUESTTYPE` constants which differentiate between contexts (e.g. :php:`if(TYPO3_MODE === 'BE')`) within these files as it limits the functionality to cache the
whole systems' configuration. Any extension author should remove the checks if not explicitly
necessary, and re-evaluate if these context-depending checks could go inside the hooks / caller
-function directly.
+function directly. However a check, which isn't context-depending and only checks for TYPO3 like :php:`defined('TYPO3_MODE') or die();` is no problem.
Additionally, it is recommend to use the extension name (e.g. "tt_address") instead of :php:`$_EXTKEY`
within the two configuration files as this variable will be removed in the future. This also applies
@@ -65,4 +64,4 @@ However, due to limitations to TER, the :php:`$_EXTKEY` option should be kept wi
See any system extension for best practice on this behaviour.
-.. index:: PHP-API
\ No newline at end of file
+.. index:: PHP-API
--
GitLab