[TASK] Deprecate DocumentTemplate->extJScode property 10/52210/2
authorBenni Mack <benni@typo3.org>
Tue, 28 Mar 2017 10:34:00 +0000 (12:34 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Tue, 28 Mar 2017 16:01:56 +0000 (18:01 +0200)
The public property DocumentTemplate->extJScode can be used to fill in
ExtJS-specific code to be loaded on "onExtReady". The functionality is not
used in the core anymore, as there are better ways to include JavaScript
code in a backend response.

Resolves: #80512
Releases: master
Change-Id: I4cf24f6b096a79d76e1d30f587f25dcc8ca10fa4
Reviewed-on: https://review.typo3.org/52210
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Thomas Hohn <thomas@hohn.dk>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/backend/Classes/Template/DocumentTemplate.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-80512-DocumentTemplate-extJScodeProperty.rst [new file with mode: 0644]

index 9d736a6..451ea2c 100644 (file)
@@ -60,6 +60,7 @@ class DocumentTemplate
      * Additional header code for ExtJS. It will be included in document header and inserted in a Ext.onReady(function()
      *
      * @var string
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, use PageRenderers's JS methods to inject JavaScript on a backend page.
      */
     public $extJScode = '';
 
@@ -604,6 +605,7 @@ function jumpToUrl(URL) {
         }
 
         if ($this->extJScode) {
+            GeneralUtility::deprecationLog('The property DocumentTemplate->extJScode to add ExtJS-based onReadyCode is deprecated since TYPO3 v8, and will be removed in TYPO3 v9. Use the page renderer directly instead to add JavaScript code.');
             $this->pageRenderer->addExtOnReadyCode($this->extJScode);
         }
 
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80512-DocumentTemplate-extJScodeProperty.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80512-DocumentTemplate-extJScodeProperty.rst
new file mode 100644 (file)
index 0000000..6331b54
--- /dev/null
@@ -0,0 +1,34 @@
+.. include:: ../../Includes.txt
+
+==========================================================
+Deprecation: #80512 - DocumentTemplate->extJScode property
+==========================================================
+
+See :issue:`80512`
+
+Description
+===========
+
+The property php:`DocumentTemplate->extJScode` to load ExtJS-specific code "onExtJSReady"
+has been marked as deprecated.
+
+
+Impact
+======
+
+If the property is filled and added to the response output, a deprecation warning will be triggered.
+
+
+Affected Installations
+======================
+
+Any installation with custom extensions using (or mis-using) this property to inject ExtJS-specific
+code.
+
+
+Migration
+=========
+
+Use the PageRenderer object directly to inject `addExtOnReadyCode` in a backend response.
+
+.. index:: Backend, PHP-API
\ No newline at end of file