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
  • 1.1. Introduction
  • 1.2. Les répertoires spécifiques à l’applicatif
    • 1.2.1. app/
    • 1.2.2. data/
    • 1.2.3. dyn/
    • 1.2.4. gen/
    • 1.2.5. locales/
    • 1.2.6. obj/
    • 1.2.7. sql/
    • 1.2.8. tests/
    • 1.2.9. var/
  • 1.3. Les répertoires du framework
    • 1.3.1. core/
    • 1.3.2. php/
    • 1.3.3. lib/
  • 1.4. Les anciens répertoires du framework
    • 1.4.1. css/
    • 1.4.2. img/
    • 1.4.3. js/
    • 1.4.4. pdf/
    • 1.4.5. scr/
    • 1.4.6. 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. 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.5.1. Le menu
    • 3.5.2. Les actions personnelles
    • 3.5.3. Les raccourcis
    • 3.5.4. Les actions globales
  • 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
  • 4.1. Introduction
  • 4.2. Fonctionnalités
  • 4.3. Les tables
  • 4.4. Les règles
  • 4.5. La multi-collectivité
  • 4.6. L’écran de connexion
  • 4.7. L’écran de déconnexion
  • 4.8. L’écran de changement du mot de passe
• 5. Le tableau de bord
  • 5.1. Principe
    • 5.1.1. les widgets
    • 5.1.2. le tableau de bord paramétrable
  • 5.2. widget
    • 5.2.1. la création de widget
    • 5.2.2. Le widget de type “Web”
      • 5.2.2.1. interne
      • 5.2.2.2. externe
    • 5.2.3. Le widget de type “Script”
    • 5.2.4. Modèle de données
  • 5.3. Les tableaux de bord
    • 5.3.1. accès au tableau de bord
    • 5.3.2. Modèle de données
• 6. Les listings
  • 6.1. Introduction
  • 6.2. Les éléments tab et soustab
    • 6.2.1. tab
    • 6.2.2. soustab
  • 6.3. Configuration
    • 6.3.1. $ent
    • 6.3.2. $serie
    • 6.3.3. $table
    • 6.3.4. $champAffiche
    • 6.3.5. $champRecherche
    • 6.3.6. $tri
    • 6.3.7. $selection
    • 6.3.8. $edition
    • 6.3.9. $tab_title
    • 6.3.10. $tab_description
    • 6.3.11. $tab_actions
  • 6.4. Actions des tableaux
    • 6.4.1. Les actions par défaut
    • 6.4.2. Créer de nouvelles actions
      • 6.4.2.1. Définition de l’action
      • 6.4.2.2. Définition du mode d’affichage en sous-tableau
      • 6.4.2.3. Définition de l’ordre d’affichage
      • 6.4.2.4. Définition des droits d’affichage
  • 6.5. Les fonctionnalités
    • 6.5.1. Le tri
      • 6.5.1.1. Premier clic pour le tri croissant
      • 6.5.1.2. Second clic pour le tri décroissant
      • 6.5.1.3. Troisième clic pour aucun tri particulier
    • 6.5.2. L’export CSV
    • 6.5.3. La recherche avancée
      • 6.5.3.1. Les différents types de recherche
        • 6.5.3.1.1. Recherche simple
        • 6.5.3.1.2. Recherche avancée
          • 6.5.3.1.2.1. Recherche avancée mono-critère
          • 6.5.3.1.2.2. Recherche avancée multi-critères
      • 6.5.3.2. Configuration de la recherche avancée
        • 6.5.3.2.1. Activation
        • 6.5.3.2.2. Autres paramètres
      • 6.5.3.3. Configuration des critères de recherche
        • 6.5.3.3.1. Configuration simple
        • 6.5.3.3.2. Configuration avancée
          • 6.5.3.3.2.1. Créer un intervalle de date
          • 6.5.3.3.2.2. Créer un champ de recherche avec menu déroulant personnalisé
          • 6.5.3.3.2.3. Tester si une donnée est présente ou non dans un groupe de données
  • 6.6. Les composants
• 7. Les formulaires
  • 7.1. Introduction
    • 7.1.1. Consultation
    • 7.1.2. Ajout
    • 7.1.3. Modification
    • 7.1.4. Suppression
    • 7.1.5. Accès
  • 7.2. Les éléments form et sousform
    • 7.2.1. form
    • 7.2.2. sousform
  • 7.3. Configuration via le script sql/pgsql/<OBJ>.inc.php
    • 7.3.1. $ent
    • 7.3.2. $sousformulaire
    • 7.3.3. $sousformulaire_parameters
  • 7.4. Configuration via le script sql/pgsql/<OBJ>.form.inc.php
    • 7.4.1. $form_title
  • 7.5. Les fonctions
    • 7.5.1. La fonction verrou
    • 7.5.2. La fonction directlink
  • 7.6. Actions du menu contextuel de la consultation
    • 7.6.1. Définition des actions dans les attributs de la classe de l’objet
    • 7.6.2. CRUD
    • 7.6.3. Définition des actions dans *.form.inc.php (obsolète)
  • 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
    • 7.8.1. Le widget de formulaire
    • 7.8.2. Le snippet de formulaire
    • 7.8.3. Les méthodes de construction et d’affichage
    • 7.8.4. Les méthodes assesseurs changent les valeurs des attributs de l’objet formulaire
  • 7.9. Custom de l’application
  • 7.10. Les composants
• 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.4.1. Description
        • 8.2.4.1.1. SQL
        • 8.2.4.1.2. OBJET
      • 8.2.4.2. Modèle de données
    • 8.2.5. Les sous-états
    • 8.2.6. Les champs de fusion
    • 8.2.7. Les variables de remplacement
      • 8.2.7.1. Les fichiers de configuration ../dyn/var*pdf.inc
      • 8.2.7.2. Les méthodes globales de la classe du fichier ../obj/om_dbform.class.php
      • 8.2.7.3. La table de paramètres om_parametre
    • 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.3.1. Description de la fonctionnalité
    • 8.3.2. Le fichier de paramétrage ../sql/pgsql/<OBJ>.pdf.inc.php
  • 8.4. Les étiquettes
    • 8.4.1. Description de la fonctionnalité
    • 8.4.2. Le fichier de paramétrage ../sql/pgsql/<OBJ>.pdfetiquette.inc.php
  • 8.5. Composants
• 9. Module “Import”
  • 9.1. Principe
  • 9.2. Paramétrage
    • 9.2.1. Le script de paramétrage ../sql/pgsql/<OBJ>.import.inc.php
  • 9.3. Composants
• 10. Module “Reqmo”
  • 10.1. Principe
  • 10.2. Paramétrage
    • 10.2.1. Le script de paramétrage ../sql/pgsql/<OBJ>.reqmo.inc.php
  • 10.3. Composants
• 11. Module “MAP”/”SIG”
  • 11.1. Architecture
    • 11.1.1. tab_sig
    • 11.1.2. form_sig
    • 11.1.3. map_compute_geom
    • 11.1.4. map_get_filters
    • 11.1.5. map_get_geojson_cart
    • 11.1.6. map_get_geojson_markers
    • 11.1.7. map_redirection_onglet
    • 11.1.8. export_sig
    • 11.1.9. reqmo
    • 11.1.10. Nouvelles images dans img/ et nouvelle css pour l’interface om_sig
  • 11.2. La classe om_map.class.php
    • 11.2.1. Les variables globales
    • 11.2.2. Les methodes
  • 11.3. Le java script
  • 11.4. Modèle de données
• 12. Abstraction du “layout” (ergonomie)
  • 12.1. Le composant jquery
  • 12.2. Les feuilles de style
• 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
    • 13.3.1. Configuration du widget Upload
      • 13.3.1.1. Contraintes
      • 13.3.1.2. Métadonnées
    • 13.3.2. Récupération du fichier
    • 13.3.3. Scripts permettant de visualiser / d’accéder au fichier
      • 13.3.3.1. snippet file
      • 13.3.3.2. snippet voir