Skip to content

docs: ajouter des commentaires sur les méthodes clés PHP#988

Merged
CySSoO merged 1 commit intomasterfrom
cyssoo/add-comments-to-important-php-methods
Mar 4, 2026
Merged

docs: ajouter des commentaires sur les méthodes clés PHP#988
CySSoO merged 1 commit intomasterfrom
cyssoo/add-comments-to-important-php-methods

Conversation

@CySSoO
Copy link
Contributor

@CySSoO CySSoO commented Mar 4, 2026

Motivation

  • Clarifier le rôle et le flux des points d'entrée principaux du module pour faciliter la maintenance et les revues de code.
  • Documenter le pipeline de rendu des shortcodes afin d'expliquer l'ordre des transformations appliquées au contenu.
  • Rendre le processus d'import XLSX plus lisible en explicitant la préparation, l'exécution et la validation ligne par ligne.

Description

  • Ajout de PHPDoc explicatifs dans everblock.php pour les méthodes d'orchestration et d'installation : __call, install, installConfiguration, installSql, installHooks et registerQcdBuilderHooks.
  • Ajout d'une description du point d'entrée principal des shortcodes dans src/Service/EverblockTools.php pour renderShortcodes décrivant les étapes de traitement.
  • Ajout de commentaires sur le flux d'import dans src/Command/ImportFileCommand.php pour configure, execute et updateEverblocks, incluant le typage attendu pour les lignes d'entrée.

Testing

  • Lint PHP exécuté sur les fichiers modifiés avec php -l everblock.php et le résultat a été No syntax errors detected.
  • Lint PHP exécuté sur les fichiers modifiés avec php -l src/Service/EverblockTools.php et le résultat a été No syntax errors detected.
  • Lint PHP exécuté sur les fichiers modifiés avec php -l src/Command/ImportFileCommand.php et le résultat a été No syntax errors detected.

Codex Task

@CySSoO CySSoO merged commit 78d79b9 into master Mar 4, 2026
2 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant