Le framework

openMairie_exemple est le framework de base dans lequel vous pouvez développer votre propre application.

openMairie_exemple est téléchargeable sur le site de l’adullact.

Il est proposé ici de décrire le fonctionnement du framework.

« En programmation orientée objet un framework est typiquement composé de classes mères qui seront dérivées et étendues par héritage en fonction des besoins spécifiques à chaque logiciel qui utilise le framework ».

http://fr.wikipedia.org/wiki/Framework

Dans un environnement LAMP/WAMP, le framework openMairie intègre des composants au travers de classes qui permettent de créer des formulaires et des états. Ces classes sont surchargées par les objets métier à créer.

openMairie intègre de nombreux composants : DBPEAR et FPDF dans toutes les applications, mais aussi ARTISHOW (pour les graphes), JQUERY pour l’ergonomie, OPENLAYERS pour l interface SIG …

DBPEAR est un abstracteur de base de données qui permet d’utiliser diverses bases de données notamment MYSQL ou POSTGRESQL.

FPDF est le composant qui permet de gérer le PDF.

Le développement consiste à créer des objets métier qui surchargent la classe abstraite om_dbformdyn.class.php (composant openMairie). De base, les données de la base de données sont récupérées pour le formulaire (longueur, max, nom).

• om_dbformdyn.class.php ; assure la liaison entre le formulaire et la base de données
• om_formulaire.class.php : rassemble toutes les méthodes permettant de construire des formulaires

Ce chapitre propose de vous décrire les outils de base du framework de la manière suivante :

• le paramétrage général du framework en /dyn
• les méthodes pour construire des formulaires avec le framework
• les outils d’édition du framework
• l’outil de requête paramétrable du framework
• la gestion des accès du framework ainsi que la gestion multi-collectivite
• l’ergonomie intégrant jquery
• la gestion de traitement et la construction de programme spécifiques avec les utilitaires
• l’import des données CSV du framework

• 1. Arborescence
  • 1.1. Les répertoires spécifiques à l’applicatif
    • 1.1.1. data/
    • 1.1.2. app/
    • 1.1.3. dyn/
    • 1.1.4. gen/
    • 1.1.5. locales/
    • 1.1.6. obj/
    • 1.1.7. sql/
    • 1.1.8. tests/
    • 1.1.9. tmp/
    • 1.1.10. trs/
  • 1.2. Les répertoires du framework
    • 1.2.1. php/
    • 1.2.2. core/
    • 1.2.3. css/
    • 1.2.4. img/
    • 1.2.5. js/
    • 1.2.6. lib/
    • 1.2.7. pdf/
    • 1.2.8. scr/
    • 1.2.9. spg/
• 2. Initialisation de la base de données
  • 2.1. Description du dossier data/pgsql/
    • 2.1.1. Description de tous les fichiers init*.sql
      • 2.1.1.1. Le fichier init.sql
      • 2.1.1.2. Les fichiers init_metier*.sql
      • 2.1.1.3. Les fichiers init_parametrage*.sql
      • 2.1.1.4. Le fichier init_data.sql
    • 2.1.2. Description des fichiers vX.X.X.sql ou ver_X.X.X.sql
    • 2.1.3. Description du fichier update_sequences.sql
    • 2.1.4. Description du fichier install.sql
  • 2.2. Paramétrage de la connexion à la base de données
• 3. Paramétrage du framework
  • 3.1. Les zones de navigation
    • 3.1.1. Le menu
    • 3.1.2. Les actions personnelles
    • 3.1.3. Les raccourcis
    • 3.1.4. Les actions globales
  • 3.2. Le tableau de bord
  • 3.3. Les variables locales et la langue
  • 3.4. Le paramétrage de l application metier
  • 3.5. Le Parametrage des librairies
  • 3.6. Le mode DEBUG
  • 3.7. La version de votre application
  • 3.8. Les informations generales
  • 3.9. L’installation automatique
  • 3.10. Les paramétres des combos
  • 3.11. Les paramétres éditions
  • 3.12. Les paramétres om_sig
• 4. Afficher les tables
  • 4.1. Les script scr/tab.php et scr/soustab.php
  • 4.2. La requête SQL d’affichage
  • 4.3. Le composant openMairie
• 5. La recherche avancée
  • 5.1. Les différents types de recherche
    • 5.1.1. Recherche simple
    • 5.1.2. Recherche avancée
      • 5.1.2.1. Recherche avancée mono-critère
      • 5.1.2.2. Recherche avancée multi-critères
  • 5.2. Configuration de la recherche avancée
    • 5.2.1. Activation
    • 5.2.2. Autres paramètres
  • 5.3. Configuration des critères de recherche
    • 5.3.1. Configuration simple
    • 5.3.2. Configuration avancée
      • 5.3.2.1. Créer un intervalle de date
      • 5.3.2.2. Créer un champ de recherche avec menu déroulant personnalisé
      • 5.3.2.3. Tester si une donnée est présente ou non dans un groupe de données
• 6. Les formulaires
  • 6.1. Introduction
    • 6.1.1. Consultation
    • 6.1.2. Ajout
    • 6.1.3. Modification
    • 6.1.4. Suppression
    • 6.1.5. Accès
  • 6.2. Description technique
    • 6.2.1. scr/form.php et scr/sousform.php
  • 6.3. Description de la classe dbform
    • 6.3.1. Présentation des méthodes de la classe
    • 6.3.2. Méthodes d’initialisation de l’affichage du formulaire
    • 6.3.3. Méthodes d’actions
    • 6.3.4. Gestion des transactions lors de l’appel aux méthodes d’actions
    • 6.3.5. Méthodes appelées lors de la validation
  • 6.4. Description de la classe formulaire
    • 6.4.1. Méthodes d’affichage de widgets
    • 6.4.2. Les méthodes de construction et d’affichage
    • 6.4.3. Les méthodes assesseurs changent les valeurs des attributs de l’objet formulaire
• 7. Les actions vers formulaires
  • 7.1. Actions des tableaux
    • 7.1.1. Les actions par défaut
    • 7.1.2. Créer de nouvelles actions
      • 7.1.2.1. Définition de l’action
      • 7.1.2.2. Définition du mode d’affichage en sous-tableau
      • 7.1.2.3. Définition de l’ordre d’affichage
      • 7.1.2.4. Définition des droits d’affichage
  • 7.2. Actions du menu contextuel de la consultation
• 8. La méthode
  • 8.1. Surcharger les classes openMairie
  • 8.2. L’objet db
  • 8.3. L’objet form
• 9. Les éditions
  • 9.1. Actif, non actif
  • 9.2. Paramétrer des états
  • 9.3. Paramétrer des sous-états
  • 9.4. Paramétrer des lettres-type
  • 9.5. Paramétrer des édition PDF
  • 9.6. Paramétrer les étiquettes
  • 9.7. L’éditeur WYSIWYG
  • 9.8. Les scripts PDF
  • 9.9. Composants
• 10. Les requêtes memorisées
  • 10.1. Description du parametrage
  • 10.2. Exemple
• 11. La gestion des accès
  • 11.1. Les tables
  • 11.2. Les règles
  • 11.3. La multi-collectivité
  • 11.4. Les login et logout
  • 11.5. Les utilitaires
• 12. Tableau de bord et widgets
  • 12.1. principe
    • 12.1.1. paramétrage
    • 12.1.2. les widgets
    • 12.1.3. le tableau de bord paramètrable
  • 12.2. widget
    • 12.2.1. la création de widget
    • 12.2.2. Les widgets internes
    • 12.2.3. Les widgets externes
  • 12.3. le tableau de bord paramétrable
    • 12.3.1. accès au tableau de bord
    • 12.3.2. la table om_tdb
• 13. L’ergonomie
  • 13.1. Le composant jquery
  • 13.2. Les feuilles de style
• 14. Les scripts specifiques de l’application
  • 14.1. Réaliser un script complementaire
  • 14.2. Exemple
• 15. Importer des données en csv
• 16. Abstraction du “layout” (ergonomie)
• 17. Abstraction du “filestorage” (stockage des fichiers)
  • 17.1. Principe général
  • 17.2. Fonctionnement
    • 17.2.1. Description de l’abstracteur
    • 17.2.2. Description du fichier de configuration
    • 17.2.3. Description des méthodes de la classe filestorage
    • 17.2.4. Description du connecteur depredacted
    • 17.2.5. Description du connecteur filesystem
    • 17.2.6. Description du connecteur filetransferprotocol
    • 17.2.7. Description du connecteur alfresco
  • 17.3. Utilisation
    • 17.3.1. Configuration du widget Upload
      • 17.3.1.1. Contraintes
      • 17.3.1.2. Métadonnées
    • 17.3.2. Récupération du fichier
    • 17.3.3. Scripts permettant de visualiser / d’accéder au fichier
      • 17.3.3.1. spg/file.php
      • 17.3.3.2. spg/voir.php