openMairie Framework 4.4 documentation

Note

Cette création est mise à disposition selon le Contrat Paternité-Partage des Conditions Initiales à l’Identique 2.0 France disponible en ligne http://creativecommons.org/licenses/by-sa/2.0/fr/ ou par courrier postal à Creative Commons, 171 Second Street, Suite 300, San Francisco, California 94105, USA.

Ce document a pour but de guider les développeurs dans la mise en œuvre d’un projet openMairie.

Avec plus de 30 applications développées pour les collectivités locales accessibles sur le site http://openmairie.org, nous souhaitons au travers de ce guide , diffuser notre expérience auprès des collectivités et des acteurs économiques du libre qui les accompagnent.

C’est donc une méthode conçue au fur à mesure de nos développements que nous vous proposons de partager et toutes remarques sont les bienvenues, alors n’hésitez pas à nous en faire part à l’adresse mail suivante : contact@openmairie.org

Nous avons conçu openMairie pour fabriquer une maquette le plus en amont possible en s’appuyant sur le modèle de données créé dans la base de données et en intégrant les composants standards du « monde libre ».

Cette maquette permet très rapidement d’engager un dialogue participatif avec les utilisateurs, de concentrer le développeur uniquement sur le « métier » et de faire valider par l’utilisateur les évolutions successives.

Si vous débutez, il est préférable de commencer par le chapitre « créer une application » qui permet de prendre en main facilement le générateur et le framework openMairie en vous guidant pas à pas dans le mise en place d’une gestion de courrier.

Le chapitre sur le « framework » complète l’exemple ci dessus en vous décrivant le paramétrage, les classes formulaires et éditions du framework. Il a pour but de vous informer de manière complète sur le fonctionnement du framework

Le chapitre consacré au « générateur » décrit dans le détail le fonctionnement de cet outil et de ses assistants. Cet outil permet de fabriquer la maquette.

La version 4.1.0 permet de construire des applications composites (ou mash up) en intégrant des contenus venant d’application externes. Cela permet de construire rapidement une application à faible coût grâce à la fusion de multiple service internet

Le chapitre consacré a l” « information géographique » décrit dans le détail le fonctionnement SIG interne d’openMairie combinant les API d’internet avec le framework. (La version 4.2.0 améliore l’interface avec l’intégration de web service)

Enfin ce document rassemble toutes les règles de codage du projet openMairie, ainsi que des outils pour aider et guider les développeurs de la communauté.

Les règles indiquées doivent être appliquées pour qu’un projet puisse intégrer la distribution openMairie car l’objectif est de faciliter la lisibilité et la maintenance du code ainsi que la prise en main par les collectivités.

Bonne lecture !

Tutoriel - Créer une application

• Tutoriel - Créer une application
  • Créer la base de données
  • Créer les formulaires
    • Générer les formulaires et édition du courrier
    • Générer les formulaires et édition de l’emetteur
    • Générer les formulaires et édition de service
    • Intégrer les formulaires dans le menu
    • Menu
  • Personnaliser son application
    • Faire un affichage courrier plus convivial
    • Rendre obligatoire des champs
    • Valoriser un champ par défaut
    • Mettre en majuscule un champ
    • Principe à retenir
  • Modifier la base et regénérer
    • Rajouter un champ registre dans courrier
    • Rajouter l’adresse dans emetteur
    • Améliorer la présentation du formulaire emetteur
    • Les surcharges d’openCimetiere
  • Créer ses états
    • Créer l’état service
    • Créer le sous-état courrier
    • Associer le sous-état courrier à l’état service
    • Mettre le nom et le prénom de l’emetteur dans le sous-état

Le framework

• Le 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

Le générateur

• Le générateur
  • 1. Introduction
  • 2. L’interface
    • 2.1. Analyse de la base
    • 2.2. Les fichiers à générer
  • 3. Conditions de génération
    • 3.1. Contraintes de la base de données
    • 3.2. Contraintes du système de fichiers
  • 4. Définition des modèles de données
    • 4.1. L’identifiant
      • 4.1.1. Définition de l’identifiant
      • 4.1.2. Fonctionnement interne du générateur
    • 4.2. Les références vers d’autres objets
      • 4.2.1. Définition des références
        • 4.2.1.1. Avec PostgresSQL
      • 4.2.2. Fonctionnement interne du générateur
      • 4.2.3. Affichage dans les formulaires
    • 4.3. Les champs uniques
      • 4.3.1. Définition des champs uniques
      • 4.3.2. Fonctionnement interne du générateur
      • 4.3.3. Affichage dans les formulaires
    • 4.4. Les champs requis
      • 4.4.1. Définition des champs requis
      • 4.4.2. Fonctionnement interne du générateur
      • 4.4.3. Affichage dans les formulaires
    • 4.5. Le champ libellé
      • 4.5.1. Définition du libellé
  • 5. Fonctionnalités avancées
    • 5.1. Ajouter une date de validité à un modèle
      • 5.1.1. Description
      • 5.1.2. Définition des dates de validité
      • 5.1.3. Affichage dans les formulaires
  • 6. L’analyse de la base
    • 6.1. Type de champs
    • 6.2. Equivalence type pgsql / type openMairie
    • 6.3. Nom de champ et nom de table
  • 7. Les fichiers générés
    • 7.1. Les formulaires
      • 7.1.1. Paramétres de type table
      • 7.1.2. Paramétres de type Form
    • 7.2. Les Objets « métier »
    • 7.3. Les états
    • 7.4. les requêtes mémorisées
    • 7.5. les imports
  • 8. Paramétrage générateur
    • 8.1. gen/dyn/gen.inc.php
    • 8.2. gen/dyn/tab.inc.php
    • 8.3. gen/dyn/form.inc.php
    • 8.4. gen/dyn/pdf.inc.php
    • 8.5. gen/dyn/etat.inc.php
    • 8.6. gen/dyn/sousetat.inc.php
    • 8.7. gen/dyn/lettretype.inc.php

L’information géographique

• L’information géographique
  • Principe
    • Géo localisation automatique
    • Affichage de carte
    • Paramétrage de la carte
  • objet map
  • afficher les layers
    • Les fonds
    • Les datas
    • Les flux wms
    • La notion de pannier
    • La géométrie à modifier : couche vectors :
    • Les géométries complémentaires
  • installation d’om_sig_map
    • optimisation composant openLayers
  • postgis
    • principes
    • base et schéma
  • geocodage
    • var_adresse_postale.inc
    • Mise en oeuvre dans un formulaire d’un bouton de la geolocalisation
  • data_sig
    • Saisir le périmètre de sa commune
    • Récupérer les données de l’IGN
    • Recupérer des données shape
    • Recupération des données de la DGI

Historique & Mises à niveau

• Historique & Mises à niveau
  • 1. La version 4.4
    • 1.1. Les nouveautés de la version 4.4
    • 1.2. Mettre à niveau depuis openMairie 4.3 vers 4.4
  • 2. La version 4.3
    • 2.1. Les nouveautés de la version 4.3
    • 2.2. Mettre à niveau depuis openMairie 4.2 vers 4.3
  • 3. La version 4.2
    • 3.1. Les nouveautés de la version 4.2
    • 3.2. Mettre à niveau depuis openMairie 4.1 vers 4.2

Règles

• Règles
  • Convention de codage
    • L’indentation du code
    • Encodage des fichiers
    • Tags dans le code PHP
    • HTML Valide et W3C
    • Les commentaires dans le code
    • Images
  • Versionnage
    • Convention de numérotation des versions
  • Documentation

Outils

• Outils
  • Apache Subversion (SVN)
  • Concurrent versions system (CVS)
  • GIT
  • Meld
  • POEdit
  • Sphinx
  • Github.com
  • readthedocs.org

Contributeurs

(par ordre alphabétique)

• atReal
• Thierry Benita
• Romain Beylerian
• Nicolas Haye
• Nicolas Meucci
• Florent Michon
• Virginie Pihour
• Francois Raynaud
• Sofien Timezouaght