[TASK] Deprecate ElementBrowserFramesetController 08/58208/2
authorChristian Kuhn <lolli@schwarzbu.ch>
Fri, 7 Sep 2018 09:03:43 +0000 (11:03 +0200)
committerAnja Leichsenring <aleichsenring@ab-softlab.de>
Sat, 8 Sep 2018 07:31:30 +0000 (09:31 +0200)
As far as I could find out, the 'browser' route target class
ElementBrowserFramesetController is unused for a while already.
I think it is unused since element browser and modal works in
v7 and v8, the FormEngine JS browserUrl route target is
always wizard_element_browser and searching for other things
like the bparams argument reveals no usages, either.
The patch deprecates the route and the controller.

Resolves: #86178
Releases: master
Change-Id: Ifed2e9210ef04f95944ddc2371e1ad616c73715f
Reviewed-on: https://review.typo3.org/58208
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Markus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein <markus.klein@typo3.org>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
typo3/sysext/backend/Configuration/Backend/Routes.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-86178-ClassElementBrowserFramesetController.rst [new file with mode: 0644]
typo3/sysext/recordlist/Classes/Controller/ElementBrowserFramesetController.php

index 0429aad..eccd769 100644 (file)
@@ -164,6 +164,7 @@ return [
     ],
 
     // Register browser
+    // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.
     'browser' => [
         'path' => '/record/browse',
         'target' => \TYPO3\CMS\Recordlist\Controller\ElementBrowserFramesetController::class . '::mainAction'
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-86178-ClassElementBrowserFramesetController.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-86178-ClassElementBrowserFramesetController.rst
new file mode 100644 (file)
index 0000000..b2f09d4
--- /dev/null
@@ -0,0 +1,35 @@
+.. include:: ../../Includes.txt
+
+============================================================
+Deprecation: #86178 - Class ElementBrowserFramesetController
+============================================================
+
+See :issue:`86178`
+
+Description
+===========
+
+Class :php:`TYPO3\CMS\Recordlist\Controller\ElementBrowserFramesetController`, the route
+target of :php:`browser` has been deprecated and should not be used any longer.
+
+
+Impact
+======
+
+If calling that controller class a PHP :php:`E_USER_DEPRECATED` error is triggered.
+
+
+Affected Installations
+======================
+
+This route target is unused in core for a while already. Extensions are only affected
+if they call the Backend route target :php:`browser` that renders the element browser
+in a frameset.
+
+
+Migration
+=========
+
+Use the modal based element browser with the route :php:`wizard_element_browser` instead.
+
+.. index:: Backend, PHP-API, NotScanned, ext:recordlist
\ No newline at end of file
index 24933ec..69b50c0 100644 (file)
@@ -24,6 +24,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Script Class, putting the frameset together.
+ *
+ * @deprecated since TYPO3 v9, will be removed in TYPO3 v10.
  */
 class ElementBrowserFramesetController
 {
@@ -44,6 +46,10 @@ class ElementBrowserFramesetController
      */
     public function __construct()
     {
+        trigger_error(
+            self::class . ' will be removed in TYPO3 v10. Use route wizard_element_browser instead.',
+            E_USER_DEPRECATED
+        );
         $GLOBALS['SOBE'] = $this;
     }