Review main Merged Breaking

82677[!!!][TASK] Declare TimeTracker read API `@internal`

Benni Mack CR +2 V +2 Hard +376 −316 updated 01/29/24, 13:13

Commit message

The TimeTracker exists for a very long time and did not
receive much love over the years. It comes with fishy
internal structures and needs a bigger overhaul.

While various parts throughout the core and extensions
actively use the "write" API - push(), pull() and
setTSlogMessage() - the "init" API is only used by
middlewares and the "read" and "print" API only by
EXT:adminpanel.

The patch moves the "print" related methods to the
admin panel extension as is, and declares everything
except the "write" methods `@internal`. This allows
future refactoring of the now internal data structures
and API.

Review

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

Issues 1

Files 5

Review log 913

  1. Benni Mack uploaded patch set 1 01/27/24, 20:46

  2. core-ci voted on patch set 1 V -1 01/27/24, 20:51 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/52329

  3. Christian Kuhn uploaded patch set 2 V -1 01/29/24, 11:26

  4. core-ci voted on patch set 2 V +1 01/29/24, 11:32 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/52403

  5. Christian Kuhn uploaded patch set 3 V +1 01/29/24, 12:12

  6. core-ci voted on patch set 3 V -1 01/29/24, 12:19 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/52409

  7. Oliver Klee commented on patch set 3 01/29/24, 12:22

    TimeTracker.php:31

    This will cause usages of the whole class in IDEs to get marked as "usage of internal". Bothersome as it may be, I'd suggest marking the corresponding methods as `@internal` instead and changing the note for the class to use the word "internal" instead (without the `@`).
  8. Christian Kuhn commented on patch set 3 01/29/24, 12:23

    TimeTracker.php:31 Reply

    Done
  9. Christian Kuhn uploaded patch set 4 V -1 01/29/24, 12:23

  10. core-ci voted on patch set 4 V +1 01/29/24, 12:29 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/52410

  11. Christian Kuhn voted on patch set 4 CR +1 V +1 01/29/24, 12:37

  12. Stefan Bürk voted on patch set 4 CR +2 V +2 01/29/24, 13:13

  13. Stefan Bürk merged patch set 5 01/29/24, 13:13