[!!!][FEATURE] Replace ExtJS page tree
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Deprecation-82426-Typo3-pagetreeNavigationComponentName.rst
1 .. include:: ../../Includes.txt
2
3 ==============================================================
4 Deprecation: #82426 - typo3-pagetree navigation component name
5 ==============================================================
6
7 See :issue:`82426`
8
9 Description
10 ===========
11
12 When registering an extensions's BE module with :php:`ExtensionUtility::registerModule()` it is possible to define 'navigationComponentId'.
13
14 The name the navigation component name `typo3-pagetree` has been marked as deprecated.
15 A new name `TYPO3/CMS/Backend/PageTree/PageTreeElement` should be used instead.
16
17 Impact
18 ======
19
20 Calling :php:`ExtensionUtility::registerModule()` with old navigation component name will trigger a deprecation log entry.
21
22 Affected Installations
23 ======================
24
25 All installations having custom BE modules passing old navigation component name to :php:`ExtensionUtility::registerModule()`.
26
27
28 Migration
29 =========
30
31 Use `TYPO3/CMS/Backend/PageTree/PageTreeElement` instead of `typo3-pagetree`.
32
33
34
35 Old configuration:
36 ------------------
37
38
39 .. code-block::php
40
41       \TYPO3\CMS\Extbase\Utility\ExtensionUtility::registerModule(
42           'TYPO3.CMS.Workspaces',
43           'web',
44           'workspaces',
45           'before:info',
46           [
47               // An array holding the controller-action-combinations that are accessible
48               'Review' => 'index,fullIndex,singleIndex',
49               'Preview' => 'index,newPage'
50           ],
51           [
52               'access' => 'user,group',
53               'icon' => 'EXT:workspaces/Resources/Public/Icons/module-workspaces.svg',
54               'labels' => 'LLL:EXT:workspaces/Resources/Private/Language/locallang_mod.xlf',
55               'navigationComponentId' => 'typo3-pagetree'
56           ]
57       );
58
59
60 Should be changed to new configuration:
61 ---------------------------------------
62
63 .. code-block::php
64
65       \TYPO3\CMS\Extbase\Utility\ExtensionUtility::registerModule(
66           'TYPO3.CMS.Workspaces',
67           'web',
68           'workspaces',
69           'before:info',
70           [
71               // An array holding the controller-action-combinations that are accessible
72               'Review' => 'index,fullIndex,singleIndex',
73               'Preview' => 'index,newPage'
74           ],
75           [
76               'access' => 'user,group',
77               'icon' => 'EXT:workspaces/Resources/Public/Icons/module-workspaces.svg',
78               'labels' => 'LLL:EXT:workspaces/Resources/Private/Language/locallang_mod.xlf',
79               'navigationComponentId' => 'TYPO3/CMS/Backend/PageTree/PageTreeElement'
80           ]
81       );
82
83
84 .. index:: Backend, PHP-API, PartiallyScanned