[TASK] Deprecate more methods of DocumentTemplate 39/45939/4
authorGeorg Ringer <georg.ringer@gmail.com>
Fri, 15 Jan 2016 13:11:19 +0000 (14:11 +0100)
committerWouter Wolters <typo3@wouterwolters.nl>
Fri, 15 Jan 2016 15:26:50 +0000 (16:26 +0100)
Unused and to be deprecated methods:

- wrapInCData
- funcMenu
- getDragDropCode
- getTabMenu
- getVersionSelector

Change-Id: I8fb5cf470a5bd2c21b43f9cc28030047188aab32
Resolves: #72733
Releases: master
Reviewed-on: https://review.typo3.org/45939
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Markus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein <markus.klein@typo3.org>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
typo3/sysext/backend/Classes/Template/DocumentTemplate.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-72733-DeprecateMoreMethodsOfDocumentTemplate.rst [new file with mode: 0644]

index 7c4191e..91c9aef 100644 (file)
@@ -1051,9 +1051,11 @@ function jumpToUrl(URL) {
      *
      * @param string $string Input string
      * @return string Output string
+     * @deprecated since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.
      */
     public function wrapInCData($string)
     {
+        GeneralUtility::logDeprecatedFunction();
         $string = '/*<![CDATA[*/' . $string . '/*]]>*/';
         return $string;
     }
@@ -1094,9 +1096,11 @@ function jumpToUrl(URL) {
      * @param string $content Content cell content (left)
      * @param string $menu Menu cell content (right)
      * @return string HTML output
+     * @deprecated since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.
      */
     public function funcMenu($content, $menu)
     {
+        GeneralUtility::logDeprecatedFunction();
         return '
                        <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
                                <tr>
@@ -1136,9 +1140,11 @@ function jumpToUrl(URL) {
      * @param string $table indicator of which table the drag and drop function should work on (pages or folders)
      * @param string $additionalJavaScriptCode adds more code to the additional javascript code
      * @return void
+     * @deprecated since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.
      */
     public function getDragDropCode($table, $additionalJavaScriptCode = '')
     {
+        GeneralUtility::logDeprecatedFunction();
         $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/LegacyTree', 'function() {
                        DragDrop.table = "' . $table . '";
                        ' . $additionalJavaScriptCode . '
@@ -1158,9 +1164,11 @@ function jumpToUrl(URL) {
      * @param string $script is the script to send the &id to, if empty it's automatically found
      * @param string $addparams is additional parameters to pass to the script.
      * @return string HTML code for tab menu
+     * @deprecated since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.
      */
     public function getTabMenu($mainParams, $elementName, $currentValue, $menuItems, $script = '', $addparams = '')
     {
+        GeneralUtility::logDeprecatedFunction();
         $content = '';
         if (is_array($menuItems)) {
             if (!is_array($mainParams)) {
@@ -1218,9 +1226,11 @@ function jumpToUrl(URL) {
      * @param int $id Page id to create selector for.
      * @param bool $noAction If set, there will be no button for swapping page.
      * @return string
+     * @deprecated since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.
      */
     public function getVersionSelector($id, $noAction = false)
     {
+        GeneralUtility::logDeprecatedFunction();
         if (
                 ExtensionManagementUtility::isLoaded('version') &&
                 !ExtensionManagementUtility::isLoaded('workspaces')
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-72733-DeprecateMoreMethodsOfDocumentTemplate.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-72733-DeprecateMoreMethodsOfDocumentTemplate.rst
new file mode 100644 (file)
index 0000000..0293ce3
--- /dev/null
@@ -0,0 +1,32 @@
+================================================================
+Deprecation: #72733 - Deprecate more methods of DocumentTemplate
+================================================================
+
+Description
+===========
+
+The following methods from ``TYPO3\CMS\Backend\Template\DocumentTemplate`` have been deprecated:
+
+* ``wrapInCData``
+* ``funcMenu``
+* ``getDragDropCode``
+* ``getTabMenu``
+* ``getVersionSelector``
+
+
+Impact
+======
+
+Calling one of the aforementioned methods will write an entry in the deprecation log.
+
+
+Affected Installations
+======================
+
+Instances with custom backend modules that use one of the aforementioned methods.
+
+
+Migration
+=========
+
+Some replacements are available in the ``\TYPO3\CMS\Backend\Template\ModuleTemplate`` class.
\ No newline at end of file