Review main Merged

76670[BUGFIX] Do not mark the FAL-related Extbase models as internal anymore

Oliver Klee CR +2 V +2 Easy +0 −6 updated 11/20/22, 14:59

Commit message

The FAL-related Extbase models are documented in the "TYPO3 Explained"
documentation, and they are the recommended way to use FAL in an
Extbase context. So the following classes are not marked as `@internal`
anymore in order to not send mixed signals to extension developers:

- TYPO3\CMS\Extbase\Domain\Model\File
- TYPO3\CMS\Extbase\Domain\Model\FileReference
- TYPO3\CMS\Extbase\Domain\Model\Folder

There is no point in forcing extension authors to re-implement
those classes (and duplicating the code from the Core) when
the Core implementation is stable now and has proven to
work fine.

Some history for what has happened:

Those classes started out marked as experimental (when they were
indeed still experimental). Then, in a cleanup bulk change in
3888dae8f3f71c3f5e1db1c00bcbfe7d0d8fed2e5966e6533c9353b6d7485f32,
the classes were converted to use the `@internal` annotation,
even though at least the three FAL Extbase models should have
been made public API instead by that time.

This is where the usage of the FAL models is documented in
"TYPO3 Explained":
https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Fal/UsingFal/Frontend.html

Review

  • Code review CR +2 Done
    • Benni Mack +2
    • Georg Ringer +1
    • Lina Wolf +1
  • Verified V +2 Done
    • Benni Mack +2
    • Georg Ringer +1
    • Lina Wolf +1
    • core-ci +1 CI

Issues 1

Files 3

Review log 1013

  1. Oliver Klee uploaded patch set 1 11/18/22, 08:54

  2. Oliver Klee updated the commit message in patch set 2 11/18/22, 08:55

  3. Chris Müller updated the commit message in patch set 3 11/18/22, 08:56

  4. core-ci voted on patch set 2 V +1 11/18/22, 09:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33903

  5. core-ci voted on patch set 3 V +1 11/18/22, 09:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33904

  6. Oliver Klee updated the commit message in patch set 4 11/18/22, 09:29

  7. Oliver Klee updated the commit message in patch set 5 11/18/22, 09:30

  8. core-ci voted on patch set 5 V +1 11/18/22, 09:41 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/33908

  9. Georg Ringer voted on patch set 5 V +1 CR +1 11/18/22, 09:57

  10. Lina Wolf commented on patch set 5 V +1 CR +1 11/18/22, 10:28

    I think this will be really helpful
  11. Benni Mack voted on patch set 5 V +2 CR +2 11/18/22, 10:39

  12. Benni Mack merged patch set 6 11/18/22, 10:39

  13. Stefan Bürk commented on patch set 6 11/20/22, 14:59

    Backport done with https://review.typo3.org/c/Packages/TYPO3.CMS/+/76674 and a dedicated gerrit change id.