Remove the hierarchy flag from Config Setup

Đang mở
#619 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/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 with Quantum\Config\Setup, Config::resolveFilePath(), SetupTest, and advanced-features/configuration.md, then read the linked context in issue #618. Remove the hierarchy parameter and methods, make lookup fall back to shared, and update the tests plus changelog and upgrade guide for the signature change. Done when the acceptance criteria pass, including the shared fallback test and the listed CI checks.

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

Mô tả

breaking change config refactoring tech debt

Summary

Remove the hierarchical flag from Quantum\Config\Setup, deprecated in 3.1.2 (#618), and make the shared fallback unconditional.

Why

The flag has no practical use: nothing in src turns it off, and turning it off breaks the loading of the global config in shared/config, which is found only through the fallback. The details are in #618.

Proposed change

  • Remove the $hierarchical parameter from Setup::__construct(), and the setHierarchy() and getHierarchy() methods.
  • In Config::resolveFilePath(), drop the if ($setup->getHierarchy()) check. When the file is not found in the module folder, the lookup always falls back to shared.
  • Remove the three lines about the flag from SetupTest.
  • Docs: remove the sentence in advanced-features/configuration.md that says the shared fallback only triggers when hierarchical is on, and keep the "shared fallback" wording from 3.1.2.

Breaking changes

  • Setup::__construct() takes ($pathPrefix, $fileName, $module, $exceptionMessage) instead of ($pathPrefix, $fileName, $hierarchical, $module, $exceptionMessage). $module and $exceptionMessage move up one position, so a call such as new Setup('config', 'x', true, 'Blog') changes meaning or fails. Callers that pass only the first two arguments are unaffected.
  • setHierarchy() and getHierarchy() are gone.
  • To be listed in the changelog and in the upgrade guide, with a before and after example.

Acceptance criteria

  • the parameter and the two methods are removed, and the fallback is unconditional
  • SetupTest and the other Config tests pass, and a test covers the fallback to shared for a module that has no file of its own
  • composer test, composer cs:check, composer phpstan and composer rector:check pass on every PHP version in the CI matrix
  • the changelog and the upgrade guide describe the signature change
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.