Convert the adapter types and the remaining Enums classes to PHP enums (PHP 8.2)
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 35/100
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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 realLoggerFactory.phpwith 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
ADAPTERSconstants in the factories andDatabase PaginatorFactory::REQUIRED_PARAMS- the
Statustrait's$textsmap, 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 === 200is false, and anintparameter rejects a case. Comparisons, array keys and parameters that use the value need->value, and text from config or.envneeds::from()or::tryFrom(). - Apps and templates use these constants, for example
AppFactory::create(AppType::WEB, ...)in the starter project andPaginatorTypein the Toolkit templates. Signatures typedstring $typechange.
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 phpstanandcomposer rector:checkpass on every PHP version in the CI matrix- the changelog lists every converted class
- Langage dominant
- PHP
- Étoiles
- 43
- Forks
- 22
- Merge moyen
- 54 min
- PR mergées (30 j)
- 57
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de quantum-php/framework
-
bug good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
quantum-php/framework#692 ·
Les mainteneurs répondent en général sous 1 jour
-
routing testing
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
quantum-php/framework#547 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 72/100
quantum-php/framework#694 ·
Les mainteneurs répondent en général sous 1 jour
-
Raise PHPStan to level 9Ouverterefactoring tech debt
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
quantum-php/framework#693 ·
Les mainteneurs répondent en général sous 1 jour
-
install:debugbar reads the package folder from the working directory and uses the default storage adapterPeut-être pris @armanist l’a pris aujourd’hui. Ouvertebug console debugbar good first issue
quantum-php/framework#691 · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de quantum-php/framework
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
dependencies enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 80/100
Les mainteneurs répondent en général sous 1 jour
-
bug origin:interactive status:available
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
Ultimate-Multisite/ultimate-multisite#2131 ·
Les mainteneurs répondent en général sous 1 jour
-
sync-en
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour