Skip source-view modal in default template when include-source is disabled#4119
Merged
jaapio merged 1 commit intoMay 10, 2026
Conversation
9459af4 to
94cab2b
Compare
Member
|
Thank you for this fix! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4024.
Bug observé
Le template
defaultinjecte inconditionnellement la modalsource-view(<div class="phpdocumentor-modal" id="source-view">) et son loader script sur chaque page class/interface/trait/enum/file/namespace/package. Quandinclude-sourceest àfalse(défaut selondata/xsd/phpdoc.xsd), aucun.txtsource n'est écrit parTransformer/Writer/Sourcecode.php, et la modal pointe dans le vide.Bug latent découvert en cours de fix
ProjectDescriptor::Settings::includeSource()/excludeSource()existent mais ne sont jamais appelés depuissrc/en production. Seule la branchetests/les utilise. Résultat :project.settings.shouldIncludeSourcerenvoyait toujoursfalsequel que soit le contenu dephpdoc.xml. Le templatecleanutilise déjà ce guard (data/templates/clean/class.html.twig:20), donc le source viewer de clean ne s'appliquait lui aussi plus en 3.x.Fix complet
ParseFiles::__invoke()(src/phpDocumentor/Pipeline/Stage/Parser/ParseFiles.php) : propage maintenantinclude-sourcede l'ApiSpecificationversProjectDescriptor::Settingsvia le builder, en miroir dusetVisibilityexistant.ProjectDescriptorBuilder::setIncludeSource(bool)(nouvelle méthode) : appelleSettings::includeSource()/excludeSource()selon la valeur booléenne propagée.data/templates/default/components/source-modal.html.twig: wrap les deux blocs (sourceview_modaletmodals_script) dans{% if project.settings.shouldIncludeSource %}...{% endif %}. Rien n'est émis quand la config ne demande pas le source viewer.Conséquence : avec
include-source: true, la modal est rendue et fonctionne. Avecinclude-source: falseou absent, la modal (et son JS) ne partent pas dans la sortie HTML.Tests
ProjectDescriptorBuilderTest::testSetIncludeSourceTogglesTheProjectSetting: vérifie quesetIncludeSource(true|false)flippe correctementSettings::shouldIncludeSource().tests/unit/phpDocumentor/Descriptor/ettests/unit/phpDocumentor/Pipeline/passent.