MODX_INTEGRATION.md 9.9 KB

Intégration MODX - Audit Express Self

Architecture complète : xPDO en BD + templates/chunks/snippets MODX.


Vue d'ensemble de l'architecture

MODX Resource          Template                    Snippet appelé
─────────────────────  ──────────────────────────  ──────────────────────────────
/controle-technique/   AuditExpress_Landing        (contenu statique dans la ressource)
/ct/choix-du-pack/     AuditExpress_Base           [[!AuditExpress_SelectPack]]
/ct/quiz/              AuditExpress_Quiz           [[!AuditExpress_Quiz]]
/ct/optional/          AuditExpress_Quiz           [[!AuditExpress_Optional]]
/ct/resultats/         AuditExpress_Results        [[!AuditExpress_Results]]
/ct/pdf/               AuditExpress_Results        [[!AuditExpress_PDF]]

Objet BD : AuditRequest (table {prefix}audit_requests) - créé dès le choix du pack, mis à jour à chaque réponse, finalisé avec le score au moment des résultats.


1. Déploiement des fichiers

core/components/audit_express/
├── model/
│   └── audit_express/
│       ├── auditrequest.class.php           ← classe xPDO base
│       └── mysql/
│           ├── auditrequest.class.php       ← pilote MySQL
│           └── auditrequest.map.inc.php     ← map de colonnes
├── src/                                     ← classes PHP existantes
│   ├── Engine.php
│   ├── PackRepository.php
│   ├── RulesRepository.php
│   ├── PdfRenderer.php
│   └── LogMailer.php
├── config/                                  ← packs JSON existants
│   ├── pack-onboarding-v1.json
│   └── packs/…
├── templates/
│   └── pdf_a4.php                           ← template PDF existant
└── schema/
    └── audit_express.mysql.schema.xml

assets/components/audit_express/
├── css/app.css
└── js/ae-base.js                            ← JS minimal (auto-avance radio)

Copier les dossiers source :

cp -r src/          core/components/audit_express/src/
cp -r config/       core/components/audit_express/config/
cp -r templates/    core/components/audit_express/templates/
cp    vendor/       core/components/audit_express/vendor/   # Dompdf
cp    public/assets/css/app.css   assets/components/audit_express/css/

2. Base de données

Option A - Script automatique (recommandé) :

php modx/setup/install.php

Option B - SQL manuel :

-- Ouvrir modx/setup/create_tables.sql, remplacer modx_ par votre préfixe, exécuter.

Colonnes de audit_requests :

Colonne Type Rôle
id INT PK AUTO_INCREMENT Clé interne
audit_uid VARCHAR(36) UNIQUE UUID public (URL résultats, PDF)
pack_id VARCHAR(64) onboarding-v1, validation-facture…
answers TEXT (JSON) {"q1":"q1_3","q2":"q2_dk",…}
optional_data TEXT (JSON) Volume mensuel, coût horaire…
result MEDIUMTEXT (JSON) Score, piliers, risques, quick wins
email VARCHAR(255) nullable Saisi lors du déblocage
status ENUM draft/completed/emailed État du cycle de vie
ip_hash VARCHAR(64) nullable sha256(IP) - RGPD, pas d'IP en clair
step TINYINT Index de la question en cours
created_at DATETIME -
updated_at DATETIME Mis à jour automatiquement

3. System Settings (Gestionnaire → Paramètres système → namespace audit_express)

Clé Valeur à renseigner
ae.core_path {core_path}components/audit_express/
ae.resource.landing ID ressource landing
ae.resource.select ID ressource choix du pack
ae.resource.quiz ID ressource quiz
ae.resource.optional ID ressource optional
ae.resource.results ID ressource résultats
ae.resource.pdf ID ressource PDF download
ae.booking_url Lien Cal.com / réservation
ae.devis_url URL ou mailto devis

4. Plugin

Créer un plugin AuditExpress_Init avec le code de modx/plugins/AuditExpress_Init.php.

Événements à cocher :

  • OnMODXInit (priorité 1 - avant tout)
  • OnHandleRequest

5. Templates

Importer dans Gestionnaire → Éléments → Templates :

Fichier source Nom dans MODX
modx/templates/AuditExpress_Landing.html AuditExpress_Landing
modx/templates/AuditExpress_Base.html AuditExpress_Base
modx/templates/AuditExpress_Quiz.html AuditExpress_Quiz
modx/templates/AuditExpress_Results.html AuditExpress_Results

6. Chunks

Importer dans Gestionnaire → Éléments → Chunks :

ae_pack_card          modx/chunks/ae_pack_card.html
ae_select_pack        modx/chunks/ae_select_pack.html
ae_quiz_progress      modx/chunks/ae_quiz_progress.html
ae_question_option    modx/chunks/ae_question_option.html
ae_quiz               modx/chunks/ae_quiz.html
ae_optional_field     modx/chunks/ae_optional_field.html
ae_optional_radio     modx/chunks/ae_optional_radio.html
ae_optional           modx/chunks/ae_optional.html
ae_pillar_row         modx/chunks/ae_pillar_row.html
ae_risk_item          modx/chunks/ae_risk_item.html
ae_win_item           modx/chunks/ae_win_item.html
ae_cost_hidden        modx/chunks/ae_cost_hidden.html
ae_unlock_gate        modx/chunks/ae_unlock_gate.html
ae_cta_unlocked       modx/chunks/ae_cta_unlocked.html
ae_results            modx/chunks/ae_results.html

7. Snippets

Importer dans Gestionnaire → Éléments → Snippets (tous en uncached [[!…]]) :

AuditExpress_SelectPack    modx/snippets/AuditExpress_SelectPack.php
AuditExpress_Quiz          modx/snippets/AuditExpress_Quiz.php
AuditExpress_Optional      modx/snippets/AuditExpress_Optional.php
AuditExpress_Results       modx/snippets/AuditExpress_Results.php
AuditExpress_PDF           modx/snippets/AuditExpress_PDF.php

8. Ressources MODX à créer

Landing (/controle-technique/)

  • Template : AuditExpress_Landing
  • Contenu : HTML statique (copier le body de public/index.php), le bouton "Lancer" pointe vers /ct/choix-du-pack/

Choix du pack (/ct/choix-du-pack/)

  • Template : AuditExpress_Base
  • Contenu :

    [[!AuditExpress_SelectPack?
    &quiz_resource_id=`[[++ae.resource.quiz]]`
    &landing_resource_id=`[[++ae.resource.landing]]`
    ]]
    

Quiz (/ct/quiz/)

  • Template : AuditExpress_Quiz
  • Contenu :

    [[!AuditExpress_Quiz?
    &select_resource_id=`[[++ae.resource.select]]`
    &optional_resource_id=`[[++ae.resource.optional]]`
    ]]
    

Optionnel (/ct/optional/)

  • Template : AuditExpress_Quiz
  • Contenu :

    [[!AuditExpress_Optional?
    &quiz_resource_id=`[[++ae.resource.quiz]]`
    &results_resource_id=`[[++ae.resource.results]]`
    ]]
    

Résultats (/ct/resultats/)

  • Template : AuditExpress_Results
  • Contenu :

    [[!AuditExpress_Results?
    &select_resource_id=`[[++ae.resource.select]]`
    &booking_url=`[[++ae.booking_url]]`
    &devis_url=`[[++ae.devis_url]]`
    ]]
    

PDF (/ct/pdf/)

  • Template : AuditExpress_Base (ou vide)
  • Contenu : [[!AuditExpress_PDF? &booking_url=[[++ae.booking_url]]]]
  • Cocher "Ne pas mettre en cache"

9. Flux de données complet

[Landing] → [Choix pack]
                ↓ POST ae_action=select_pack
           Crée AuditRequest (BD) → session ae_audit_uid
                ↓ redirect
            [Quiz Q1]
                ↓ POST ae_action=ae_answer (x20)
           Met à jour AuditRequest.answers + step (BD)
                ↓ redirect (PRG) - question suivante
            [Optional]
                ↓ POST ae_action=ae_optional
           Engine::compute() → AuditRequest.result + status=completed (BD)
                ↓ redirect ?audit=<uid>
            [Résultats]
           Score + risques toujours visibles
           Gate email → POST ae_action=ae_capture_email
                ↓ AuditRequest.email + status=emailed (BD) + PDF généré
                ↓ redirect ?audit=<uid>&unlocked=1
           Quick wins + CTAs débloqués
                ↓ lien /ct/pdf/?audit=<uid>
            [PDF]
           Téléchargement direct

10. RGPD & purge

La purge des données doit être exécutée régulièrement (cron ou tâche planifiée).

Cron Linux (exemple)

# Purge RGPD - 1er jour du mois à 3h (adapter USER, PASS, BASE_MODX)
0 3 1 * * mysql -u USER -pPASS BASE_MODX -e "DELETE FROM modx_audit_requests WHERE status='draft' AND created_at < DATE_SUB(NOW(), INTERVAL 7 DAY); DELETE FROM modx_audit_requests WHERE status IN ('completed','emailed') AND created_at < DATE_SUB(NOW(), INTERVAL 90 DAY);" >> /var/log/purge-audit.log 2>&1

SQL à exécuter (ou via script shell)

DELETE FROM modx_audit_requests
WHERE status = 'draft' AND created_at < DATE_SUB(NOW(), INTERVAL 7 DAY);

DELETE FROM modx_audit_requests
WHERE status IN ('completed','emailed') AND created_at < DATE_SUB(NOW(), INTERVAL 90 DAY);

11. Email (V1 → production)

La V1 stocke les emails dans storage/outbox/ via LogMailer.
Pour passer en production, créer une classe SmtpMailer implémentant AuditExpress\MailerInterface et l'injecter dans AuditExpress_Results.php à la place de LogMailer.