[TASK] Rename TypoScriptReferenceLoader to TypoScriptReferenceController

Change-Id: I31fcc83c20766aacd3af7d8b68df9469d3db13dc Resolves: #84411 Releases: master Reviewed-on: https://review.typo3.org/56310 Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de> Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de> Tested-by: TYPO3com <no-reply@typo3.com> Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch> Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
TYPO3 · Mar 17, 2018 · 2912053 · 2912053
1 parent a21470b
commit 2912053
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 6 deletions.
diff --git a/...ation-84411-TypoScriptReferenceLoaderRenamedToTypoScriptReferenceController.rst b/...ation-84411-TypoScriptReferenceLoaderRenamedToTypoScriptReferenceController.rst
@@ -0,0 +1,35 @@
+.. include:: ../../Includes.txt
+
+========================================================================================
+Deprecation: #84411 - TypoScriptReferenceLoader renamed to TypoScriptReferenceController
+========================================================================================
+
+See :issue:`84411`
+
+Description
+===========
+
+The PHP class :php:`TYPO3\CMS\T3editor\TypoScriptReferenceLoader` has been renamed to
+:php:`TYPO3\CMS\T3editor\Controller\TypoScriptReferenceController`.
+
+
+Impact
+======
+
+The old class name has been registered as class alias and will still work.
+Old class name usage however is discouraged and should be avoided, the
+alias will vanish with core version 10.
+
+
+Affected Installations
+======================
+
+Extensions which use the old class name are affected. The extension scanner will find affected extensions using the old class name.
+
+
+Migration
+=========
+
+Use new class name instead.
+
+.. index:: Backend, PHP-API, FullyScanned, ext:t3editor
diff --git a/typo3/sysext/install/Configuration/ExtensionScanner/Php/ClassNameMatcher.php b/typo3/sysext/install/Configuration/ExtensionScanner/Php/ClassNameMatcher.php
@@ -669,4 +669,9 @@
             'Deprecation-84409-ImageManipulationWizardRenamedToImageManipulationController.rst',
         ],
     ],
+    'TYPO3\CMS\T3editor\TypoScriptReferenceLoader' => [
+        'restFiles' => [
+            'Deprecation-84411-TypoScriptReferenceLoaderRenamedToTypoScriptReferenceController.rst',
+        ],
+    ],
 ];
diff --git a/...tor/Classes/TypoScriptReferenceLoader.php → ...troller/TypoScriptReferenceController.php b/...tor/Classes/TypoScriptReferenceLoader.php → ...troller/TypoScriptReferenceController.php
@@ -1,5 +1,5 @@
 <?php
-namespace TYPO3\CMS\T3editor;
+namespace TYPO3\CMS\T3editor\Controller;
 
 /*
  * This file is part of the TYPO3 CMS project.
@@ -21,7 +21,7 @@
 /**
  * Loads TSref information from a XML file an responds to an AJAX call.
  */
-class TypoScriptReferenceLoader
+class TypoScriptReferenceController
 {
     /**
      * @var \DOMDocument
@@ -37,13 +37,12 @@ public function __construct()
     }
 
     /**
-     * General processor for AJAX requests.
-     * Called by AjaxRequestHandler
+     * Load TypoScript reference
      *
      * @param ServerRequestInterface $request
      * @return ResponseInterface
      */
-    public function processAjaxRequest(ServerRequestInterface $request): ResponseInterface
+    public function loadReference(ServerRequestInterface $request): ResponseInterface
     {
         // Load the TSref XML information:
         $this->loadFile(GeneralUtility::getFileAbsFileName('EXT:t3editor/Resources/Private/tsref.xml'));

diff --git a/typo3/sysext/t3editor/Configuration/Backend/AjaxRoutes.php b/typo3/sysext/t3editor/Configuration/Backend/AjaxRoutes.php
@@ -7,7 +7,7 @@
     // Get TSRef
     't3editor_tsref' => [
         'path' => '/t3editor/tsref',
-        'target' => \TYPO3\CMS\T3editor\TypoScriptReferenceLoader::class . '::processAjaxRequest'
+        'target' => \TYPO3\CMS\T3editor\Controller\TypoScriptReferenceController::class . '::loadReference'
     ],
 
     // Load code completion templates

diff --git a/typo3/sysext/t3editor/Migrations/Code/ClassAliasMap.php b/typo3/sysext/t3editor/Migrations/Code/ClassAliasMap.php
@@ -1,4 +1,5 @@
 <?php
 return [
     'TYPO3\\CMS\\T3editor\\CodeCompletion' => \TYPO3\CMS\T3editor\Controller\CodeCompletionController::class,
+    'TYPO3\\CMS\\T3editor\\TypoScriptReferenceLoader' => \TYPO3\CMS\T3editor\Controller\TypoScriptReferenceController::class,
 ];
diff --git a/typo3/sysext/t3editor/Migrations/Code/LegacyClassesForIde.php b/typo3/sysext/t3editor/Migrations/Code/LegacyClassesForIde.php
@@ -10,4 +10,11 @@
     class CodeCompletion extends \TYPO3\CMS\T3editor\Controller\CodeCompletionController
     {
     }
+
+    /**
+     * @deprecated since v9, will be removed in v10
+     */
+    class TypoScriptReferenceLoader extends \TYPO3\CMS\T3editor\Controller\TypoScriptReferenceController
+    {
+    }
 }