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

Đang mở
#620 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
php
Lĩnh vực
backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
PHP
Star
43
Fork
22
Merge trung bình
54 phút
Pull request đã merge (30 ngày)
57

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của quantum-php/framework

Tất cả issue của quantum-php/framework

Issue tương tự

Thêm issue về PHP

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.