Retour : page principale > sommaire applications générales > Documentation TBFramework

---

Arborescence par défaut simple d'une interface web utilisant le TBFramework

Arborescence de mon_application

• bibliotheque : contient les fichiers de codes php (pas de html, css, ou js)
• configurations : contient les différents fichiers de configurations en fonction du contexte
  • config.ini : fichier par défaut de l'application qui est chargé quoi qu'il arrive et qui va écraser les paramètres de config définis dans le config.ini du TBFramework.
  • config_papyrus.ini : fichier chargé dans un contexte Papyrus. Ecrase les paramètres définis dans config.ini.
  • config_cli.ini : fichier chargé dans un contexte d'execution de PHP en ligne de commande (CLI).
• controleurs : contient les fichiers contrôleurs de l'application, c'est eux qui appelle les classes métiers ( = modèles) et les squelettes.
  • AppControleur.php contrôleur de base d'une application, répartit automatiquement les demandes dans les modules et appelle les fonctions suivant ce qui est passé dans l'url.
  • aControleur.php controleur abstrait dont héritent les controleurs de l'application, peut contenir des méthodes utilitaires statiques utilisables partout dans l'appli (notamment pour la génération des urls).
• i18n : contient des fichiers ini pour chaque langue dans laquelle les paramètres généraux de l'appli ont été traduits
• modeles : contient les classes métiers permettant l'accès aux données (d'une base de données, de services web...) de l'application.
  • MaClasseMetierDao.php : deux solutions :
    • soit la classe hérite de la classe RestClient du TBF. Cette dernière contient les méthodes nécessaires pour effectuer des requêtes HTTP et en récupérer le contenu. Cette architecture est préférable à l'utilisation de modèles interrogeant directement les bases données car ceci force l'indépendance entre la couche modèle et les couches vues et contrôleurs, et permet la réutilisation des webs services (pour la partie serveur REST / modèle, voir la section Arborescence de services web REST).
    • soit la classe utilise directement la classe Bdd du TBF. Cette dernière contient les méthodes nécessaires pour se connecter et réaliser des requêtes dans une base de données.
• presentations : les fichiers pour la partie présentation de l'interface : styles, images, scripts et squelettes.
  • images : contient les images utilisées par l'application et les squelettes.
  • styles : contient les fichiers de styles (CSS) spécifiques à l'application.
  • scripts : contient les bibliothèques Javascript et les script Javascript de l'application.
  • squelettes : les fichiers squelettes PHP (= HTML contenant du PHP imbriqué avec l'utilisation de la syntaxe altenative PHP) de l'application.
• framework.defaut.php : est un fichier à commiter dans le SVN. Il doit être renommé sans le ".defaut" pour être utilisé en fonction de l'installation courante.
• framework.php : contient le chemin vers le framework en fonction de l'installation courante. Correspond au fichier framework.defaut.php renommé.
• mon_appli.php : contient l'initialisation de l'application et l'appel au controleur principal.
• mon_appli_papyrus.php : contient l'initialisation de l'application, permettant de l'appeler à travers papyrus en ayant enregistré l'application.
• index.php : fichier permettant d'appeler l'application en "stand alone" dans une page à part.

Placer le contenu dans le squelette d'une page

Les controleurs héritant de la classe aControleur disposent de la méthode setSortie(emplacement, contenu) qui permet de placer un contenu généré par l'application à un endroit donné grâce à des constantes suivantes :

• self::RENDU_TETE
• self::RENDU_NAVIGATION
• self::RENDU_CORPS
• self::RENDU_PIED
• self::META_TITRE
• self::META_DESCRIPTION
• self::META_TAGS

L'appel aux fonctions suivantes restitue le contenu enregistré grâce à setSortie:

• AppControleur::getMetaTitre();
• AppControleur::getMetaDescription();
• AppControleur::getMetaTags();
• AppControleur::getContenuNavigation();
• AppControleur::getContenuTete();
• AppControleur::getContenuCorps();
• AppControleur::getContenuPied();

Le développeur peut éventuellement faire appel à des fonctions particulières dont le contenu est rempli automatiquement :

• AppControleur::getChrono() qui affiche le temps d'éxécution de l'application
• AppControleur::getExceptions() qui affiche les erreurs générées par l'application

Ces dernières méthodes sont à utiliser au sein du squelette PHP principale de l'application (généralement le fichier index.php).

Afficher le contenu dans une page du CMS Papyrus

Pour placer le contenu dans une page du CMS Papyrus, il suffit de redéfinir les fonction d'affichage de papyrus : afficherContenuCorps, afficherContenuTete, etc...
Voir l'exemple de fichier principal d'une application pour Papyrus

Afficher le contenu dans une application stand alone

Il suffit de placer les appels au fonction de restitution du contenu dans le squelette PHP index.php.
Voir l'exemple de fichier principal d'une application stand alone

---