[TASK] Streamline BackendUtility::getPagesTSconfig
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Deprecation-54152-DeprecateArgumentsOfBackendUtilityGetPagesTSconfig.rst
1 .. include:: ../../Includes.txt
2
3 =============================================================================
4 Deprecation: #54152 - Deprecate arguments of BackendUtility::getPagesTSconfig
5 =============================================================================
6
7 See :issue:`54152`
8
9 Description
10 ===========
11
12 `BackendUtility::getPagesTSconfig($id, $rootLine = null, $returnPartArray = false)` allowed the following arguments:
13
14 * `$id`: This argument was and still is required. It's the id of the page the TSconfig is fetched for
15 * `$rootLine`: This argument was optional and allowed to use that method with a custom rootline. That argument is deprecated now.
16 * `$returnPartArray`: This argument was optional and allowed to return the TSconfig non parsed. That argument is deprecated now.
17
18
19 Impact
20 ======
21
22 Calling `BackendUtility::getPagesTSconfig` with `$rootline` and/or `$returnPartArray` being different than their default value, will write a deprecation log entry and will stop working in TYPO3 v10.
23
24
25 Affected Installations
26 ======================
27
28 All installations that call `BackendUtility::getPagesTSconfig` with `$rootline` and/or `$returnPartArray` being different than their default value.
29
30
31 Migration
32 =========
33
34 Calling `BackendUtility::getPagesTSconfig` with just the `id` argument still behaves the way it does. It's the most common use case and there's no migraton needed.
35
36 If you called `BackendUtility::getPagesTSconfig` with `$returnPartArray` being `true` in the past, you should now call `BackendUtility::getRawPagesTSconfig`. You will get the non parsed TSconfig, just like before.
37
38 If you called `BackendUtility::getPagesTSconfig` providing a custom rootline via `$rootline` in the past, you should now call `BackendUtility::getRawPagesTSconfig($id, $rootLine = null)` with your custom rootline and parse the returned TSconfig yourself, just like `BackendUtility::getPagesTSconfig` does.
39
40 .. index:: Backend, TSConfig, NotScanned