Convert the adapter types and the remaining Enums classes to PHP enums (PHP 8.2)

Aperta
#620 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
php
Ambito
backend

Direzione di ricerca

Start by reading the listed adapter type classes and the factories, Database, PaginatorFactory, and Status trait named in the issue. Then trace the listed property and parameter defaults, config and .env inputs, starter project, module templates, and documentation examples that use these classes. Check every conversion against the PHP 8.2 enum value behavior described in the issue; done means all listed classes are converted or have a recorded reason to remain constants, the examples and templates work, the changelog and upgrade guide are updated, and the stated CI checks pass.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

breaking change refactoring tech debt

Summary

Convert the remaining classes in the Enums folders to PHP enums in 3.2.0, once PHP 8.2 is the minimum: the adapter types, StatusCode, ContentType, Env and ExitCode. The first batch, the classes that can convert on PHP 8.1, is #612.

Why 3.2.0

These classes appear in class constants, property defaults or parameter defaults, mostly as the keys of maps, and PHP 8.1 does not allow Case->value in a constant expression. PHP 8.2 does (the RFC "Fetch properties of enums in const expressions"). I checked it on PHP 8.2.35 and 8.1.34:

  • public const ADAPTERS = [LoggerType::SINGLE->value => SingleAdapter::class, ...] loads and works on 8.2.
  • The same code fails on 8.1 with Fatal error: Constant expression contains invalid operations, and so does the real LoggerFactory.php with its keys written that way.

With 8.2 the maps keep their shape. In each place only ->value is added to the keys.

Classes in this ticket

  • Adapter types (15): AppType, ArchiveType, AuthType, CacheType, CaptchaType, CryptorType, DatabaseType, FileSystemType, LangType, LoggerType, MailerType, PaginatorType, RateLimitType, RendererType, SessionType.
  • Others: ContentType, Env, ExitCode, StatusCode (62 integer cases).

Places that need ->value

  • the 15 ADAPTERS constants in the factories and Database
  • PaginatorFactory::REQUIRED_PARAMS
  • the Status trait's $texts map, with the status codes as keys
  • the property and parameter defaults that hold these classes

What to watch

  • An enum case is not its value: StatusCode::OK === 200 is false, and an int parameter rejects a case. Comparisons, array keys and parameters that use the value need ->value, and text from config or .env needs ::from() or ::tryFrom().
  • Apps and templates use these constants, for example AppFactory::create(AppType::WEB, ...) in the starter project and PaginatorType in the Toolkit templates. Signatures typed string $type change.

Out of scope

  • ExceptionMessages, whose classes extend a shared base class.
  • The classes in #612.

Breaking changes

  • Public constants become enum cases, and the type of some public parameters and return values changes. To be listed in the changelog and in the upgrade guide.

Acceptance criteria

  • every class above is converted or has a recorded reason to stay a constants class
  • the starter project and the module templates still work, and the docs examples use the new form
  • composer test, composer cs:check, composer phpstan and composer rector:check pass on every PHP version in the CI matrix
  • the changelog lists every converted class
Lingua principale
PHP
Stelle
43
Fork
22
Merge medio
54m
PR unite (30g)
57

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di quantum-php/framework

Tutte le issue di quantum-php/framework

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.