Manuel de référence¶
Il est proposé ici de décrire le fonctionnement du framework openMairie.
« 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
openMairie intègre de nombreux composants :
- FPDF : http://fpdf.org/
- TCPDF : https://tcpdf.org/
- DBPEAR : http://pear.php.net/package/DB/redirected
- PHPMailer : https://github.com/PHPMailer/PHPMailer
- JQUERY : https://jquery.com/
- JQUERY-UI : http://jqueryui.com/
- OPENLAYERS : https://openlayers.org/
- TINYMCE : https://www.tinymce.com/
Le framework est composé de 2 classes principales :
om_dbform est une classe abstraite surchargée par les objets métiers qui fait le lien entre la base de données et le formulaire
om_formulaire est la classe qui construit le formulaire en utilisant l’objet form.
Les classes métiers sont générées par le générateur une fois la base de données créées et surchargent la classe abstraite om_dbform.
Enfin, il est possible de surcharger les classes métiers par des classes customisées.
- 1. Arborescence
- 2. Initialisation de la base de données
- 3. Paramétrage du framework
- 3.1. Introduction
- 3.2. Les scripts de paramétrage
- 3.3. Le serveur d’envoi de mail
- 3.4. L’annuaire LDAP
- 3.5. Les zones de navigation
- 3.6. Les variables locales et la langue
- 3.7. Le paramétrage de l application metier
- 3.7.1. Le nom de l’application
- 3.7.2. Le titre HTML de l’application
- 3.7.3. Le nom de la session
- 3.7.4. Le mode démonstration
- 3.7.5. La redéfinition du mot de passe oublié par l’utilisateur
- 3.7.6. Le nombre de colonnes du tableau de bord
- 3.7.7. Le favicon de l’application
- 3.7.8. Le mode de gestion des permissions
- 3.7.9. La valeur par défaut lorsqu’une permission n’existe pas
- 3.7.10. Les extensions de fichiers autorisées
- 3.7.11. La taille maximale de fichiers autorisée
- 3.8. Le Parametrage des librairies
- 3.9. Le mode DEBUG
- 3.10. La version de votre application
- 3.11. Les informations generales
- 3.12. L’installation automatique
- 3.13. Les paramétres des combos
- 3.14. Les paramétres éditions
- 3.15. Les paramétres om_sig
- 4. La gestion des accès
- 5. Le tableau de bord
- 6. Les listings
- 6.1. Introduction
- 6.2. Les scripts scr/tab.php et scr/soustab.php
- 6.3. Configuration
- 6.4. Actions des tableaux
- 6.5. Les fonctionnalités
- 6.6. Le composant openMairie
- 7. Les formulaires
- 7.1. Introduction
- 7.2. Les scripts scr/form.php et scr/sousform.php
- 7.3. Configuration via le script
sql/pgsql/<OBJ>.inc.php
- 7.4. Configuration via le script
sql/pgsql/<OBJ>.form.inc.php
- 7.5. Les fonctions
- 7.6. Actions du menu contextuel de la consultation
- 7.7. Description de la classe dbform
- 7.7.1. Présentation des méthodes de la classe
- 7.7.2. Méthodes d’initialisation de l’affichage du formulaire
- 7.7.3. Méthodes d’actions (TREATMENT)
- 7.7.4. Gestion des transactions lors de l’appel aux méthodes d’actions
- 7.7.5. Méthodes appelées lors de la validation
- 7.7.6. Méthodes permettant d’afficher des informations spécifiques.
- 7.8. Description de la classe formulaire
- 8. Module “Édition”
- 8.1. Introduction
- 8.2. Les états et lettres types
- 8.2.1. Paramétrer des états
- 8.2.2. Paramétrer des lettres-type
- 8.2.3. Actif, non actif
- 8.2.4. Les requêtes
- 8.2.5. Les sous-états
- 8.2.6. Les champs de fusion
- 8.2.7. Les variables de remplacement
- 8.2.8. Les logos
- 8.2.9. L’éditeur WYSIWYG
- 8.2.10. Les anciens fichiers de paramétrage
- 8.2.11. La prévisualisation
- 8.3. Les listings
- 8.4. Les étiquettes
- 8.5. Composants
- 9. Module “Import”
- 10. Module “Reqmo”
- 11. Modules Géographiques
- 11.1. Module om_sig
- 11.1.1. la nouvelle architecture
- 11.1.1.1. tab_sig.php
- 11.1.1.2. form_sig.php
- 11.1.1.3. spg/map_compute_geom.php
- 11.1.1.4. spg/map_get_filters.php
- 11.1.1.5. spg/map_get_geojson_cart.php
- 11.1.1.6. spg/map_get_geojson_markers.php
- 11.1.1.7. spg/map_redirection_onglet.php
- 11.1.1.8. scr/export_sig.php
- 11.1.1.9. scr/requeteur.php
- 11.1.1.10. Nouvelles images dans img/ et nouvelle css pour l’interface om_sig
- 11.1.2. La classe om_map.class.php
- 11.1.3. Le java script
- 11.1.4. Integration de la version 4.4.x en 4.4.5 :
- 11.1.5. Reprise des evolutions de la 4.4.0
- 11.1.1. la nouvelle architecture
- 11.2. Module d’adresse
- 11.1. Module om_sig
- 12. Abstraction du “layout” (ergonomie)
- 13. Abstraction du “filestorage” (stockage des fichiers)
- 13.1. Principe général
- 13.2. Fonctionnement
- 13.2.1. Description de l’abstracteur
- 13.2.2. Description du fichier de configuration
- 13.2.3. Description des méthodes de la classe filestorage
- 13.2.4. Description du connecteur depredacted
- 13.2.5. Description du connecteur filesystem
- 13.2.6. Description du connecteur filetransferprotocol
- 13.2.7. Description du connecteur alfresco
- 13.3. Utilisation