[TASK] Deprecate printContent methods 57/52157/2
authorFrank Naegler <frank.naegler@typo3.org>
Sat, 25 Mar 2017 20:02:03 +0000 (21:02 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 25 Mar 2017 21:21:32 +0000 (22:21 +0100)
The methods TaskModuleController::printContent() and
PageLayoutController::printContent()  have been marked as deprecated.

Resolves: #80445
Releases: master
Change-Id: Ia79101ca6ff66e7a0896dad930276698791989ce
Reviewed-on: https://review.typo3.org/52157
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Benni Mack <benni@typo3.org>
Tested-by: Benni Mack <benni@typo3.org>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/backend/Classes/Controller/PageLayoutController.php
typo3/sysext/backend/Classes/Module/BaseScriptClass.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-80445-DeprecatePrintContentMethods.rst [new file with mode: 0644]
typo3/sysext/taskcenter/Classes/Controller/TaskModuleController.php

index 7d20a0d..fcf7d08 100644 (file)
@@ -1013,10 +1013,12 @@ class PageLayoutController
     /**
      * Print accumulated content of module
      *
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
      * @return void
      */
     public function printContent()
     {
+        GeneralUtility::logDeprecatedFunction();
         echo $this->moduleTemplate->renderContent();
     }
 
index 7d3b6ad..ddd7f69 100644 (file)
@@ -36,7 +36,7 @@ use TYPO3\CMS\Lang\LanguageService;
  *
  * TYPICAL SETUP OF A BACKEND MODULE:
  *
- * PrototypeController EXTENDS THE CLASS \TYPO3\CMS\Backend\Module\BaseScriptClass with a main() and printContent() function:
+ * PrototypeController EXTENDS THE CLASS \TYPO3\CMS\Backend\Module\BaseScriptClass with a main() function:
  *
  * namespace Vendor\Prototype\Controller;
  *
@@ -54,10 +54,6 @@ use TYPO3\CMS\Lang\LanguageService;
  *     ... AND OF COURSE A LOT OF OTHER THINGS GOES ON - LIKE PUTTING CONTENT INTO $this->content
  *     $this->content='';
  * }
- * PRINT CONTENT - DONE AS THE LAST THING
- * public function printContent() {
- *     echo $this->content;
- * }
  *
  * MAKE INSTANCE OF THE SCRIPT CLASS AND CALL init()
  * $GLOBALS['SOBE'] = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\Vendor\Prototype\Controller\PrototypeController::class);
@@ -69,8 +65,6 @@ use TYPO3\CMS\Lang\LanguageService;
  *
  * THEN WE CALL THE main() METHOD AND THIS SHOULD SPARK THE CREATION OF THE MODULE OUTPUT.
  * $GLOBALS['SOBE']->main();
- * FINALLY THE printContent() FUNCTION WILL OUTPUT THE ACCUMULATED CONTENT
- * $GLOBALS['SOBE']->printContent();
  */
 class BaseScriptClass
 {
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80445-DeprecatePrintContentMethods.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80445-DeprecatePrintContentMethods.rst
new file mode 100644 (file)
index 0000000..6d975a5
--- /dev/null
@@ -0,0 +1,19 @@
+.. include:: ../../Includes.txt
+
+====================================================
+Deprecation: #80445 - Deprecate printContent methods
+====================================================
+
+See :issue:`80445`
+
+Description
+===========
+
+The methods :php:`TaskModuleController::printContent()` and :php:`PageLayoutController::printContent()`  have been marked as deprecated.
+
+Impact
+======
+
+Calling the deprecated methods will trigger a deprecation log entry.
+
+.. index:: Backend, PHP-API
index 3850a1b..dbe8afa 100644 (file)
@@ -163,10 +163,12 @@ class TaskModuleController extends BaseScriptClass
     /**
      * Prints out the module's HTML
      *
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
      * @return void
      */
     public function printContent()
     {
+        GeneralUtility::logDeprecatedFunction();
         echo $this->content;
     }