Aller au contenu
JoeCMS Télécharger 3.1.5
Manuel · 09

Backend et sections

La partie du framework qui fait gagner le plus de temps : grilles et formulaires générés depuis la base de données. Une section d'administration complète — liste, recherche, tri, pagination, formulaire d'édition, détails liés — tient en deux fichiers PHP déclaratifs.

1. Comment c'est routé

/restricted/<section>
   └─ règle dans conf/modules/auth/routing_table.xml  (profils : admin, data-entry)
        └─ conf/gallery/manage/<section>/index.php    → liste    (ffGrid)
           conf/gallery/manage/<section>/modify.php   → fiche    (ffRecord)

L'authentification est une seule règle qui protège tout ce qui est en dessous : les contrôleurs n'ont pas à revérifier l'accès, seulement les permissions fines (voir 08 §4).

Les sous-sections sont des sous-dossiers : manage/tags/categories/{index,modify}.php → /restricted/tags/categories.

2. Les sections présentes

SectionGère
vgalleryles contenus (nœuds, champs, relations)
vgallery-nextle nouvel espace contenus (VGALLERY_NEXT_PIANO.md)
section, block, staticsections, blocs de layout, pages statiques
resourcesressources et médias
tags, placetaxonomies et lieux
internationalle dictionnaire multilingue (ff_international)
themes, jsthèmes et scripts
routingrègles de routage
seométadonnées SEO
emailtemplates et configuration des emails
notifynotifications
publishing, draftpublication et brouillons
extraschamps supplémentaires
users, groupscomptes et groupes
updatermises à jour, mode maintenance et migrations de la BD (14 §5bis)

3. ffGrid : la liste

$oGrid = ffGrid::factory($cm->oPage);
$oGrid->full_ajax    = true;                 // pagination/tri sans recharger la page
$oGrid->id           = "MieVoci";
$oGrid->source_SQL   = "SELECT ID, nome, creato_il
                          FROM mia_tabella
                         WHERE 1 [AND] [WHERE] [HAVING] [ORDER]";
$oGrid->order_default = "nome";
$oGrid->use_search    = true;
$oGrid->record_url    = $cm->oPage->site_path . $cm->oPage->page_path . "/modify";
$oGrid->record_id     = "MieVociModify";
$oGrid->resources[]   = $oGrid->record_id;

$oField = ff_field(...);  $oGrid->addSearchField($oField);   // filtres
$oField = ff_field(...);  $oGrid->addKeyField($oField);      // clé (ID)
$oField = ff_field(...);  $oGrid->addContent($oField);       // colonnes
$oGrid->addGridButton($oButton);                             // actions groupées

$oGrid->addEvent("on_before_parse_row", "mie_voci_on_before_parse_row");

Les marqueurs [AND] [WHERE] [HAVING] [ORDER] dans la source_SQL ne sont pas décoratifs : ce sont les endroits où la grille injecte filtres, recherche et tri. Sans eux, recherche et tri ne fonctionnent pas et personne ne le dit.

PropriétéÀ quoi elle sert
full_ajaxinteraction sans rechargement
use_searchbarre de recherche construite à partir des addSearchField
order_defaulttri initial : l'id d'un champ de la grille, pas un morceau de SQL. "level DESC" donne « Cannot determine order field! » ; la direction va dans le champ, $oField->order_dir = "DESC" (conf/gallery/manage/groups/index.php)
record_url / record_idoù s'ouvre la fiche et avec quel id (sert pour les popups)
resources[]déclare les ressources (JS/CSS/widgets) à charger
widget_deps[]dépendances vers des widgets du framework
événementson_before_parse_row, on_before_parse_data, … pour décorer lignes et cellules

4. ffRecord : la fiche

$oRecord = ffRecord::factory($cm->oPage);
$oRecord->id        = "MieVociModify";
$oRecord->resources[] = $oRecord->id;
$oRecord->src_table = "mia_tabella";                       // le formulaire connaît la table
$oRecord->insert_additional_fields["ID_lang"] = new ffData("1", "Number");   // valeurs implicites
$oRecord->addEvent("on_done_action", "mie_voci_on_done_action");             // après l'enregistrement

$oField = ff_field(...);  $oRecord->addKeyField($oField);
$oField = ff_field(...);  $oRecord->addContent($oField);
$oRecord->addContent($oDetail, "relazione");               // détail lié (master-detail)

ffRecord génère le formulaire, valide, écrit et recharge tout seul : dans un cas simple il n'y a pas une ligne de SQL d'écriture. Les accroches applicatives passent par les événements (on_before_action, on_done_action, on_load_data, …), pas par une réécriture de l'enregistrement.

Exemple réel avec synchronisation sur une seconde table : conf/gallery/manage/users/modify.php (aligne access_users et anagraph).

5. Ajouter une nouvelle section : la recette

  1. mkdir conf/gallery/manage/<section>/
  2. index.php — la ffGrid (copier depuis une section voisine : tags pour le cas simple, users pour le cas avec synchronisation)
  3. modify.php — la ffRecord
  4. ajouter l'entrée au menu du backend (library/gallery/process/admin_menu.php et la configuration du module restricted)
  5. si une permission dédiée est nécessaire : une constante AREA_<SECTION>_SHOW_* lue avec Auth::env()
  6. tester en tant qu'utilisateur data-entry, pas seulement en admin : c'est là qu'on découvre les permissions manquantes

6. L'interface : ce qu'il faut savoir avant d'y toucher

  • Le thème actif est « gallery » (Foundation). Le skin des interventions est themes/admin/css/ff-skin.css. Les widgets HTML sont générés par themes/responsive/ff/.
  • Le thème de base de jQuery UI répond 404 à cause d'un enregistrement BD au chemin erroné : dialogues, sliders et spinners sont stylés à la main. C'est une raison, pas un caprice : remettre le thème de base change l'apparence de tout le backend.
  • Les popups sont des dialogues jQuery UI avec modal:false : le fond est .ff-modal, la boîte est .ui-dialog.ff-modal-dialog. Le contenu arrive en AJAX comme fragment avec seulement .ffRecord (pas de #frmMain).

    Conséquence : les hooks JS et les règles CSS doivent être délégués (jQuery(document).on("click", ".tabs A", …)) et limités à .ffRecord. Un handler inline n'accroche jamais le contenu d'un dialogue.

  • La dialogClass doit être nettoyée des tokens purement visuels : le wrapper du dialogue héritait de la classe hidden du bouton qui l'ouvre, et le dialogue naissait invisible.
  • Admin toolbar (barre d'édition au survol sur le front-end) : masquée par défaut (ADMIN_TOOLBAR_HIDDEN = true dans conf/gallery/config.php) ; on la réactive en la définissant à false dans le config.remote.php du projet. Son contenu vient du bus des services, entrée admin (voir 03 §3).
  • Vérification de l'interface sans connexion : une maquette HTML qui lie les CSS réels plus le DOM du composant, et des captures avec Chrome headless. Pour les dialogues il faut une largeur en px inline sur .ui-dialog-content.

L'historique des interventions sur le backend est dans FIX_FUNZIONAMENTO.md (comportement) et MIGLIORIE_ESTETICHE.md (CSS/UI uniquement). Les interventions CSS se marquent avec /* INTERVENTO CSS - GP AAAA-MM */.

7. Le reste du backend

En plus de manage/, conf/gallery/ contient des espaces fonctionnels hérités de l'upstream :

DossierEspace
api/REST interne (04)
backup/, import/, updater/, checker/maintenance, import/export, mise à jour, vérifications
job/jobs système (05 §3)
install/installeur legacy : sur un site installé il ne s'ouvre que depuis /admin/configuration/install (derrière la connexion) ; la /install publique répond 404 (voir 01 §2)
mc/mail center
modules/modules fonctionnels (10)
search/recherche
services/services tiers (10 §3)
sitemap/sitemap legacy (JoeCMS utilise modules/cms-common/models/Sitemap.php)
sys/services système et bus (03 §3)