Review main Merged

84657[DOCS] Note about reserved keywords for Extbase arguments ("format")

Garvin Hicking CR +2 V +2 Easy +3 −3 updated 06/13/24, 07:29

Commit message

Extbase reserves a couple of keywords for internal use:

* action
* controller
* format (resolving fluid templates for HTML, json, ...)
* __trustedProperties
* __referrer

The notiation "__" (and "@" for sub-arrays) is indiciative
of being reserved keywords, however action/controller/format
are not.

These are now mentioned specifically in the Fluid ViewHelper
"arguments" parameter, so that they can show up in the
auto-generated documentation.

This should help to prevent integrators and developers from
advertly using an argument like "format" as a custom
variable/property name.

Efforts have been made to document this also here:

https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/pull/4525
https://github.com/TYPO3-Documentation/TYPO3CMS-Exceptions/pull/155

Review

  • Code review CR +2 Done
    • Christian Kuhn +2
    • Georg Ringer +1
  • Verified V +2 Done
    • Christian Kuhn +2
    • Georg Ringer +1
    • core-ci +1 CI

Issues 1

Files 3

Review log 45

  1. Garvin Hicking uploaded patch set 1 06/12/24, 11:40

  2. core-ci voted on patch set 1 V +1 06/12/24, 11:47 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/59316

  3. Georg Ringer voted on patch set 1 CR +1 V +1 06/13/24, 05:51

  4. Christian Kuhn voted on patch set 1 CR +2 V +2 06/13/24, 07:18

  5. Christian Kuhn merged patch set 2 06/13/24, 07:29