Remove the hierarchy flag from Config Setup

Aperta
#619 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
php
Ambito
backend

Direzione di ricerca

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.

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

Descrizione

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
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.