[FEATURE] Configurable Route Parameters
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Feature-81409-Configurable-Route-Parameters.rst
1 .. include:: ../../Includes.txt
2
3 ===============================================
4 Feature: #81409 - Configurable Route Parameters
5 ===============================================
6
7 See :issue:`81409`
8
9 Description
10 ===========
11
12 Routes definitions are extended by the possibility to defined default parameters.
13 Those parameters can be overridden during the regular URI generation process.
14
15 Several AjaxRoutes inhibited the backend session update to not keep the session
16 alive by periodic polling. Those `skipSessionUpdate` parameters have been removed
17 from the specific URI generation invocations and moved to the central route definitions.
18
19 Default route parameters are defined in an associative key-value-array using the
20 index `parameters`. This definition can be used for both, plain routes and AJAX routes.
21
22 .. code-block:: php
23
24     'systeminformation_render' => [
25         'path' => '/system-information/render',
26         'target' => \TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem::class . '::renderMenuAction',
27         'parameters' => [
28             'skipSessionUpdate' => 1
29         ]
30     ]
31
32 Impact
33 ======
34
35 Developers have easier and more standardized control over AjaxRoute parameters.
36
37 .. index:: JavaScript, Backend