Remove the hierarchy flag from Config Setup

Ouverte
#619 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
55/100
Type d'issue
Refactorisation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
php
Domaine
backend

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
PHP
Étoiles
43
Forks
22
Merge moyen
54 min
PR mergées (30 j)
57

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de quantum-php/framework

Toutes les issues de quantum-php/framework

Issues similaires

Plus d'issues PHP

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.