Review main Merged

87628[DOCS] Use ServerRequestInterface $request parameter in AbstractPlugin

TYPO3com CR +2 V +2 Easy +22 −2 updated 01/04/25, 16:01

Commit message

The example of the breaking change to AbstractPlugin (removed in v13)
is missing the third parameter `$request`. It is passed to the
TS userfunc execution [1] [2].

This patch makes the migration example more complete for v12 instances.

[1] https://docs.typo3.org/m/typo3/reference-coreapi/12.4/en-us/ApiOverview/RequestLifeCycle/Typo3Request.html#user-function
[2] https://review.typo3.org/c/Packages/TYPO3.CMS/+/66080

Review

  • Code review CR +2 Done
    • Stefan Bürk +2
    • Garvin Hicking +1
  • Verified V +2 Done
    • Stefan Bürk +2
    • Garvin Hicking +1
    • core-ci +1 CI

Issues 2

Files 1

Review log 1219

  1. TYPO3com uploaded patch set 1 01/03/25, 17:02

  2. core-ci voted on patch set 1 V +1 01/03/25, 17:10 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/71873

  3. Sybille Peters commented on patch set 1 01/03/25, 18:57

    AbstractPlugin does not exist anymore since v13. Perhaps a note about that should be added as well
  4. Sybille Peters updated the commit message in patch set 2 V +1 01/03/25, 18:57

  5. Sybille Peters updated the commit message in patch set 3 01/03/25, 18:59

  6. core-ci voted on patch set 2 V +1 01/03/25, 19:04 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/71877

  7. core-ci voted on patch set 3 V +1 01/03/25, 19:06 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/71878

  8. Garvin Hicking commented on patch set 3 CR -1 01/03/25, 19:53

    Reply

    IMO we do not (and IMO should not) link from changelogs to newer versions of changelogs in such cases. Hinting at the absence of AbstractPlugin is the task of the Documentation - this is already done in https://docs.typo3.org/m/typo3/reference-coreapi/12.4/en-us/ExtensionArchitecture/HowTo/FrontendPlugin/AbstractPlugin.html
    What I do not understand is the reference to "main" here. That seems to be a custom implementation, and probably called via TypoScript? Thus we cannot generally adapt this example? Please explain where in the TYPO3 core such a call to an AbstractPlugin's main() method is performed.
  9. Garvin Hicking updated the commit message in patch set 4 CR -1 V +1 01/03/25, 20:51

  10. core-ci voted on patch set 4 V +1 01/03/25, 20:58 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/71880

  11. Garvin Hicking commented on patch set 5 V +1 01/03/25, 20:58

    Published edit on patch set 4.
  12. Garvin Hicking commented on patch set 5 01/03/25, 20:59

    Reply

    Thinking about it some more, I do think there's some sense in adding a cross reference, please see the change I pushed.

    Reply

    Stefan talked me through it. I've adapted the changelog a bit, and the commit message, giving some background information.
  13. Garvin Hicking updated the commit message in patch set 6 01/03/25, 21:01

  14. Garvin Hicking voted on patch set 6 CR +1 V +1 01/03/25, 21:02

  15. core-ci voted on patch set 5 V +1 01/03/25, 21:06 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/71881

  16. core-ci voted on patch set 6 V +1 01/03/25, 21:09 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/71882

  17. Franz Holzinger commented on patch set 6 01/04/25, 13:33

    Reply

    The function main is used for historical reasons. The former pi_base class has the main function as the only possibility from where to start a TYPO3 extension plugin.
    I added a comment that the main function is there for historical reasons coming from the pi_base class.
  18. Stefan Bürk voted on patch set 6 CR +2 V +2 01/04/25, 15:51

  19. Stefan Bürk merged patch set 7 01/04/25, 16:01