Home

openMairie Framework Documentation

image

Contents

1. 6 1 Outils 137 openMairie Framework Documentation Version 4 5 Ici on voit que openmairie pointe vers le trunk Nous devons d abord publier la librairie E svn cp svn tssh lt NOM_DU_DEV svn ssh lt NOM DU _ DEV OPPEUR gt scm adullact net openmairie openmairie trunk OPPEUR gt scm adullact net openmairie openmairie tags lt NOUVELLE VERSI T Le message pourra tre Tag openmairie lt NOUVELLE_VERSION gt Ensuite il faut changer les EXTERNAL S txt On remplace dans le fichier php EXTERNALS txt le trunk par la nouvelle version vim php EXTERNALS txt created by svn propset svn externals F EXTERNALS txt openmairie svn scm adullact net svnroot openmairie openmairie tags lt NOUVELLE_VERSION gt fpdf svn scm adullact net svnroot openmairie externals fpdf tags 1 6 min pear http svn php net repository pear pear core tags PEAR 1 9 1 db http svn php net repository pear packages DB tags RELEASE_1_7_13 Ensuite on applique le nouveau propset externals une fois plac dans le dossier php Attention de ne pas oublier le dans la commande svn propset cd php svn propset svn externals F EXTERNALS txt svn up Ici en faisant un svn info sur le dossier openmairie nous devons obtenir une URL comme ceci svn info o
2. 89 31 10 13 ACE TOmMACIR ia seu sheet aire she ess 89 31 10 14 Les requ tes 44 sms t sue E aE e Ra 90 FAO FAT DesCuptlOn seie pie LAS See aa EE ra 4 90 3 1 10 1 42 M d l de d nn es s s p ce dus 6 8 8 e 6 8 800 6 6 3 8 74 90 FLAO LEs SOUS ETIE o 4 er d br 1 o a a Anh 90 3 1 10 1 6 Les Champs d fusion e cs ses sa sss ses RA 91 3 1 10 1 7 Les variables de remplacement o s s s ooo e 91 3 1 10 1 7 1 Les fichiers de configuration dyn var pdf inc 91 3 1 10 1 7 2 Les m thodes globales de la classe du fichier obj om_dbform class php 91 3 1 10 1 7 3 La table de param tres om parametre 91 FRIOS ESS TIOPOS s er a LT e o 38 Aa 91 3 1 10 19 L diteur WYSIWYG ena ei ea Par a oise 91 3 1 10 1 10 Les anciens fichiers de param trage lt 14 4214 91 3 1 10 111 La pr visuallSatl N comas 5040 808085187 6 A a A 92 310 2 Tes SRL ES 20 0 ri ds a A Nr 92 3 1 10 2 1 Description de la fonctionnalit 92 3 1 10 2 2 Le fichier de param trage sql pgsql lt 0BJ gt pdf inc php 92 3 110 L s tiquettes 52 5 a La uy 5 ue D oe mis rem eg 92 3 1 10 3 1 Description de la fonctionnalit 92 3 1 10 3 2 Le fichier de param trage sql pgsql lt OBJ gt pdfetiquette inc php 92 3 1 104 COMPOSANTS lt x ee sego emai ue gd 36 e amie ms es OM 92 341141 Module Import s s 4440 sidad A NE Arias 92 SUL Principe escas
3. 3 1 Manuel de r f rence 99 openMairie Framework Documentation Version 4 5 il faut saisir libelle du champ la collectivit l identifiant il doit tre unique pour chaque couche wms le lien de la couche http les layers de la couches s par s par une virgule Exemple de lien avec qgis serveur http localhost cgi bin qgis mapserv fcgi SERVICE WMS VERSION 1 3 0 map var www openfoncier trunk app qgis openfoncier qgs TD affectation des flux wms dans une carte est saisi dans om_sig_map_wms Il est saisi le nom du flux wms nom du layer sur la carte l ordre d affichage la visibilit par d faut case cocher Administration Om_sig map 3 DOSSIER Administration p Om sig map wms 12 cm_sig_man_wrrs 12 Mare MS parcelle E nom map OpenLayer RS orra R vatle par d bat z panier e nom du panier parceic caucha parate als pavele Champ encapsuiston z select astext st_unton geom as geom trom 408_PREFIXEgwcele where parcelle n lst rep re dist type de geometne potygone al opa res Sur la carte ci dessous le flux wms est activ et affiche le lotissement getMap En cliquant sur le lotissement il est possible d acc der aux donn es getFeature M Data 772 3 7 surtaco lotissement Feature version 4 4 0 Trois nouveaux param tres sont disponn
4. 70 3 1 6 3 2 M thodes d initialisation de l affichage du formulaire 70 3 1 6 3 3 M thodes d actions esci 5 4 4 8 msn sa seb setanss 73 3 1 6 3 4 Gestion des transactions lors de l appel aux m thodes d actions 73 3 1 6 3 5 M thodes appel es lors de la validation 73 3 1 6 4 Description de la classe formulaire 74 3 1 64 1 M thodes d affichage de widgets 74 3 1 6 4 2 Les m thodes de construction et d affichage 76 3 1 6 4 3 Les m thodes assesseurs changent les valeurs des attributs de l objet formulae cc nue NAS Si dere ARL sente sente 76 Les actions vers formulaires o s iac aaa a 98 d DE ein 4 77 3 1 7 1 Actions des tableaux oo coses 20h ds La A ax 77 31 71 Les actions par d faut db 34 e 4 Sant a ra s esiseuns 78 3 1 7 12 Cr er denouvelles actions ps x 84 vs roer A 78 3 1 7 1 2 1 D finition de Faction ezp sp 24 e erre 4 79 3 1 7 1 2 2 D finition du mode d affichage en sous tableau 79 31 74 23 D finition de l ordre d affichage 79 3 1 7 1 24 D finition des droits d affichage 79 3 1 7 2 Actions du menu contextuel de la consultation 79 3 1 7 2 1 D finition des actions dans les attributs de la classe de l objet 80 3 1 7 2 2 D finition des actions dans form inc php obsol te 80 La gestionmdes ACCES
5. 148 7 Contributeurs 149 openMairie Framework Documentation Version 4 5 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 cono miques 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 parta ger 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 l
6. 143 6 1 2 9 4 Etape 3 Cr er la structure du d p t 143 6 1 2 9 5 Etape 4 Importer le code sur le nouveau d p t Subversion 143 6 1 2 95 1 Cas aana Pharma ri AN er ele ras 143 61V205 27 A d beds Bre Ee A T le gt sis ode c i Ends l 122 e 143 l L rr A A e de de id 143 Melissa e e aa E EE ee os 144 BOBINE di 8 D ES A a ee RP E ane 144 6 1 5 1 Sp cification dans le code des cha nes traduire 144 6 1 5 2 Pr paration des dossiers de locales 144 6 1 5 3 Installation et configuration de POEdit 145 6 1 5 3 1 Installation occitano A serts sa 145 6 1 5 3 2 Gestion de plusieurs langues s po 42 00 44 du gui med 145 6 1 5 4 Configuration d un projet dans POEdit 145 6 155 5 Traduction deschanes 454444 Li taire ms tmie sis tes 145 SDS 8 a o Du et Dome BA Ne LAS 145 GUI DCOM e ds A E ADA AA 40 j BY 146 viii 6 1 2 1 Cr erunproj t ico po ia o a aa 146 6 1 7 2 Importer la documentation depuis un projet subversion de l adullact 146 6 1 7 3 Faire l import initial d un projet sphinx 147 6 1 7 4 Contribuer une documentation 147 Gks T ATINedOES DDR LD E ES RI Ne EU A A 147 6 1 8 1 Importer un nouveau projet sur RTD 147 6 1 8 2 Param trer une nouvelle version d un projet existant
7. Param trage g n ral du tableau Largeur Ce champ sert indiquer la largeur du tableau en UNIQUEMENT par rapport la largeur du PDF Par exemple si le PDF fait une largeur de 30 cm et que la lageur du tableau est de 10 le tableau fera 3 cm de largeur sur le PDF Hauteur Ce champ sert indiquer la hauteur du tableau en UNIQUEMENT par rapport la hauteur du PDF Par exemple si le PDF fait une hauteur de 50 cm et que la hauteur du tableau est de 25 le tableau fera 12 5 cm de hauteur sur le PDF Espacement inter cellules Espacement entre les cellules En pixel 26 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 Espace interne cellule Espacement entre les bords de la cellule et son contenu En pixel Bordure Epaisseur des bordures du tableau En pixel Titre Lorsque cette case est coch e elle permet de rajouter un titre au tableau Alignement Permet de choisir le type d alignement du texte dans le tableau Valeurs possibles n a aucun Gauche Centr Droite Supprimer un tableau Param trage des cellules Largeur Ce champ sert indiquer la largeur de la colonne en UNIQUEMENT par rapport la largeur du tableau Par exemple si le tableau fait une largeur de 30 cm et que la largeur de la colonne est de 10 la colonne fera 3 cm de largeur Hauteur Ce champ sert indiquer la hauteur de la
8. lt font gt lt a gt lt iframe gt lt noscript gt lt a href http www astroo com horoscope php target _blank gt horoscope lt a gt lt noscript gt lt FIN CODE ASTROO gt Acces un fil rss avec un module ajax google lt script src http www gmodules com ig ifr url http www ajaxgaier com iGoogle rss reader 2B xml up_title Actualit C35A9sS20atReal up_feed https3A52FS52Fwww atreal fr 2Fatreal 52Fcommunaute 2Factualites atrealS2FRf up_contentnr 98up_fontsize 96up_lineheight 70 up_titlelink sup_bullet 1 amp up_reload_feed 0 amp up_reload_fqcy 0 amp up_hl_background FFFFFF amp synd open amp w 2008 amp h 100 title stborder 523ffffff 57C3px52C1px solid 523999999860utput 3s gt lt script gt Affichage de photos avec flick r appel javascript lt table gt lt tr gt lt div class flick_r gt lt script type text javascript src http www flickr com badge_code_v2 gne count 3 edisplay latest size s amp layout h source user amp user 27995901 40N03 gt lt script gt lt div gt lt tr gt lt table gt Le widget de type Script app widget_example php lt php WIDGET DASHBOARD widget_example L objet de ce script est de fournir un exemple de widget de type Script package openmairie framework version SVN Id On instancie la classe utils uniquement si la variable f n est pas d j
9. Recherche avanc e Cette recherche est une fonctionnalit qui peut tre activ e et configur e manuellement pour un ou plusieurs tableaux donn s Elle permet de afficher un formulaire de recherche mono crit re permettant d effectuer des recherches strictes ou approxi matives afficher un formulaire de recherche multi crit res permettant d effectuer des recherches strictes ou ap proximatives rechercher des valeurs dans des tables et des colonnes qui ne sont pas affich es 3 1 5 1 2 1 Recherche avanc e mono crit re Le formulaire de recherche mono crit re est un formulaire ne s affichant que si la recherche avanc e est activ e Il permet aux utilisateurs de basculer sur un formulaire similaire celui de recherche simple lorsque la recherche avanc e est activ e Ce formulaire se comporte de la m me mani re que celui de recherche simple avec quelques diff rences il permet de rechercher des valeurs strictes ou approximatives par d faut approximatives il recherche dans toutes les colonnes propos es par la recherche simple il conserve les valeurs recherch es apr s la r alisation d une action ajout modification etc il dispose d un bouton Vider le formulaire permettant de vider les champs il dispose d un bouton permettant de basculer sur le formulaire multi crit res 3 1 5 1 2 2 Recherche avanc e multi crit res Le formulaire de recherche multi crit res est
10. l environnement de d veloppement l environnement de d monstration l environnement de tests Description des fichiers vX X X sql OU ver X X X sql Ces fichiers permettent de mettre jour les applicatifs d une version vers la version sup rieure Le X X X corres pond au num ro de version vers lequel la mise jour se fait et depuis la version juste pr c dente Lorsque le framework ou l applicatif est en d veloppement ce fichier peut tre suffix par dev et indique qu il n a pas encore t int gr aux diff rents fichiers init sql Juste avant une nouvelle version du framework les fichiers initx sql doivent tre reg n r s pour int gr s les derni res modifications et ce fichier renomm avec son nom vX X X sqlouver_X X X sql standard Description du fichier update _sequences sql Ce fichier permet de cr er une fonction capable de mettre jour toutes les s quences correctement li es aux champs auxquels elles se rattachent en fonction de la derni re valeur du champ dans la table En plus de la cr ation de la fonction ce script ex cute la fonction 50 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Description du fichier install sql Ce fichier permet d initialiser tous les fichiers qui sont d crits ci dessus dans le bon ordre Par d faut ce fichier installe la base de donn es et les donn es n cessaires aux trois environnements
11. svn st C openmairie_exemple trunk authors txt gt local dition suppression entrante sur mis jour svn revert openmairie exemple trunk authors txt openmairie_exemple trunk authors txt r initialis deplacer un dossier sur le svn gt commande mv Exemple on a cr trunk trunk dossiers_source D abord on renomme le premier dossier trunk en dossier branches gt svn mv svntssh fraynaud scm adullact net scmrepos svn openboisson trunk svn ssh fraynaud scm adullact net scmrepos svn openboisson branches cela fait branches trunk dossiers_souce gt svn mv svntssh fraynaud scm adullact net scmrepos svn openboisson branches trunk svn ssh fraynaud scm adullact net scmrepos svn openboisson trunk cela fait trunk dossiers_source creer deplacer autre exemple detruire un repertoire sur svn creer un dossier documentation sur svn depuis une copie loacle Ensuite on d place le dossier trunk qui se trouve maintenant dans branches a la racine du d p t svn import documentation svn ssh fraynaud scm adullact net scmrepos svn opencimeti re documenta renomer renommer sur le svn trunk en temp svn rename svn ssh fraynaud scm adullact net scmrepos svn opencimetiere documentation trunk svn ssh fraynaud scm adullact net scmrepos svn opencimetiere documentation temp move deplacer le dossier temp trunk vers trunk svn mv svn tssh fraynaud scm adullact
12. from_content data contient le contenu du fichier from_temporary data luid d un fichier enregistr sur le filesystem temporary from_path data contient le chemin du fichier enregistrer Cette m thode retourne l UUID du fichier enregistr filestorage update uid data metadonnees mode from_content Permet de mettre jour un fichier sur le filestorage data contenu du fichier metadonnees tableau contenant la liste des m tadonn es cle gt valeur mode from_content from_path from_content data contient le contenu du fichier from_temporary data luid d un fichier enregistr sur le filesystem temporary from_path data contient le chemin du fichier enregistrer Cette m thode retourne l UUID du fichier enregistr filestorage get uid Cette m thode retourne le contenu et les m tadonn es d un fichier en fonction de l UUID pass en para m tre filestorage delete uid Cette m thode supprime un fichier en fonction de l UUID pass en param tre filestorage create temporary data metadonnees mode from_content Permet de cr er un fichier sur le filestorage temporaire 3 1 Manuel de r f rence 111 openMairie Framework Documentation Version 4 5 data contenu du fichier metadonnees tableau contenant la liste des m tadonn es cle gt valeur mode from_content from_path
13. margeright 5 marge droite Sborder 1 1 gt bordure 0 gt pas de bordure C1 0 couleur texte R C2 0 couleur texte V C3 0 couleur texte B size 10 taille POLICE Sheight 4 6 hauteur ligne tableau Salign L fond 2 couleurs fond 1 0 gt FOND transparent 1 gt fond C1fond1 234 couleur fond R Y C2fond1 240 couleur fond V l C3fond1 245 couleur fond B C1fond2 255 couleur fond R C2fond2 255 couleur fond WV C3fond2 255 couleur fond B spe openelec Sflagsessionliste 0 1 gt affichage session liste ou 0 gt pas d affichage titre Sbordertitre 0 1 gt bordure 0 gt pas de bordure Saligntitre its JY LCR heightitre 10 hauteur ligne titre Sgrastitre B lf gras B gt BOLD OU Y gras Sfondtitre 0 0 gt FOND transparent 1 gt fond Cititrefond 181 couleur fond R SC2titrefond 182 couleur fond V C3titrefond 188 couleur fond B SCititre 75 couleur texte R C2titre 79 couleur texte V SC3titre 81 couleur texte B sizetitre 15 entete colonne flag_entete 1 entete colonne 0 gt non affichage 1 gt affichage fondentete 1 0 gt FOND transparent 1 gt fond Sheightentete 10 hauteur ligne entete colonne SCilfondentete 210 couleur fond R C2fondentete 216 couleur fond V C3fondentete 249 couleur fond B Clentetetxt 0 co
14. 23 openMairie Framework Documentation Version 4 5 dition lettre type 1 Identifiant om_utilisateur libell lettre aux utilisateurs actif g EJ Param tres g n raux de l dition Orientation et format Logo et positionnement Marges du document orientation portrait logo logopdf png logopdf png margeleft 10 format A4 gauche margetop 10 10 n margeright 10 haut 10 x margebottom 10 2 1 3 2 1 1 Bloc dition Les informations d dition saisir sont id identifiant de l tat lettre type libell libell affich dans l application lors de la s lection d une dition actif permet de d finir si l dition est active ou non Note Les champs id et libell sont obligatoires les id actif sont uniques 2 1 3 2 1 2 Param tres g n raux de l dition Les champs de param tres g n raux de l dition saisir sont orientation orientation de l dition portrait paysage format format de l dition A4 A3 logo s lection du logo depuis la table des logos configur s logo haut gauche position du coin haut gauche du logo par rapport au coin haut gauche de l dition Marge gauche marge gauche de l dition Marge haut marge haute de l dition Marge droite marge droite de l dition Marge bas marge basse de l dition 24 Chapitre 2 Manuel d usage openMairie Framework Documentation Ve
15. 103 SAAB POSI se a UN a RE Da NARNIA a db la eE 104 SALAS Principes s 2 3a ss der Lau ge dans has him da 2A 104 3 1 13 552 paseet sch mas caro aa a ER ESER AUS 104 31136 geocodage soes 4 Lena EA EU Resa 104 3 1 13 6 1 vat adresse postale ne x 4 5 Suns sde da de amp das 104 3 1 13 6 2 Mise en oeuvre dans un formulaire d un bouton de la geolocalisation 105 IMAZ data sie si Pisise si du Lens tel sienne as Et 107 3 1 13 7 1 Saisir le p rim tre de sa commune 107 3 1 13 7 2 R cup rer les donn es de VIGN 108 3 1 13 73 Recup rerdes donn es shap e y cria He a ar de 06 108 3 1 13 7 4 Recup ration des donn es de la DGI 109 3 1 14 Abstraction du layout ergonomie 109 3 1141 L composant jquery sy cesk e sue 6 8 854 L t V8 109 INNA Tes Telles dexSTYTErr ou eee LS a ERNST G pie 1 22144 109 3 1 15 Abstraction du filestorage stockage des fichiers 110 3 1 1551 Principe g n ral 4044 Los Lo EL RS a a sas 110 3 1 15 2 Fonctionnement s po s Besse e M SR nu RA 110 3 1 15 2 1 Description de l abstracteur oxicorte 6 6 18 90 8 110 3 1 15 2 2 Description du fichier de configuration 110 3 1 15 2 3 Description des m thodes de la classe filestorage 111 3 1 15 2 4 Description du connecteur depredacted 112 3 1 15 2 5 Description du connecteur filesys
16. Supprimer la contrainte NOT NULL des champs non requis ou ajouter la clause DEFAULT en fonction du besoin Mettre a jour les fichiers de surcharge du r pertoire obj G n rer Toutes les colonnes NOT NULL g n reront des champs requis Des champs qui n taient pas requis dans la version 4 2 0 peuvent donc l tre dans la version 4 3 0 apr s une g n ration Il faut donc supprimer la contrainte NOT NULL des colonnes qui ne sont pas r ellement requises par l application ou ajouter une valeur par defaut avec la clause DEFAULT Concernant les champs requis par l application Il n est plus n cessaire de surcharger la m thode verifier des mod les pour g rer ce type de champ Il faudra nettoyer les surcharges de verifier en supprimant la v rification manuelle des champs requis et les remplacer par des contraintes NOT NULL sans clause DEFAULT dans la base de donn es Important Vous pouvez g n rer nouveau l application partir d ici tape 3 mettre jour les fichiers de surcharge du r pertoire sq1 4 1 3 2 3 1 Alias des tables trang res Prefixer le nom des colonnes trang res par l alias g n r dans gen sql Le g n rateur peut donner une table trang re un alias unique Cela permet d effectuer plusieurs jointures sur une m me table sans avoir d erreur d ambiguit avec les nom des colonnes Pour cela dans les fichiers du r pertoire sql contenant plusieurs r f rence ve
17. x S parateur point virgule Importer le fichier dans la table courrier lt Retour openExemple Version 4 4 0 dev Documentation openMairie org Pour en savoir plus voir framework import 1 1 3 Personnaliser son application Nous allons maintenant personnaliser notre application Pour ce faire nous allons saisir un jeu de donn es Vous pouvez le faire avec les formulaires l incr mentation des s quences tant faite par le framework Tout comme la cr ation des tables stockant les s quences m thode set d des objets metier Sinon ex cutez la requ te PostgreSQL suivante 12 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 cr ation des tables de s quence d j faite insertion de deux metteurs avec r cup ration et incr mentation de la table de s quences INSERT INTO emetteur emetteur nom prenom VALUES nextval emetteur_seg dupont pierre nextval emetteur_seg durant jacques insertion de deux services avec r cup ration et incr mentation de la table de s quences INSERT INTO service service libelle VALU nextval service_seq informatique nextval service_seg telephonie ca uw insertion de deux courriers avec r cup ration et incr mentation de la table de s quences INSERT INTO courrier courrier dateenvoi objetcourrier metteur s
18. Actions en coin corner ajouter Stab_actions corner ajouter array lien gt form php obj obj amp amp action 0 ld gt famp advs_id S advs_id samp tricol tricol Samp valide valide samp retour tab libr gt lt span class om icon om icon 16 om icon fix add 16 title _ Ajouter gt _ Ajouter lt span gt rights gt array list gt array 0b3 obj _ajouter operator gt OR ordre gt 10 Actions gauche left consulter Stab_actions left consulter array lien gt form php ob3 SobJ3 ftamp action 3 samp idx id gt amp amp premier premier amp amp advs_id advs id Samp recherche S recherchel samp tricol tricol amp amp selectioncol selectioncol amp amp valide Svalide amp amp retour tab lib gt lt span class om icon om icon 16 om icon fix consult 16 title _ Consulter gt _ Consulter lt span gt rights gt array list gt array obj obj _consulter operator gt OR ordre gt 10 3 1 Manuel de r f rence 77 openMairie Framework Documentation Version 4 5 Action sur la cinqui me colonne de contenu Stab_actions specific_content 4 array lien gt form php obj S obj amp amp action 2 amp amp idx id gt Samp premier S premier samp advs_id S advs_id Samp recherche
19. Les post traitements de form_sig permettent de faire des traitement apres saisie de g om tries avec om_sig form_sig_update inc php form_sig_delete inc php 3 1 4 Afficher les tables Il est d crit dans ce paragraphe l utilisation et la configuration des tableaux d enregistrements issus de la base de donn es admin Ville d ARLES Mot de passe 4 D connexion Open MAIRIE Tableau de bord s oa Administration Param tre Param trage Administration PRE Collectivit las a tacere Cati Des CUNE 1 2 enregistrement s sur 2 Profil Droit param tre O gt libell 2 gt valeur D Utilisateur PE Tableaux De Bord S ik Widget 2 ville Ville d ARLES sig Om_sig_map Om_sig_wms openExemple Version 4 3 0 dev Documentation openMairie org Options Avancees Import G n rateur La gestion des tableaux se base sur le fichier core om_table class php classe table Pour chaque affichage de tableau le script sql DBTYPE objet inc php correspondant est appel Il permet de stocker le d tail des requ tes n cessaires l affichage du contenu Les tableaux sont construits lors de l appel aux scripts scr tab php et scr soustab php 3 1 4 1 Les script scr tab php et scr soustab php L appel ces scripts permet d afficher un tableau d enregistrements de l objet pass en param tre Liste des param tres pass s l url obj nom de l objet pour lequel on souhaite afficher l
20. NOT NULL En fonction de ces contraintes les fichiers de l application sont g n r s diff remment par rapport openMairie version 4 2 0 4 1 Historique amp Mises niveau 125 openMairie Framework Documentation Version 4 5 4 1 3 2 2 3 PRIMARY KEY Ajouter la contrainte SQL PRIMARY KEY Le g n rateur peut maintenant utiliser les cl s primaires Pour cr er le champ identifiant il faudra utiliser la contrainte PRIMARY KEY la place des noms de table en tant que nom de colonne 4 1 3 2 2 4 FOREIGN KEY PostgresSQL Ajouter la contrainte SQL FOREING KEY Le g n rateur g re galement les cl s trang res des bases PostgresSQL Pour cr er des r f rences il faudra utiliser la contrainte FOREIGN KEY la place des noms de table trang res en tant que nom de colonne 4 1 3 2 2 5 UNIQUE Ajouter la contrainte SQL UNIQUE Mettre a jour les fichiers de surcharge du r pertoire obj La contrainte UNIQUE permet maintenant de g rer automatiquement les champs uniques Il n est plus n cessaire de surcharger la m thode verifier des mod les pour g rer ce type de champ Il faudra nettoyer les surcharges de verifier en supprimant la v rification manuelle des champs requis et les remplacer par des contraintes UNIQUE dans la base de donn es 4 1 3 2 2 6 NOT NULL Ajouter la contrainte NOT NULL aux champs requis Supprimer la clause DEFAULT des champs requis
21. from_content utilisation normale de la m thode create data contient le contenu du fichier from_path data contient le chemin du fichier enregistrer Cette m thode retourne l UUID du fichier enregistr temporairement filestorage get_temporary uid Cette m thode retourne le contenu et les m tadonn es d un fichier enregistr temporairement en fonction de l UUID pass en param tre filestorage delete temporary uid Cette m thode supprime un fichier temporaire en fonction de l UUID pass en param tre L appel aux m thodes temporary se fait sur une instance de filesystem d fini dans le param trage Ces m thodes sont impl ment s dans la classe de base contrairement aux autres m thodes elle peuvent toutefois tre surcharg es dans les classes de connecteurs sp cifiques Description du connecteur depredacted core om_filestorage_deprecated class php Cette classe est une classe de stockage sp cifique aussi appel e plugin de stockage pour le syst me d abstraction de stockage des fichiers Le principe de ce plugin est de stocker tous les fichiers plat selon la m thode utilis e avant la cr ation du syst me de stockage Ce plugin a t cr uniquement dans un soucis de garder la compatibilit pour les applications existantes Description du connecteur filesystem core om_filestorage_filesystem class php Cette classe est une classe de stockage sp cifique aussi appel e plugi
22. l utilisateur de laisser le champ vide lors d une validation de formulaire Le SGBD se charge alors d ajouter lui m me cette valeur 2 1 4 4 4 2 Fonctionnement interne du g n rateur Comment ces champs sont d termin s lors de la g n ration d un mod le L abstracteur de base de donn es d openMairie peut en analysant une table r cup rer la liste de ses colonnes requises n ayant pas de valeur par d faut 2 1 4 4 4 3 Affichage dans les formulaires Comment ces champs sont repr sent s dans les formulaires Ces champs sont affich s avec un marqueur c t de leur libell indiquant qu ils sont requis Par d faut open Mairie utilise le caract re pour indiquer les champs requis Si ces champs ne sont pas remplis lors de la validation d un formulaire un message d erreur est affich pour chaque champ requis non compl t et la base de donn es n est pas modifi e Le champ libell Pour repr senter des objets dans des champs de type lt select gt le g n rateur utilise un champ textuel particulier appel libell Ce champ est galement utilis pour ordonner les l ments d un tableau de mani re croissante 2 1 4 4 5 1 D finition du libell Pour d finir explicitement une colonne comme libell d un mod le il faut la nommer libelle Si cette colonne n existe pas le g n rateur consid re la deuxi me colonne de la table comme tant un libell ce syst me tait
23. recherchel samp tricol tricol Samp selectioncol S selectioncol Samp valide valide samp retour tab lib gt lt span class om icon om icon 16 om icon fix delete 16 title _ Consulter gt _ Consulter lt span gt rights gt array list gt array obj obj _consulter operator gt OR ordre gt 10 7 gt Plusieurs emplacements d actions existent corner actions dans la premi re cellule du tableau left action situ es dans la premi re colonne disponibles pour chaque l ment du tableau content action sur le contenu du tableau onanifin nantant antinn onr nna nalanna da santana dn tahlaau CE admin Ville d ARLES Mot de passe 4 D connexion recherchel Tableau de bord Export Administration Utilisateur Param trage v Administration corner a specific content Collectivit 3 Lo z Param tre 1 2 enregistrement s sur 2 Tous Recherche CR gt utilisateur 2 gt nom 2 erail 2 login profil 2 Profil Droit content gt 2 D monstration confact openmairie org demo ADMINISTRATEUR Utilisateur J 1 Administrateur contact openmairie org admin ADMINISTRATEUR Tableaux De Bord Widget Sig left openExemple Version 4 3 0 dev Documentation openMairie org Om_sig_map Om_sig_wms Options Avancees Import G n rateur Les actions par d faut Par d faut seules les actions ajouter et c
24. 3 1 13 1 Principe Il est propos dans ce chapitre de decrire le module tab_sig php qui permet la geo localisation d objet dans open Mairie A partir de la version 4 4 0 l acc s au module g ographique se fait en mettant l option localisation d om_param tre la valeur sig_interne L objectif de tab_sig_map est de permettre une saisie le plus souvent automatique par un point ligne multiligne polygone multipolygone Cette saisie est stock e dans la base m tier postgresql Elle est affich e sur des fonds existants sur internet google sat openStretmap ou bing pour 1 instant en utilisant le composant javascript openLayers Il n est donc pas n cessaire de disposer d un SIG pour utiliser tab_sig php 3 1 Manuel de r f rence 95 openMairie Framework Documentation Version 4 5 Le format de stockage des donn es pgsql est celui de OGC et il est accessible aux clients libres o propri taires qui respectent ce format QGIS GRASS VEREMAP pour les clients libres G o localisation automatique L enjeu est de limiter au maximum la g o localisation manuelle d s qu il y a une possibilit de g o localisation automatique Elle se fait au travers de 2 programmes voir paragraphe sur le geocodage adresse_postale php positionnement suivant le numero et rue adresse_postale_google php positionnement suivant le numero et rue avec google adresse_postale_bing php positionnement suivant
25. EX Requ te SQL SELECT nom as nom FROM A Cette phrase dans un PDF Lorem nom dolor sit amet lt MAJ gt nom lt MAJ gt adipiscing elit Curabitur feugiat deviendra Lorem nom dolor sit amet NOM adipiscing elit Curabitur feugiat Les variables commen ant par 8 sont celles d finies dans dyn varpdf inc exemple amp aujourdhui et dans la table om_parametre ob3j om_etat class php core obj om etat class php gen ob3j om_etat class php sql pgsql1 om_etat form inc php sql pgsql1 om_etat inc php core sql pgsql om etat form inc php core sql pgsql om etat inc php gen sql pgsql om_etat form inc php gen sql pgsql om etat inc php Param trer des lettres type Il est conseill d utiliser l assistant lettre type du g n rateur Les param tres sont les suivants orientation portrait ou paysage format A4 A3 position et nom du logo titre de la lettr position et caract ristiques du titre corps de la lettre position et caract ristiques du corps la requ te SOL Pour le corps et le titre les zones entre crochets sont les champs de fusion s lectionn s par la requ te Les variables commen ant par 8 sont celles d finies dans dyn varlettretypepdf inc exemple amp aujourdhui et dans la table om_parametre obj om lettretype class php core obj om lettretype class php gen obj om_lettretype class php sq
26. Fermeture du div de 50 Sform gt setBloc actif F Ouverture d un div sur une colonne de 1 2 de la largeur du conteneur parent form gt setBloc orientation D col_6 Sform gt setFieldset orientation D _ Parametres generaux du document startClosed Sform gt setBloc orientation D group Sform gt setBloc format EF Sform gt setBloc footerfont D group Sform gt setBloc footertaille F Storm gt setBloc loge Dl NM group Sform gt setBloc logotop F 3 1 Manuel de r f rence 71 openMairie Framework Documentation Version 4 5 Sform gt setFieldset logotop F Sform gt setBloc logotop F Ouverture d un div de largeur maximum sur un seul champ Sform gt setBloc titre DE col_12 Ouverture d un div de largeur maximum Sform gt setBloc titreleft D col_12 Sform gt setFieldset titreleft D _ Parametres du titre du document startClosed Sform gt setBloc titreleft D group Sform gt setBloc titrehauteur F form gt setBloc titrefont D group Sform gt setBloc titrealign F Sform gt setFieldset titrealign F Sform gt setBloc titrealign F Ouverture d un div de largeur maximum sur un seul champ StEorm gt setBloc corps DE YX Ugal 12 Ouverture d un div de largeur maximum Storm gt setBloc eorpsleft DY
27. false l action n utilisera pas la fonction ajaxIt 4 1 3 2 3 8 D finition de l ordre d affichage La cl ordre permet de d terminer l odre d affichage par rap port aux autres actions Chaque action dispose d une valeur num rique permettant de d finir sa place au sein d une position L action num ro 1 s affichera en premier l action num ro 10 s affichera apr s les actions de num ro inf rieur etc Ordre des actions par d faut d openMairie ajouter pour ordre 10 dans la position corner consulter pour ordre 10 dans la position left Si la position corner est s lectionn e 9 l action s affichera avant l action ajouter 11 l action s affichera apr s l action ajouter Si la position left est s lectionn e 9 l action s affichera avant l action consulter 11 l action s affichera apr s l action consulter 4 1 3 2 3 9 D finition des droits d affichage La cl rights permet de d finir le ou les droits n cessaire l utilisateur pour visualiser cette action Cette cl est optionnelle Si rights n existe pas tous les utilisateurs pourront visualiser cette action s ils peuvent visualiser le tableau correspondant La cl 1i st permet de d finir le tableau des droits n cessaire La cl operator permet de d finir l op rateur utilis pour pour v rifier les droits de la liste list OR l utilisateur doit avoir au moins un droit
28. obj et sql tape 2 mise jour du menu Suite l ajout d une table contenant les logos et une autre contenant les requ tes les entr es correspondantes dans le menu devraient tres ajout es tape 3 v rification des requ tes et logos V rifier que les logos et requ tes sont dans les bons tat lettres type tape 4 syst me de stockage des fichiers Le syst me de stockage de fichier ayant t mis jour le syst me utilis conserve la compatibilit avec les fichiers existant Les erreurs connues 4 1 3 La version 4 3 4 1 3 1 Les nouveaut s de la version 4 3 4 1 3 2 Mettre niveau depuis openMairie 4 2 vers 4 3 Cette proc dure permet de mettre niveau une application utilisant openMairie version 4 2 0 vers openMairie 4 3 0 Pour conserver une application fonctionnelle tout au long de la mise niveau il est vivement conseill de suivre les tapes de cette proc dure dans l ordre ne pas utiliser le g n rateur lorsque ce n est pas indiqu Consultez la section sur les erreurs connues si des erreurs persistent apr s la mise niveau tape 1 mettre jour les surcharges du framework 4 1 3 2 1 1 Classe application Supprimer l utilisation de l attribut lt php var permission_ if _ right does not _exist true gt S il est utilis dans une surchage il doit tre remplac e par 124 Chapitre 4 Historique amp Mises niveau
29. openMairie Framework Documentation Version 4 5 lt php this gt config permission_if_right_does_not_exist 2 gt Les m thodes surcharg s de la classe om_applicat ion doivent tre mises jour avec leur nouvelle impl men tation 4 1 3 2 1 2 Classe dbForm Les m thodes surcharg s de la classe dbForm doivent tre mises jour avec leur nouvelle impl mentation 4 1 3 2 1 3 Classe formulaire Les m thodes surcharg s de la classe formulaire doivent tre mises jour avec leur nouvelle impl mentation 4 1 3 2 1 4 Classe table Les m thodes surcharg s de la classe table doivent tre mises jour avec leur nouvelle impl mentation Supprimer l utilisation de la m thode lt php function countHrefColumns href array 2 gt Si elle est utilis e dans une surchage elle doit tre remplac e par lt php function countActions actions 2 gt tape 2 mettre jour la base de donn es 4 1 3 2 2 1 La structure La structure de la base de donn es d openMairie a chang e sensiblement depuis la version 4 2 0 Pour mettre jour la base de donn es depuis cette version il faudra ex cuter le script SQL ver_4 3 0 sql Pour MySQL data mysql ver_4 3 0 sql Pour PostgresSQL data pgsql ver_4 3 0 sql 4 1 3 2 2 2 Les tables m tier Le g n rateur g re maintenant plusieurs contraintes PRIMARY KEY FOREIGN KEY UNIQUE
30. pour le message de validation le code est le suivant message _ Mot de passe actuel incorrect Sf gt displayMessage class message Pour afficher un fieldset le code est le suivant echo lt fieldset class 1 cadre ui corner all ui widget content gt n echo t lt legend class ui corner all ui widget content ui state active gt echo _ Courrier lt legend gt echo lt fieldset gt il peut tre par d faut ouvert echo lt fieldset class collapsible gt n ou il peut tre ferm echo lt fieldset startClosed gt n Vous pouvez faire appel a des scripts js complementaires en utilisant la m thode f gt addHTMLHeadyJs array 3 s formulairedyn 3s js onglet js Pour la gestion des accents il est conseill de ne pas mettre d accent dans le code utf8 au lieu de latin1 iso8859 1 et de mettre les accents dans la traduction Pour d finir le chemin par d faut pour l upload de fichier il faut utiliser la m thode Spath f gt getPathFolderTrs 3 1 17 2 Exemple Il est propos de prendre l exemple du traitement de la remise du registre a O dans openCourrier ENTETE NORMALISEE Vik Cette page permet de remettre a 0 le registr package openmairie_exempl version SVN Id xxxx php 311 2010 12 06 11 43 36 xxxxx A A H CREATION
31. 74 R rvb m thode formulaire 75 rvb2 m thode formulaire 75 S select m thode formulaire 75 select_multiple m thode formulaire 75 select_multiple_static m thode formulaire 75 selectdisabled m thode formulaire 75 selecthiddenstatic m thode formulaire 75 selectstatic m thode formulaire 75 set_form_default_values m thode dbform 70 setBloc m thode dbform formulaire 71 setBloc m thode formulaire 77 setFieldset m thode dbform formulaire 71 setFieldset m thode formulaire 77 setGroupe m thode dbform 71 setGroupe m thode formulaire 77 setId m thode dbform 73 setKeyup m thode formulaire 77 setLayout m thode dbform 71 setLib m thode dbform 70 151 openMairie Framework Documentation Version 4 5 setLib m thode formulaire 76 setMax m thode dbform 70 setMax m thode formulaire 77 setOnchange m thode dbform 70 setOnchange m thode formulaire 77 setOnclick m thode dbform 71 setOnclick m thode formulaire 77 setOnkeyup m thode dbform 70 setRegroupe m thode dbform 71 setRegroupe m thode formulaire 77 setSelect m thode dbform 70 setSelect m thode formulaire 76 setTaille m thode dbform 70 setTaille m thode formulaire 77 setType m thode dbform 70 setType m thode formulaire 76 set Val m thode dbform 70 setVal m thode f
32. Format de la date openexemple Nom du sch ma WWW LE prefixe NULL Param trage pour l annuaire LDAP mail default Param targe pour le serveur de mail filestorage default Param trage pour le stockage des fichiers 2 gt La documentation de DB PEAR qui est le module d abstraction utilis par le framework donne plus d informations sur les param tres 3 1 3 Param trage du framework Le param trage de l application se fait dans le r pertoire dyn Il est propos dans ce chapitre de d crire les diff rents fichiers de param trage 3 1 Manuel de r f rence 51 openMairie Framework Documentation Version 4 5 Pour le fichier dyn database inc php voir Param trage de la connexion la base de donn es Les fichiers de param trage sont les suivants dyn menu inc php menu principal gauche dyn action inc menu haut dyn shortslink inc lien sous menu haut dyn dashboard inc php tableau de bord dyn locales inc application dyn config inc php application dyn include inc php chemin d acc s aux librairies dyn debug inc php mode debug dyn version inc param trage de la version dyn var_sig inc param trage sig dyn form_sig_update inc php parametrage sig dyn form_sig_delete inc php parametrage sig dyn var_adresse_postale inc parametrage sig dyn filestorage inc php filestorage dyn footer inc php enpieds dyn tab inc php variable specifiq
33. Il est n cessaire de cr er un dossier de langue par exemple en_US avec son sous dossier LC_MESSAGES pour chaque langue suppl mentaire Le fichier po contient les d finitions de traductions il peut tre modifi au moyen de POEdit ou directement depuis un diteur de texte simple Le fichier mo contient les traductions sous une forme compil e Il est g n r par POEdit automatiquement lors de chaque sauvegarde des traductions 144 Chapitre 6 Outils openMairie Framework Documentation Version 4 5 6 1 5 3 Installation et configuration de POEdit Installation POEdit est disponible nativement dans la plupart des syst mes linux Il est possible de le t l charger depuis le site officiel pour tous Linux Windows et Mac OSX http www poedit net download php Sous Linux Ubuntu ou Debian il faut en root ex cuter la commande apt get install poedit Gestion de plusieurs langues Une fois install il faut s assurer que les locales fichiers de d finition de langues sont correctement install s sur le syst me Sous Linux Ubuntu pour ajouter une locale il faut ajouter sa d finition dans le fichier de pays cor respondant exemple var lib locales supported d fr puis lancer la commande en root dpkg reconfigure locales Cela ne sera n cessaire que pour ajouter la prise en charge d une nouvelle langue 6 1 5 4 Configuration d un projet dans POEdit Cliquer sur le bouton Cr er un no
34. array constraint gt array size_max gt 2 extension gt pdf txt odt r 22 La taille maximale est en mo et la liste des extensions est une cha ne de caract res 3 1 15 3 1 2 M tadonn es Il y a des m tadonn es globales et sp cifiques Les globales sont d finies dans obj om_db_form class php dans l attribut metadata_global Exemple de configuration lt php var metadata_ global array metadonnel gt m thodeQuiRetournelaBonneValeurl metadonne2 gt m thodeQuiRetournelaBonneValeur2 PE Les specifiques sont ajouter en attribut de la classe m tier de l objet concern Exemple de configuration de l ajout de m tadonn es lt php var metadata array champ gt array metadonnel gt m thodeQuiRetourneLaBonneValeur1 metadonne2 gt m thodeQuiRetourneLaBonneValeur2 T T gt Les cl s de ces tableaux sont les noms des m tadonn es les valeurs associ es sont les noms des m thodes qui retournent les m tadonn es R cup ration du fichier file f gt storage gt get fic Scripts permettant de visualiser d acc der au fichier 3 1 15 3 3 1 spg file php Le script permet de t l charger le fichier Le code pour composer le lien vers ce script est le suivant lt php file_download_link spg file php if obj amp amp champ amp a
35. d finie pour prot ger l acc s direct au script depuis l URL La permission forbidden a pour vocation de n tre donn e aucun utilisateur require_once obj utils class php if lisset f f new utils null forbidden 3 1 Manuel de r f rence 85 openMairie Framework Documentation Version 4 5 Stooter Tt footer title Mr Swidget_is_empty true gt Mod le de donn es CREATE TABLE om_ widget om_widget integer NOT NULL Identifiant unique libelle character varying 100 NOT NULL Libell du widget lien character varying 80 NOT NULL DEFAULT character varying Lien qui poihte vers le w texte text NOT NULL DEFAULT text Texte affich dans le widget type character varying 40 NOT NULL Type du widget web si pointe vers une URL ou file CONSTRAINT om_widget_pkey PRIMARY KEY om_widget obj om widget class php sql pgsql1 om_widget form inc php sql pgsql1 om_widget inc php core obj om widget class php core sql pgsql om widget form inc php core sql pgsql om widget inc php gen obj om_ widget class php gen sql pgsql om widget form inc php gen sql pgsql om widget inc php 3 1 9 3 Les tableaux de bord acc s au tableau de bord Le param trage se fait en cliquant sur le lien param trer son tableau de bord Il apparait alo
36. er cette liste il suit la proc dure suivante avec PostgresSQL le g n rateur peut interroger les tables du syst me contenant la liste des cl s trang res d une table particuli re ainsi que les tables trang res r f renc es par ces cl s dans un second temps indiff remment du SGBD il ajoute a la liste des cl s trang res le nom des colonnes portant le m me nom que d autres tables La liste ainsi form e permettra au g n rateur de cr er des champs de type r f rence dans les mod les de donn es 2 1 4 4 2 4 Affichage dans les formulaires Comment ces champs sont repr sent s dans les formulaires Depuis le formulaire de l objet faisant r f rence ces champs sont repr sent s par des balises HTML lt select gt L ensemble des objets pouvant tre r f renc s sont list s sous la forme d options Depuis le formulaire de l objet r f renc un onglet appara t pour chaque mod le diff rent faisant r f rence cet objet Chaque onglet liste l ensemble des objets faisant r f rence l objet pr sent en formulaire Les champs uniques Un mod le de donn es peut contenir un ou plusieurs champs uniques Il n est pas possible pour plusieurs objets d un m me mod le d avoir la m me valeur pour ce champ Un mod le de donn es g n r peut galement contenir au plus un groupe de champs unique Cette fois c est la combinaison des valeurs de ces champs qui ne pourra exister qu
37. finir les champs geom titre description et texte c openMairie openFoncier Mozilla Firefox collectionlibre arg a Que 3 localhost openroncier trunk app dossier php menu 041d PC11R0185 admin Artes 7 Mot de passe E D connexior Tables de borc E calpe tahsan bord donvor Parrin de Canin M 23 VUS ICI ASe e RUN 22009102 noes SCI LE CH TEM SUISSES exe na Vernon 21200 ficar sue M ML AUS EL GILLES EN COLE MO tna 23 16 des amas IL Aka Ga amn cc Ro Arcenapenert seme carecractertqua sco 0 m see 33 m Mawd A rn rectos da Veire La bratrattion Dese de MODELA du AAS ase he COTE ZONAL np Sanmi pri hd an charcer 21060201 dame ach vercaet recon S oA E q A P C Dutta Parton TL JL re E TE Fi peur fal 2 ON HE Er LELS Por CL E sig_json php pr sente tous les enregistrements d un m me point m me g om sur un seul popup En effet il est constitu un popup lorsque 1 on clique sur 1 objet et donne la possibilit un acc s URL parametr e dans om_sig_map Les flux wms Le param trage des flux wms est saisi dans om_sig_wms Administration Om_sig_wms 3 LOTISSEMENT id chemin url http Mocalhostcgi bin qgis_mapserv fcgi SERVICE WMS amp VERSION 1 3 0 amp map varwww openfoncierftrunk app qgis openfoncier qgs couches s par es parcelle_lot par urea Dn ns pneus
38. gt amp amp advs_id S advs id amp amp tricol tricol amp amp valide valide amp ampire Lib gt lt span class om icon om icon 16 om icon fix add 16 title _ Ajouter gt rights gt array list gt array obj obj _ajouter operator gt OR ordre gt 10 2 gt Pour surcharger l action modifier il faut maintenant surcharger tab_actions left modifier et non plus href 1 lt php Stab_actions left modifier array lien gt form php ob3 obJ samp action 1 sampjidx id gt amp amp premier premier amp amp advs_id S advs _ id amp amp recherche lib gt lt span class om icon om icon 16 om icon fix edit 16 title _ rights gt array list gt array obj S obj _modifier operator gt ordre gt 20 2 gt Pour surcharger l action de contenu il faut maintenant surcharger tab_actions content et non plus Shref 1 lt php Stab_actions content tab_actions left modifier 23 Pour surcharger l action supprimer il faut maintenant surcharger S tab_actions left supprimer et non plus Shref 2 recherchel Modifier R lt php Stab_actions left supprimer array lien gt form php ob3j obJ samp action 28amp idx id gt amp amp premier S premier amp amp advs_id advs_id amp amp rech
39. l import des donn es CSV du framework 3 1 1 Arborescence Cette rubrique vise d crire bri vement l arborescence du framework pour comprendre l objectif de chaque r pertoire Elle est divis e en deux parties les r pertoires sp cifiques l applicatif qui sont modifi s lors du d ve loppement de l applicatif et les r pertoires du framework qui sont r cup r s tel quel dans le framework F htaccess dans les descriptions de r pertoires ci dessous repr sente des fichiers htaccess emp chant l acc s dans les r pertoires en question qui ne doivent pas tre accessibles depuis l interface par l utilisateur 45 openMairie Framework Documentation Version 4 5 3 1 1 1 Les r pertoires sp cifiques l applicatif Ces r pertoires sont ceux qui font l applicatif Par exemple sur un applicatif comme openCimeti re ce sont les r pertoires qui vont se trouver dans le gestionnaire de fichiers que l on appelle les r pertoires sp cifiques data Contient tous les fichiers d initialisation de la base de donn es de l applicatif D data F htaccess D pgsql app Contient tout les scripts sp cifiques l applicatif que ce soit des javascripts ou des images ou des scripts PHP D app D css oi D img D 3s dyn Contient les fichiers de param trage de l applicatif D dyn F htaccess gen Contien
40. modification ou suppression de champs et de reg n rer tout ou partie de l application Un second script h ritant de l objet g n r permet de surcharger les m thodes et de personnalis l objet m tier Toutes les modifications doivent tre faites dans ce script soit en h ritant de la m thode soit en surchargeant la m thode L objet personnaliser est stock en obj nom_table class php Les m thodes g n r s dans l objet m tier gen obj nom_table class php sont par d faut les suivantes Le type de champs est cach hidden en ajout pour la cl primaire automatique modifiable en ajout si la cl primaire n est pas automatique Punicit de la cl primaire est v rifi e si elle est modifiable version 4 2 0 la cl primaire est visible sans possibilit de modifier en modification la cl secondaire n est pas modifiable en sous formulaire si c est la cl primaire du formulaire la cl secondaire est un champ select qui reprend les informations de la table li e la date est au format fran ais geom si ce champ est g om trique version 4 2 0 36 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 La longueur d affichage et le maximum autoris la saisie est celle contenu dans la base d origine Le contr le des cl s secondaires des autres tables est g n r il n est pas possible de supprimer un enregistrement si des enregistrements so
41. openfoncier export NEWPRODUCTNAME openads export ADULLACTUSER fmichon tape 1 R cup ration des logs mkdir p S NEWPRODUCTNAME documentation NEWPRODUCTNAME documentation amp amp cd NEWPRODUCTNAME svn log q svn scm adullact net scmrepos svn S OLDPRODUCTNAME documentation gt 10G cat w d DOC awk F t r sub W mn 2 sub Sm WT 2 print 2 S27 E mp cat authors transform txt tape 2 MANUEL Modification des auteurs gt Il faut faire la correspondance entre les utilisateurs de l adullact et ceux de github gt exemple fmichon Florent Michon lt fmichon atreal fr gt gt fmichon login de l addulact gt Florent Michon nom complet du contributeur gt fmichon atreal fr mail r f renc dans github vim authors transform txt 146 Chapitre 6 Outils openMairie Framework Documentation Version 4 5 tape 3 V rification de l intervalle export REVS tail n2 LOG head n1 awk print 1 sed s r head n2 1 echo REVS LOG tail n1l tape 4 R cup ration de tous les commits tr s long svn2git authors authors transform txt revision REVS v svn scm adullact ne t scmrepos sv tape 5 Import du code sur github git remote add origin gitfgithub com openmairie NEWPRODUCTNAME documentation git git push u all g
42. soros a 4 006 sg a a ot Dh Be 8 n E Rae 81 3 1 8 1 Fonctionnalit s m e mails A a e de mes ds 81 348275 estables Et ir RR a E A A Re GB EU 81 318 3 AA A O Es 82 3 1 84 La multiscollecuvit lt g aec era ce e a E A 82 3 1 8 5 L s login t logout 252 a soute Be bete ein 82 3 1 8 60 PAD 151 51 36 ospa He sua E cena ea 82 3 1 9 Module Tableaudesbord sisi EA LS A AAA mA 82 LOL Principe 28403000 dr a e a 82 SOL Parametrar gt par a e a dd E 83 ILLI Jleswidgets ei a A e Re 83 3 1 9 1 3 le tableau d bord param trable 4 3 444 4 Le pos s as 83 E A E Red date end 83 3 19 21 lacr ation de Widget 4 4 u r d doe du Loue ui da 83 3 1922 Le widget de type Web uso masse pape men 84 3 1 9 2 2 1 IMEE sis pense o d 16 sus 84 3 1 9 2 2 2 EXIME curo EL a a 5 A E 84 31923 Le wideet de type SCTIPE 2 sio aa pe ad da ao 85 3 1 9 2 4 Mod le de donn es 86 31953 ILestabl aux de bords 54 508 1 6 ss Etre e 4 NORS d 26 e LE 86 3 1 9 3 1 accesautableaude Dord et 443 Soie de sihpd pit axes 86 31932 Mod l dedonn es lt s s pope acs pa 220 06 os de ee ns ets 87 3 194 Composants 5 44 4 spas R R M m usure sas 88 3 1 10 Module dition oo ur a o de id eee 88 3 1 10 1 Les tats et lettres types 1 544 ds dues A ieiets das 88 3 1 10 1 1 Parame trer des tats a z s amp aa A a mate is 88 3 1 10 1 2 Param trer des lettres type
43. ti ada it ble a a80 4 1 3 2 1 3 Classe formulaire 4 1 3 2 1 4 Classe table si a La ns stunt Eee a 4 1 3 2 2 tape 2 mettre jour la base de donn es 4 1 3 2 2 1 LA StrUCUILE iaa e ad a ae a 4 1 3 2 2 2 Les tablesm ti r cues ses 4 1 3 2 2 3 PRIMARY KEY pea 39 18 25 a pins sn Tir Gr ee 4 1 3 2 2 4 FOREIGN KEY PostgresSQL e o css 4 1 3 2 2 5 UNIQUE 3 444 a Sent J d mb tm dd mie 4 1 3 2 2 6 NOT NULL dt od a Ar 4 1 3 2 3 tape 3 mettre jour les fichiers de surcharge du r pertoire sq1 4 1 3 2 3 1 Alias des tables trang res 4 1 3 2 3 2 Larclause ORDER BY se rl e eue 4 1 3 2 3 3 Les actions du tableau msi ous des hu est 4 1 3 2 3 4 Les actions d openMairie 4 1 3 2 3 5 Les actions personnalis es 4 1 3 2 3 6 D finition de VACIO ox e se 4 444 Gerd e e e e 8 6 4 M 4 1 3 2 3 7 D finition du mode d affichage en sous tableau 4 1 3 2 3 8 D finition de l ordre d affichage 4 1 3 2 3 9 D finition des droits d affichage 4 1 3 2 4 La version 4 2 4 1 4 1 4 1 4 2 Les erreurs CONNUES copa a di e LR Les nouveaut s de la version 42 Mettre niveau depuis openMairie 4 1 vers 42 4 1 4 2 1 4 1 4 2 2 4 1 4 2 3 4 1 4 2 4 4 1 4 2 5 EXTERNAL Ss EXE oia o a p mb AO hu 4 D EEE mes Regen
44. une seule fois 2 1 4 4 3 1 D finition des champs uniques Il suffit de d finir une contrainte SQL UNIQUE sur une colonne ou un groupe de colonnes pour cr er respectivement un ou plusieurs champs uniques 2 1 4 4 3 2 Fonctionnement interne du g n rateur Comment ces champs sont d termin s lors de la g n ration d un mod le L abstracteur de base de donn es d openMairie peut en analysant une table r cup rer la liste de ses colonnes uniques 2 1 4 4 3 3 Affichage dans les formulaires Comment ces champs sont repr sent s dans les formulaires Ces champs sont affich s indiff remment des champs sans contrainte Lors de la validation d un formulaire une v rification est faite pour chaque champ unique ainsi que pour un ventuel groupe de champs uniques Si une valeur ou combinaison est d j pr sente dans la base de donn es un message d erreur est affich et la base de donn es n est pas modifi e 32 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 Les champs requis Un mod le de donn es peut contenir un ou plusieurs champs requis 2 1 4 4 4 1 D finition des champs requis Il suffit de d finir une contrainte SQL NOT NULL sans clause DEFAULT sur une colonne pour cr er un champ requis Attention En ajoutant une clause DEFAULT a une contrainte NOT NULL nous indiquons clairement au g n rateur que le champ n est pas requis La valeur par d faut permet
45. union dev openMairie du 13 juin 2012 4 2 0alphal premi re version non test e 4 2 0betal premi re version test e par le d veloppeur 4 2 0rc1 premi re version test e en production 1 site 4 2 0 premi re version stable g n ralisable 5 1 3 Documentation Ce paragraphe vise regrouper les bonnes pratiques qui permettent toute la communaut openMairie de tra vailler sur les m mes bases et avec les m mes r f rences concernant les outils de r daction et de publication de documentation afin de faciliter la contribution et d obtenir un rendu homog ne Voici les postulats chaque logiciel application poss de une seule documentation Sphinx qui contient un manuel d utilisation et un guide technique biens s par s le code source de la documentation doit tre d pos dans un d p t GIT sur github com la g n ration de la documentation est g r e de mani re automatique par readthedocs org docs openmairie org est l unique interface d acc s pour toutes les documentations un lien dans le footer de chaque application permet d acc der la version de l application du manuel d utilisateur sur le site docs openmairie org 5 1 4 Publication 5 1 4 1 La documentation Lorsqu il y a une nouvelle version de l application et que la version majeure ou mineure est incr ment e il faut ajouter une nouvelle version de la documentation aussi 132 Chapitre 5 R gles open
46. 0 dans la methode setValF rep rer une valeur wkt if substr val geom 0 5 POINT Sthis gt wkt 1 Sthis gt valF geom null utiliser les methodes de mise jour apr s saisie pour la geometrie function triggermodifierapres id db val SDEBUG if this gt wkt 1 Sthis gt sig_wkt id db val SDEBUG function triggerajouterapres id db val SDEBUG Sid Sthis gt valF odp id n est pas valorise en ajout 1 this gt wkt 1 Sthis gt sig_wkt id db val SDEBUG function sig_wkt id amp db val DEBUG si wkt gt saisie en format binaire wkb pour postgre Sprojection db gt getOne select srid from geometry_columns where f_tablel Sthis gt table sql update this gt table set geom geometryfromtext val geom Sprojection where this gt table id Sres db gt query sql if DB isError res die res gt getMessage erreur sql jelse this gt msg Sthis gt msg snbsp _ le point trouv par l API est sauvegard this gt table amp nbsp id 3 1 13 7 data sig ce chapitre propose de d crire la r cup ration de donn es SIG n cessaires la mise en oeuvre des scripts SIG internes openMairie Saisir le p rim tre de sa commune Il s agit d adapter ses cartes au p rim tre de sa commune Aller sur openstreetMap http
47. 0 img pdf svn scm adullact net svnroot openmairie openmairie exemple tags 4 2 0 pdf php svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 php om theme svn scm adullact net svnroot openmairie externals om theme kinosura tags 1 Deux r pertoires sont remarquables core contient maintenant la librairie openMairie 4 2 0 om_theme est le theme de l application Les dossiers suivant sont sp cifiques l application elle m me app scripts sp cifiques de l application noter dans specific txt les sp cificit s data scripts SQL d initialisation de la base de donn es dyn param trage de l application gen fichiers g n r s de l application obj surcharge des objets g n r s dans gen ob3 surcharge du core d openMairie om_dbformdyn om_formulaire 4 2 0 om application util sql requ tes SQL surchargeant les fichiers de gen sql tmp fichiers temporaires de l application ajouter les droits d criture pour le serveur web trs fichiers upload s par l application ajouter les droits d criture pour le serveur web Regenerer les tables avec genfull php Ajouter les droits d criture www data dans gen sudo chmod R 777 gen 4 1 Historique amp Mises niveau 129 openMairie Framework Documentation Version 4 5 Modifier les param tres dyn locales inc php charset include inc php core D
48. 3 2 Rendre obligatoire des champs Nous avons affich le courrier avec une jointure de type LEFT JOIN ce qui ne rend pas obligatoire la saisie de l emetteur et du service auquel le courrier est affect Nous devons surcharger la m thode verifier Dans obj courrier class php la m thode ins rer apr s le constructeur est celle ci function verifier val db SDEBUG parent verifier val db DEBUG Les champs servic t emetteur sont obligatoires if S this gt valF service Sthis gt correct False Sthis gt addToMessage _ service enbsp _ obligatoire snbsp 17 if Sthis gt valF emetteur Sthis gt correct False Sthis gt addToMessage _ emetteur amp nbsp _ obligatoire amp nbsp Par d faut le premier champ ici dateenvoi est obligatoire cette option est modifiable dans le g n rateur La commande parent verifier val db DEBUG permet de ne pas neutraliser la fonction surcharg e ici dans gen obj courrier class php Pour plus d informations voir framework methode 14 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 1 1 3 3 Valoriser un champ par d faut Pour simplifier la saisie nous souhaitons mettre la date du jour dans le champ dateenvoi lors d un ajout de courrier Nous allons surcharger la methode setVal dans obj courrier class php de la m
49. A RS 4 135 OA Pr TeQUIS scar os LATE OR AAA DARA ere 135 6 112 L arbor scence LAS aa sa ANR NASA e RER 135 6113 HL srplesid of or 5414 Sh 4 a A 135 6 1 1 4 Les commandes basiques conna tre 136 6 1 15 ERternalS s o Leds saunas Laws E serres des 136 GLIOG KEYWOBIS 2 2 LE ii MES Re Aa er eee Rod 136 6 1 1 7 Les clients graphiques gt x da ss 6 n pp k a ut 136 CALS TUOFAUR HER EUR RMS SUN EMI A AAA 137 6 1 1 8 1 Importer un nouveau projet s sp sus 4 A 137 6 1 1 8 2 Publier une nouvelle Version iones ed g e 137 6 1 1 8 3 SYMUNSANON 2 4 ds 6 4 5 8 ge Lips a de a 4 138 Concurrent versions system CVS 139 6121 Torse gt local ipii e rc us La dus os ut me ae n ma 140 6 1 2 2 local Sfofge 54484448 seme mu dde al 18 M 98 140 UE Vocal 5 La des muse diem Ne Aa de T e Ris a Lia spe a des 140 UA O 25 he k e a aa dub net mn m did ds DA 141 O2 HAS LE na sub D Ge ER eee ne Heu mie 141 6126 UMPO 84 some E es NRA RUN FN TN SES 142 G2 1 ES SOUSSE MER PS LAS CDD LT CNE pe 142 6 128 Divers s 4 4 a Lu nu A Mars sens RR mars 142 6 1 2 9 Changer le syst me de gestion des version de CVS vers SVN sur la forge de Padullact h posre o ds Guests Sie ge ui N a shine more 142 61 29 PTS n ss use e beta ts deu 142 6 1 2 9 2 Etape 1 R cup rer le code du CVS cs or ms rest 143 6 1 2 9 3 Etape 2 Changer le type de d p t
50. AND l utilisateur doit avoir tous les droits 128 Chapitre 4 Historique amp Mises niveau openMairie Framework Documentation Version 4 5 Les erreurs connues 4 1 4 La version 4 2 4 1 4 1 Les nouveaut s de la version 4 2 4 1 4 2 Mettre niveau depuis openMairie 4 1 vers 4 2 La version 4 2 0 du framework prend en charge plus de fonctionnalit s et donne toutes possibilit de surcharge aux applications surcharge des objets g n res par le generateur surcharge des composants de base openMairie stock dans core surcharge de la pr sentation de base dans img et css des th mes om theme dans app css app img surcharge du javascript de base app js script js EXTERNALS txt Vider les 9 repertoires concern s avant de lancer externals Appliquer le fichier EXTERNALS txt d openmairie core svn scm adullact net svnroot openmairie openmairie exemple tags 4 2 0 core spg svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 spg scr svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 scr lib svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 1ib css svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 css Js svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 3s img svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2
51. Documentation Version 4 5 Vous devez reg n rer votre application courrier en allant dans l option du menu administration gt generateur gt emetteur et laisser coch es les options par d faut gen obj emetteur class php gen sql pgsql emetteur inc php gen sql pgsql emetteur form inc php Validez l op ration N ayant pas modifi sql pgsql emetteur inc le framework fonctionne avec le code g n r 1 1 4 3 Am liorer la pr sentation du formulaire emetteur Nous pouvons continuer am liorer les pr sentations de nos formulaires en utilisant les m thodes setGroupe et setRegroupe dans le script obj emetteur class php Il vous est propos d ins rer dans votre script obj emetteur class php le code suivant function setLayout amp Sform maj Sform gt setFieldset nom D _ nom collapsible Sform gt setFieldset prenom F Sform gt setFieldset adresse D _ adresse startClosed Sform gt setFieldset ville EF Le fieldset nom est affich par d faut pas celui de l adresse emetteur 1 nom nom dupont prenom pierre EJ adresse Vos formulaires sont maintenant au point Le paragraphe suivant vous indique les surcharges d openCimetiere que vous pouvez int grer dans votre exemple maintenant que vous avez la m thode 1 1 4 4 Les surcharges d openCimetiere Vous pouvez utiliser openCimetiere actuellement version 3 0 0 a5 dev qui est t l chargea
52. H Choix de l dition gt courrier emetteur gt collectivit param tre s service openExemple Version 4 4 0 dev Documentation openMairie org Recherche 1 1 Tutoriel Cr er une application 11 openMairie Framework Documentation Version 4 5 pour en savoir plus voir framework edition Export gt Requ tes M moris es Cette option affiche les requ tes m moris es Export Requ tes m moris es Les requ tes m moris es permettent d exporter des donn es de la base de donn es pour une utilisation externe l application Veuillez cliquer sur l objet exporter pour acc der un formulaire vous permettant de choisir les param tres de l export E Choix de la requ te m moris e gt courrier gt courrier_emetteur gt courrier_service gt emetteur gt collectivit gt droit gt param tre Param tres d une collectivit gt profil utilisateur gt service openExemple Version 4 4 0 dev Documentation openMairie org pour en savoir plus voir framework reqmo Vous pouvez acc der aux ditions en appuyant dans le formulaire d affichage sur l imprimante Vous pouvez acc der au fichiers d import Administration gt Import Cette option affiche les scripts d imports Import Cette page vous permet d importer des donn es au format CSV directement dans la base de donn es E Choix de la table d import Table courrier Import du fichier CSV Fichier
53. My e Jx x define DEBUG EXTRA_VERBOSE_MODE define DEBUG VERBOSE_MODE define DEBUG DEBUG_MODE define DEBUG PRODUCTION MODE 2 gt Dans le dossier tmp error_log txt les messages de logs de niveau DEBUG_MODE sont crits quelque soit le mode d finit 3 1 3 7 La version de votre application Vous devez mettre le num ro de version et la date de votre application dans dyn version inc Voir le versionage des applications 3 1 Manuel de r f rence 59 openMairie Framework Documentation Version 4 5 3 1 3 8 Les informations generales Les fichiers textes d information g n rale sont la racine de l application README txt ce fichier peut contenir entre autre la liste des auteurs ayant particip au projet HISTORY txt information sur chaque version les et les bugs corrig s app SPECIFIC txt Ici vous d crivez la specificite de l application courante par rapport au framework LICENCE txt licence libre de 1 application TODO txt feuille de route roadmap INSTALL txt installation de 1 application 3 1 3 9 Linstallation automatique Lun fichier data sql install sql permet d installer rapidemment et data sql make_init sh permet de constituer rapi demment des scripts sql d installation 3 1 3 10 Les param tres des combos Les param tres des combos sont param tr s dans les fichiers suivants type de contr le de formulaire comboD et combo
54. Pro iton de tournitures de p 2013 11 21 o dupont pierre 2013 1 Vous avez de nombreux exemples d utilisation d tat et de sous tat dans les applications openMairie Une utilisation originale a t faite pour le Cerfa du recensement dans openRecensement o la place du logo il a t mis une image du Cerfa On ne peut cependant pas faire tous les tats et il est fort possible que vous ayez des tats sp cifiques Vous avez des exemples d utilisation sp cifique des m thodes de fpdf dans openElec carte lectorale liste lectorale Vous pouvez compl ter votre information avec le chapitre framework edition et regarder les possibilit s de para m trage du g n rateur generateur parametrage pour la r alisation d tat customis Vous avez maintenant termin l exemple d utilisation du Framework le chapitre suivant a pour but de vous infor mer de mani re compl te sur ce dernier 1 1 Tutoriel Cr er une application 21 openMairie Framework Documentation Version 4 5 22 Chapitre 1 Tutoriel Cr er une application CHAPITRE 2 Manuel d usage 2 1 Manuel d usage 2 1 1 Installation 2 1 2 Configuration 2 1 3 Administration Cette rubrique est d di e l administration des fonctionnalit s disponibles depuis l interface les tableaux de bord les ditions la g olocalisation 2 1 3 1 Les tableaux de bord Widget Composition 2 1 3 2 Les ditions tats et lettres types
55. col 120 Sform gt setFieldset corpsleft D _ Parametres du corps du document startClosed S form gt setBloc corpsleft D group Sform gt setBloc corpshauteur F Sform gt setBloc corpsfont D group Sform gt setBloc corpsalign F Sform gt setFieldset corpsalign F Sform gt setBloc corpsalign F Ouverture d un div de largeur maximum sur un seul champ STorm gt setBloc om_sql DF eo1 12 Ouverture d un div de 1 2 de la largeur du conteneur parent Sform gt setBloc om_sousetat D col_6 Sform gt setFieldset om_sousetat D _ Sous etat s selection startClosed Sform gt setBloc om_sousetat D group Sform gt setBloc sousetat F Sform gt setFieldset sousetat EF Sform gt setBloc sousetat F Ouverture d un div de 1 2 de la largeur du conteneur parent form gt setBloc se_font D col_6 Sform gt setFieldset se_font D _ Sous etat s police marges couleur startClosed Sform gt setBloc se_font D group Sform gt setBloc se_couleurtexte F Sform gt setFieldset se_couleurtexte F Sform gt setBloc se_couleurtexte F 2 gt 72 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 M thodes d actions Ces m thodes sont appel es lors de la validation du formulaire db db db fo
56. core sql pgsql om sousetat inc php gen sql pgsql om_ sousetat form inc php gen sql pgsql om sousetat inc php Les champs de fusion Les variables de remplacement Lorsque dans les zones de remplacement des ditions une cha ne de caract re commen ant par amp est identifi e elle essaye d tre remplac e Ces l ments sont nomm es variables de remplacement Elles peuvent provenir de trois sources diff rentes les fichiers de configuration dyn varxpdf inc les m thodes globales de la classe du fichier obj om_ dbform class php la table de param tres om parametre 3 1 10 1 7 1 Les fichiers de configuration dyn varxpdf inc 3 1 10 1 7 2 Les m thodes globales de la classe du fichier obj om dbform class php 3 1 10 1 7 3 La table de param tres om parametre prefixe edition substitution _vars doit tre d finit Les logos obj om logo class php core obj om logo class php gen obj om_logo class php sql pgsql om_logo form inc php sql pgsql om_logo inc php core sql pgsql om logo form inc php core sql pgsql om logo inc php gen sql pgsql om_logo form inc php gen sql pgsql om logo inc php L diteur WYSIWYG Description de l int gration de TinyMCE et des diff rents configurations Les anciens fichiers de param trage Les fichiers de param trage saql pgsql l
57. dans openMairie principes Il est propos un renvoi sur la documentation fran aise http postgis refractions net documentation manual 1 3 ch06 html ou sur le projet p dagogique postgis conf rence avec documentation et nombreux exemples https adullact net projects postgis Les requ tes utilisant des fonctions potgis peuvent tre impl ment es dans reqmo Il sera propos un lien sur un tutorial utilisant les fonctions postgis base et sch ma Il est not que les applications openMairie peuvent s installer dans un sch ma Les tables et fonctions postgis sont alors accessible dans le sch ma public 3 1 13 6 geocodage Ce chapitre est consacr au probl me de g ocodage Il est propose un g ocodage interne sgbd adresse en reseau interne ou un geocodage externe Il convient de regarder les termes de licences concernant les API externes non libres mapquest osm afin de s assurer de bien respecter les obligations de l autorisation gratuite Un document d crivant les contraintes juridiques et techniques de l utilisation des API est accessible via ce lien Le parametrage se fait dans le fichier sig var_adresse_postale php var_adresse postale inc param trage g n ral SlongueurRecherche 1 adresse postale stock e sur une base dans le r seau interne table et champs de la requete adresse postale ou l information doit etre recupere St adresse_postale table adresse post
58. der 18 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 Il faut maintenant permettre l acc s dans l affichage du service Ouvrir le fichier sql pgsql service inc php Ajouter le script suivant Shref 3 array lien gt pdf pdfetat php obj obj amp amp idx ia gt Le lib gt lt img src om theme img pdf 16x16 png alt _ Edition PDF title _ Edition PDF gt Nous rajoutons la ligne 3 dans le tableau href Vous avez un tat li l affichage du service Il y a des exemples d utilisation de href dans om_collectivit om_etat om_utilisateur 1 1 5 2 Cr er le sous tat courrier Nous allons utiliser l assistant sous tat du g n rateur dans le menu Administration gt G n rateur gt Assistants gt Cr ation sous tat Nous choisissons la table courrier et nous surlignons les champs courrier dateenvoi courrier objetcourrier cour rier emetteur et courrier registre Nous choisissons courrier service comme cl secondaire pour faire le lien avec service Administration G n rateur Sous tat cet assistant vous permet de cr er des sous tats directement partir de vos tables r E Choix table fichier courrier H choix des champs Utilisez ctrl key pour choix multiple courrier courrier ourrier dateenvoi ourrier objetcourrier ourrier
59. des modifications locales gt les fichiers remplac s sont sauv s en fi message A Ajout de nouveaux l ments a la version locale M l ments modifi s localement par rapport la version de CVS l ments inconnus de CVS non pr sents dans la version de CVS U pour les l ments modifi s dans CVS par rapport la version locale C pour les l ments diff rents entre les versions locale et CVS et qui posent un conflit r gle D fichier supprim s 6 1 2 2 local gt forge commit cd lt r pertoire d sir gt cvs commit m message explicite de la modification lt arborescence gt cvs ci m ajout des fichiers avec message cvs ci module name dans la branche principale cvs ci d branch_ name module name dans une branche cvs ci r tag module_name depuis un tag cvs ci r 3 0 changer la r vision doit tre plus grand que tous les num ros exi stants Add cd lt r pertoire d sir gt cvs add m message explicite de l ajout lt arborescence gt cvs add filel file2 cvs add data pgsqlx tous les fichiers du repertoire L ajout d un fichier n est possible que depuis le r pertoire le contenant r Les fichiers d un r pertoire non ajout ne sont pas visibles par CVS lors de l affi L ajout d l ments est effectif dans CVSROOT uniquement apr s la mise jour de la v rsion de CVS thage des dif
60. doit tre affich e en ajax ou non dans les sous tableaux true l action utilisera la fonction ajaxIt false l action n utilisera pas la fonction ajaxIt 3 1 7 1 2 3 D finition de l ordre d affichage La cl ordre permet de d terminer l ordre d affichage par rapport aux autres actions Chaque action dispose d une valeur num rique permettant de d finir sa place au sein d une position L action num ro 1 s affichera en premier l action num ro 10 s affichera apr s les actions de num ro inf rieur etc Ordre des actions par d faut d openMairie ajouter pour ordre 10 dans la position corner consulter pour ordre 10 dans la position left Si la position corner est s lectionn e 9 l action s affichera avant l action ajouter 11 l action s affichera apr s l action ajouter Si la position left est s lectionn e 9 l action s affichera avant l action consulter 11 l action s affichera apr s l action consulter 3 1 7 1 2 4 D finition des droits d affichage La cl rights permet de d finir le ou les droits n cessaires Putilisateur pour visualiser cette action Cette cl est optionnelle Si rights n existe pas tous les utilisateurs pourront visualiser cette action s ils peuvent visualiser le tableau correspondant La cl 1i st permet de d finir le tableau des droits n cessaire La cl operator permet de d finir l op ra
61. est pas accessible Y courrier class php gen obj courrier class php Le fichier n existe pas ou n est pas accessible g courrier class php 0bj courrier class php Le fichier n existe pas ou n est pas accessible courrier pdf inc php courrier reqmo inc php dition sql pgsql courrierpdf inc php Le fichier n existe pas ou n est pas accessible reqmo sql pgsql courrier regmo inc php Le fichier n existe pas ou n est pas accessible courrier_emetteur reqmo inc php sql pgsql courrier_emetteur reqmo inc php Le fichier n existe pas ou n est courrier_service reqmo inc php courrier import inc php pas accessible sql pgsql courrier_service regmo inc php Le fichier n existe pas ou n est pas accessible divers sql pgsql courrier import inc php Le fichier n existe pas ou n est pas accessible G n rer les fichiers de la table courrier Y Retour Au pr alable le g n rateur a fait une analyse de la base de donn es 1 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 EJ analyse Analyse de la base de donn es pgsql openexemple openexemple Elements Infos Tables de la base om_lettretype om_profil om_collectivite om_sousetat om_logo om_utilisateur de donn es om_parametre om_dashboard om_sig_map_comp emetteur om_droit service om_sig_map_wms om_requete om_sig_wms om_widget
62. f rence gt fichier in re dans le fi rqueur et ind openMairie Framework Documentation Version 4 5 Exemple d arborescence de stockage repertoire de stockage 25 252e 252ece72d4c0f88782d9fd6b99 43dfd repertoire de stockage 25 252e 252ece72d4c0f88782d9fd6b99f43dfd info repertoire de stockage 25 252e 252ece72d4c0f88782d9fd6b99f43dfd_lock repertoire de stockage 25 252e 252eacd35e f547dab12ded6b99 43dfd repertoire de stockage 25 252e 252eacd35ef547dabi2ded6b99f43dfd info repertoire de stockage 25 252e 252eacd35e f547dab12ded6b99f43dfd_lock repertoire de stockage 12 123a 123aacd35ef547dabl2ded6b99f43dfd repertoire de stockage 12 123a 123aacd35ef547dabl2ded6b99f43dfd info repertoire de stockage 12 123a 123aacd35ef547dabl2ded6b99f43dfd_ lock M thode pour g n rer les uuid function generate_uuid prefix return md5 uniqid prefix true Description du connecteur filetransferprotocol core om_filestorage_filetransferprotocol class php Ce fichier permet de d clarer la classe sp cialis e pour stocker les fichiers sur un FTP ce fichier n existe pas il est l titre d illustration de ce que le syst me est capable de faire Description du connecteur alfresco core om_filestorage_alfresco class php Ce fichier permet de d clarer la classe sp cialis e pour stocker les fichiers sur Alfresco ce fichier n existe pas il est l titre d illustration de ce q
63. g e lt gt Cela est la m thode la plus portable pour inclure du code PHP sur des syst mes d exploitations disposant de configurations diff rentes 5 1 1 4 HTML Valide et W3C Le Code HTML rendu doit tre valid et correspondre aux standards W3C 5 1 1 5 Les commentaires dans le code Tous les fichiers PHP doivent avoir un ent te de ce style lt php k Courte description du fichier Description plus d taill e du fichier si besoin en est 131 openMairie Framework Documentation Version 4 5 package openmairie x version SVN Id x 2 gt 5 1 1 6 Images Les fichiers images ajout s dans les applications openMairie doivent tre au format PNG Portable Network Gra phics Ce format permet d obtenir des images de qualit avec des propri t s de transparence 5 1 2 Versionnage 5 1 2 1 Convention de num rotation des versions Cette convention concerne le framework et les applications Il est convenu de num roter les versions sur 3 chiffres s par s par des points exemple openMairie 4 0 0 Le premier chiffre repr sente une version majeure Le deuxi me chiffre est une volution mineure Le troisi me chiffre est une correction de bug Les versions beta sont indiqu s en fin de num rotation et ne sont jamais maintenues openmairie_exemple_4 0 0beta Seule la derni re version op rationnelle est maintenu Exemple de versionning compl ment de la r
64. le numero et rue avec bing adresse_postale_mapquest php positionnement suivant le numero et rue avec mapquest La g olocalisation automatique peut se faire sur une base externe postgresql eventuellement via une vue le script tab_sig php permet de saisir manuellement le point Affichage de carte L affichage se fait avec openLayers dont le composant est de base dans le framework openMairie lib openLayers le composant est install de mani re a tre optimis avec une css openmairie La librairie proj4 inclus dans lib openLayers permet de pouvoir utiliser les projections lambert sud et lambert 93 La projection g ographique et Mercator est de base dans openLayers L enjeu est donc de projeter les donn es stock es dans la base m tier postgresql postgis les communes devant utiliser le lambert93 en mercator pour tre lisible avec les cartes accessibles sur internet L affichage des datas est fait au travers d une requ te postgresql qui alimente un tableau json lu comme une couche openLayers La data modifier est fourni par requete postgresql au format wkt openLayers voir paragraphe layers tab_sig php permet l affichage de des fond s l affichage de donn es data l affichage du geom tries qui peut tre cr ou d plac couche wkt dans la version 4 2 0 tab_sig permet aussi l affichage de flux wms et wfs getmap et de recuperer les donn es getfeature la coll
65. obj emetteur class php gt affiichage colone incomplet 2 0588235294118 lt 2 5 G n ration de sql pgsql emetteur pdf inc php G n ration de sql pgsql emetteur reqmo inc php G n ration de sql pgsql emetteur import inc php 1 1 2 3 G n rer les formulaires et dition de service Nous allons proc der de la m me mani re avec le bouton service L analyse de la base de donn es est la suivante A analyse Analyse de la base de donn es pgsql openexemple openexemple Elements Infos Tables de la base om_lettretype om_profil om_collectivite om_sousetat om_logo om_utilisateur de donn es om_parametre om_dashboard om_sig_map_comp emetteur courrier om_droit om_sig_map_wms om_requete om_sig_wms om_widget om_sig_map om_etat Table service cl N cl automatique service longueur enregistrement 31 Champs service 11 int libelle 20 string Sous formulaire courrier Cl secondaire Le g n rateur rep re un sous formulaire courrier Effectivement il y a une relation de un plusieurs entre service et courrier un service peut avoir 0 plusieurs courriers En cliquant sur toutes les options vous avez le message suivant Q Table service G n ration de gen sql pgsql service inc php Aucun changement de sql pgsql service inc php Aucun changement de gen sql pgsql service form inc php Aucun changement d
66. permet la configuration des select et select multiple elle effectue les requ tes et met en forme le tableau des valeurs afficher Il est possible de d finir si le champ li est affect par une date de validit ou de configurer l affichage de select_multiple dbform setOnchange amp form maj Permet de d finir l attribut onchange sur chaque champ dbform setOnkeyup form maj Permet de d finir l attribut onkeyup sur chaque champ 70 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 db db db db form setOnclick amp form maj Permet de d finir l attribut onclick sur chaque champ form setGroupe form maj Permet d aligner plusieurs champs obsol te depuis la version 4 3 0 form setRegroupe form maj Permet de regrouper les champs dans des fieldset obsol te depuis la version 4 3 0 form setLayout form maj M thode de mise en page elle permet de g rer la hi rarchie d ouverture et fermeture des balises div et fieldset avec les m thodes formulaire setBloc champ contenu libelle style permet d ouvrir fermer contenu D F une balise div sur un champ champ avec un libell libelle et un attribut class style une liste de classes css pour fieldset est disponible group permet une mise en ligne des champs contenu dans le div et col_1 col_12 permet une mise en
67. pour importer sur le d p t son contenu cd openexemple svn import svn ssh lt NOM_DU_DEVELOPPEUR gt fscm adullact net svnroot lt NOUVEAU_PROJET trunk On se positionne dans son dossier de d veloppement pour cr er la copie locale du projet cd public_html svn co suvn tssh lt NOM_DU_DEVELOPPEUR gt fscm adullact net scmrepos svn lt NOUVEAU_PROJET gt trunk lt NOUVEAU_PROJET gt On se positionne dans le dossier php de l application pour appliquer les externals cd lt NOUVEAU_PROJET gt svn propset svn externals F EXTERNALS txt svn up svn ci Publier une nouvelle version Ce tutorial contient certains pr requis comme le fait d avoir un utilisateur avec les droits corrects sur le projet ou conna tre comment incr menter le num ro de version de l application publier Avant de publier une application il faut v rifier que l EXTERNALS de la librairie openMairie ne pointe pas vers le trunk Pour cela less php EXTERNALS txt created by svn propset svn externals F EXTERNALS txt openmairie svn scm adullact net svnroot openmairie openmairie trunk fpdf svn scm adullact net svnroot openmairie externals fpdf tags 1 6 min pear http svn php net repository pear pear core tags PEAR 1 9 1 db http svn php net repository pear packages DB tags RELEASE_1_7_13
68. pour un ou plusieurs mod les particuliers dans les fichiers correspondants du r pertoire sq1 de l application Elle peut galement tre configur e de mani re globale pour l ensemble dans mod le partir du fichier dyn tab inc php Par d faut il est param tr de la mani re suivante lt php Soptions array type gt wildcard left gt right gt 2 gt left d termine dans la requ te SQL de recherche le caract re ajout au d but gauche de la valeur recherch e right d termine dans la requ te SQL de recherche le caract re ajout en fin droite de la valeur recherch e 64 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Avec cette configuration lorsque le mot admin est recherch dans une colonne toutes les valeurs contenant admin sont retourn es En modifiant la configuration de cette mani re lt php Soptions array type gt wildcard left gt right gt gt Seules les valeurs commen ant par admin seront retourn es Enfin avec lt php Soptions array type gt wildcard left gt right gt 2 gt Seules les valeurs gales exactement admin seront retourn es 3 1 5 3 Configuration des crit res de recherche La recherche avanc e ne fonctionnera pas tant que la liste des champs du formu
69. prendre 4 valeurs 0 affiche un formulaire d ajout le param tre idx n est donc pas n cessaire 1 affiche le formulaire de modification 2 affiche le formulaire de suppression 3 1 Manuel de r f rence 69 openMairie Framework Documentation Version 4 5 3 affiche le formulaire de consultation Les autres param tres pass s permettent de conserver la configuration du tableau d origine 3 1 6 3 Description de la classe dbform class dbform id amp db SDEBUG false Cette classe est centrale dans l application Elle est la classe parente de chaque objet m tier Elle comprend des m thodes de gestion initialisation traitement v rification trigger des valeurs du formulaire Elle fait le lien entre la base de donn es et le formulaire Elle contient les actions possibles sur les objets ajout modification suppression consultation Pr sentation des m thodes de la classe Les m thodes de dbform peuvent tre surcharg es dans obj om_dbform class php ainsi que dans toutes les classes m tier M thodes d initialisation de l affichage du formulaire dbform formulaire enteteTab validation maj amp db postVar aff DEBUG false idx premier 0 recherche tricol idz gt selectioncol advs_id valide retour actions array extra_parameters array M thode d initialisation de l affich
70. pserver user cvs mpl ird fr projet login 1 2 3 4 R pertoire du SERVEUR contenant les sources racine adresse du SERVEUR CVS Ho Votre login vous sur le SERVEUR ho le type d authentification 6 1 2 7 checkout Pour r cup rer les sources du projet en local cd lt r pertoire d sir gt cvs checkout lt arborescence gt 6 1 2 8 Divers aide cvs H nomdecommande log des commit Pour obtenir l historique d une arborescence cd lt r pertoire d sir gt cvs log lt arborescence gt L historique affiche les diff rents identifiants ou tag et les diff rentes versions de l arborescence concern e sous CVS L historique sur un r pertoire affiche r cursivement les historiques des fichiers le composant CVSignore La pr sence de fichier s cvsignore dans un r pertoire permet de dire CVS d ignorer certains types de fichiers cd lt r pertoire d sir gt cat cvsignore Jpg htm 6 1 2 9 Changer le syst me de gestion des version de CVS vers SVN sur la forge de l adullact Le but de ce tutorial est de changer le syst me de gestion de version sur un projet existant sur la forge de l adullact Pr requis Le projet sur l adullact en CVS lt NOM_DU_PROJET gt Le nom du module r cup rer lt NOM_DU_MODULE gt Les droits d administration s
71. rateur suit la proc dure suivante ilutilise la colonne ayant la contrainte PRIMARY KEY si elle existe sinon il utilise la colonne ayant le m me nom que la table S il n existe ni contrainte ni colonne ayant le m me nom que la table le mod le ne peut pas tre cr Note Le fait d utiliser une colonne ayant le m me nom que la table pour d terminer le champ identifiant est l pour une raison de r tro compatibilit Les versions d openMairie ant rieures 4 3 0 n utilisaient pas encore la contrainte PRIMARY KEY Est il possible d utiliser une cl primaire compos e de plusieurs colonnes Non et c est bien mieux comme a 2 1 Manuel d usage 31 openMairie Framework Documentation Version 4 5 Les r f rences vers d autres objets Un mod le de donn es peut contenir un ou plusieurs champs faisant r f rence d autres objets Ces objets pouvant tre de mod le diff rent 2 1 4 4 2 1 D finition des r f rences La m thode pour cr er des r f rences diff re en fonction du SGBD 2 1 4 4 2 2 Avec PostgresSQL Il suffit d ajouter la contrainte SQL FOREIGN KEY des colonnes pour cr er des champs de type r f rence 2 1 4 4 2 3 Fonctionnement interne du g n rateur Comment ces champs sont d termin s lors de la g n ration d un mod le Le g n rateur conserve une liste des colonnes qui donneront apr s g n ration des champs r f rences Pour cr
72. rubrique est en cours de r daction 3 1 12 1 Principe les requ tes m moris es permettent au d veloppeur de fournir un ensemble de requ tes m moris es accessible dans le menu export gt requ tes param trables par l utilisateur permettant un affichage html en tableau ou un transfert au format csv sur tableur choix du s parateur 1 utilisateur menu export gt requete Applications Raccourcis Syst me jchier diti 3 oriq arque pages Qutils Aide i amp gt Q http localhost svn_openmaine openmairie_exemple trunk seriregmo php G y a Mairie gt Bropenmarie gt Les plus visit s EnClasseur gt 0jhttp demo openma o Gestion de question 4 poedit Recherche Google X phpMyAdmin 2 11 3deblub X openMairie opanExempl X Microsoft Outlook web Access X demo accm sur mysql A o Open Tableau de bord Les requetes memorisees permettent d exporter des donnees de la base de donnees pour une utilisattion externe a l application Veuillez chquer sur l objet a exporter pour atteindre un formulaire vous permettant de choisir les parametres de l export Choix de la requete memonsee 2 om parametre 2 om prof 2 om _sousetat 2 om_utilisateur openExemple Version 4 0 0 dev Documentation openMairie org 3 1 12 2 Param trage Le script de param trage sql pgsql lt OBJ gt reqmo inc php Les parametres de reqmo sont 94 Chap
73. site openMairie un lien vers le site openMairie Le nom du logiciel est r cup r de la variable Sconfig application pr sente dans le fichier dyn config inc php La version est r cup r e de la variable version pr sente dans le fichier dyn version inc php La configuration des liens se fait dans le fichier dyn footer inc php Ce fichier de param trage n est pas obligatoire Si il n existe pas aucun lien n est affich Ce fichier de param trage doit contenir la d claration d un tableau de tableaux associatifs dans la variable footer Chaque tableau associatif repr sente un lien lt 2php On initialise le tableau conteneur Sfooter array On ajoute au tableau conteneur un tableau associatif repr sentant un lien r p ter autant de fois que n cessaire Sfooter array title gt _ Link description gt _ Description href gt scr link php target gt _blank class gt action link Fight gt viral 2 gt 56 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Param tre Requis Description title O Texte description N Texte qui s affiche au survol de l l ment href N Contenu du lien href target N Attribut pour ouvrir le lien dans une nouvelle fen tre class N Classe CSS qui s affiche sur l l ment right N Permission n cessaire l utilisate
74. sous le format _ zone a traduire Voir le chapitre sur les outils poEdit 3 1 Manuel de r f rence 57 openMairie Framework Documentation Version 4 5 3 1 3 4 Le param trage de l application metier L application m tier est param tr e dans dyn var inc Ce script contient les param tres globaux de l application Attention les param tres s appliquent toutes les bases de l application Le param trage sp cifique par collectivit doit se faire dans la table om_parametre La configuration g n rale de l application se fait aussi dans dyn config inc php Les param tres sont r cup r s avec la cr ation d un objet utils par f gt config nom_du_parametre Voir framework utilitaire Exemple de param trage avec openCourrier Sconfig application _ openCourrier Sconfig title _ openMairie _ openCourrier Sconfig session_name openCourrier le mode demonstration de l application se param tre avec config demo Ce mode permet de pre remplir le formulaire de login avec l identifiant demo et le mot de passe demo Sconfig demo false l application n est pas en mode d mo true l application est en mode d mo Attention pour emp cher de changer le mot de passe il faut param trer l acc s dans la table om droit password La configuration des extensions autorisees dans le module upload php 52 9
75. suivants l environnement de d veloppement l environnement de d monstration l environnement de tests Note Ce fichier comporte l initialisation des commandes postgis par d faut pour la derni re version de postgis Les commandes pour l ancienne version sont pr sentes et comment es dans ce m me fichier 3 1 2 2 Param trage de la connexion la base de donn es Le param trage de la connexion la base de donn es se fait dans le fichier dyn database inc php Note Dans le framework le sch ma utilis par d faut est openexemple dans les applicatifs c est normalement le nom de l applicatif lt APPLICATIF gt par exemple openelec opencimetiere lt php xk Ce fichier permet le param trage de la connexion la base de donn es Chaque entr e du tableau correspond a une base diff rente Attention l index du tableau conn repr sente l identifiant du dossier dans lequel seront stock s les fichiers propres a cette base dans l application package openmairie exempl version SVN Id database inc php 2302 2013 05 23 1832043222 fmichon PostGreSQL conn 1 array openExemple Titre pgsql Type de base pgsal Type de base postgres Login postgres Mot de passe tcp Protocole de connexion localhost Nom d hote 5432 Port du serveur Socket openexemple Nom de la base AAAA MM JJ
76. tableaux co 5 i i 4 a due me su nue is 26 21 32 1 10 Gestion des code barr s y ios 6 6 Susan res Ra 28 Za iz al Gestondessautsdepase z gt sone a a e 28 2 1 321 12 Gestion du mode plein cran a soi m ieie arcs tes 28 2415324113 JIns rtondeSOUS tats es sr sun vessie A 28 2 1322 SOUS TARS e 2 a E Ba mens N See 8 28 LIS REQUEST rare 28 ZIZA LOOS o a e en aE anawauns den E mnt 28 2 1 3 3 Lag olocalisati i cogi don dus us Lan Mu E 28 ZA GENETAION spore radar A a e e aa do mue 28 ZLUAJL Introduction caceria rs a ee Le t 29 21242 L ntertace oros ro A a AA R d lai 4 29 241421 Analyse dela Dase a p 2 462 28429A pi e A 30 2 1422 Les fichiers p n rer ii e e es 30 ZAS Conditions d ps Nn TANON 22550808 qe PE panne SR ANNEE 8 84 31 2 1 4 3 1 Contraintes de la base de donn es 31 2 1 4 3 2 Contraintes du syst me de fichiers 31 2 1 4 4 D finition des mod les de donn es 31 ZLAAT L id nutant amp 2 544 da la a e a ba e 31 2 1 4 4 1 1 D finition de P identifiadt 31 2 144 122 Fonctionnement interne du g n rateur 31 2 1442 Les r f rences vers d autres objets 32 2 1 4 4 2 1 D finition des r f rences s oc 44 4 32 214422 Avec PosterEs SQL auss suisse sie eme te 32 2 144 2 3 Fonctionnement interne du g n rateur 32 2 1
77. un fichier t l charg sur le serveur pdf ou image spg upload php Ce script utilise la classe core upload class php composant openMairie Le param trage des extensions t l chargeables se fait dans dyn config inc php Le param trage de la taille maxi male des fichiers t l chargeables se fait dans la classe m tier de l objet spg rvb php et js rvb js Ce script est associ au champ rvb et affiche une palette de couleur pour r cup rer un code rvb Les m thodes de construction et d affichage Le formulaire est constitu de div fieldset et de champs les m thodes suivantes permettent une mise en page structur e formulaire entete ouverture du conteneur du formulaire formulaire enpied fermeture du conteneur du formulaire formulaire afficher affichage des champs appelle les m thodes suivante formulaire debutFieldset ouverture de fieldset formulaire finFieldset fermeture de fieldset formulaire debutBloc ouverture de div formulaire finBloc fermeture de div formulaire afficherChamp affichage de champ Les m thodes assesseurs changent les valeurs des attributs de l objet formulaire Ces m thodes sont appel es depuis les classes m tier elles permettent la configuration du formulaire formulaire setType type de champ formulaire setVal valeur du champ formulaire setLib libell du champ formulaire setSelect permet de remplir les champ
78. un formulaire ne s affichant que si la recherche avanc e est activ e Il permet aux utilisateurs de b n ficier de plusieurs champs et ainsi effectuer des recherches plus pr cise qu avec le formulaire de recherche simple Description du formulaire il peut afficher plusieurs champs de type texte nombre date ou liste choix il permet pour chaque tableau de configurer la liste des champs affich s il permet pour chaque champ de rechercher des valeurs strictes ou approximatives par d faut approxi matives il permet pour chaque champ de rechercher des valeurs dans des tables et des colonnes qui ne sont pas affich es il conserve les valeurs recherch es apr s la r alisation d une action ajout modification etc il dispose d un bouton Vider le formulaire permettant de vider les champs il dispose d un bouton permettant de basculer sur le formulaire mono crit re 3 1 Manuel de r f rence 63 openMairie Framework Documentation Version 4 5 3 1 5 2 Configuration de la recherche avanc e Activation Exemple avec le mod le om_utilisateur Pour activer la recherche avanc e rendez vous dans le fichier sq1 sgbd om_utilisateur inc php et ajoutez la configuration suivante au tableau d options lt php Soptions array type gt search display gt true advanced gt champs default_form gt advanced absolute_object gt om
79. utils class php Sf new utils NULL courrier _ recherche ico_recherche png recherche Les parametres de l objet sont les suivants flag si flag Null affichage complete nonhtml pas d affichage htmlonly tout les elements externes html avec body vide 3 1 Manuel de r f rence 117 openMairie Framework Documentation Version 4 5 right droit g r en om_droit vide ne verifie pas title titre affich icon icone affich help aide affich utils class php fait la Verification si l utilisateur est authentifi et si l utilisateur a le droit util class surcharge core om_application class php qui contient les scripts de base du framework Si le param tre right est vide vous pouvez faire appel aux m thodes suivantes isAccredited a le droit ou pas isAuthentified si non authentifi il est rejet f gt setRight ob3 affecte un droit d acces Sf gt isAuthorized verification que l utilisateur acc de Affectation des variables en dehors du constructeur f gt setTitle ent Sf gt setlIcon ico Sf gt setHelp obj Sf gt setFlag NULL affichage Sf gt display Pour executer une requ te dans un fichier sql vous devez stocker votre requ te dans le r pertoire sql type_de_sgbd nom_de_requete inc afin de pr server la portabilit de vos travaux sur d autres sgbd appel au fichier requ te include sql f
80. www openstreetmap org Chercher la ville exemple Gr asque Ajuster la carte aux fronti res communales Aller dans 1 onglet export et noter les coordonn es g ographiques zone exporter 3 1 Manuel de r f rence 107 lname nbsp openMairie Framework Documentation Version 4 5 OpenStreetMap OpenStreetMap Recherche O suis4e 9 Place Grenette HZY 1C6 ou post office near errples Aigar vAutres an OpenStreetMap est une carte du monde entier librement modfiable fate par des gens comme vous OpenStreetMap vous Voir Modifier Historique Exporter Traces GPS journaux Zone exporter 43 4426 5 5017 115 5919 S lectionner manuellement une autre zone Format exporter gt Donn es XML d OpenStreetMap image de Mapnik 3 Image dOsmarender J HTML incorporable Options permet de voir modifier et utiliser des donn es g ographiques de n importe quel endroit dans le monde OpenStreetMap est gracieusement h berg par the UCL VR Centre imperial College London et Bytemark Hosting D autres sponsors du projet sont list s dans les miki Format PNG 1 chelle 1 27500 max 2 13500 Taille de l image 1304 x 687 Dans le fichier dyn var_sig inc modifier le tableau de variables avec les coordonn es de la mani re suivante Scontenu_etendu Scontenu_etendu 0 array 5 5155 43 4081 5 5781 43 4426 5 1 array greasqu
81. 1 3 2 1 6 Param tres des sous tats Police personnalis e s lection de la police des sous tats Couleur texte s lection de la couleur du texte des sous tats EJ Champ s de fusion requ te Requ te SQL champs de fusion substitution_vars 2 1 3 2 1 7 Bloc champs de fusion Requ te s lection d un jeu de champs de fusion Champs de fusion Liste des champs de fusion disponibles pour la requ te s lectionn e Variables de remplacement Liste des variables de remplacements disponibles 2 1 3 2 1 8 Aide la saisie dans les diteurs de texte riche Trois configurations diff rentes de l diteur de texte riche sont utilis es configuration n 1 corps de l dition configuration n 2 titre de l dition configuration n 3 blocs de texte avec une mise en forme limit e toujours destin s tre int gr dans une dition via un champs de fusion Fonction Configuration N N2 N3 Tableaux x x Saut de page x Code barres x x Majuscule Minuscule x x x Insertion de sous tats x Plein cran x x Correction orthographique x x x Voir le code source x x X 2 1 3 2 1 9 Gestion des tableaux Cr er un tableau Choisir le nombre de lignes et de colonnes du tableau Note Il faut bien placer le curseur dans une des cellules du tableau que l on souhaite param trer Idem pour le param trage des lignes et colonnes
82. 4 43 55932 5 2094 43 4136 5 3345 43 4759 Y Scontenu_etendue 1 array agglomeration salin de giraud raphele Mas thibert vitrolles Scontenu_epsg 0 array EPSG 2154 EPSG 27563 Scontenu_epsg 1 array choisir la projection lambert93 lambertSud La version 4 4 0 contient les tendues des communes des bouches du rh ne 3 1 13 2 objet map ce chapitre propose de d crire l utilisation de l objet map d openLayers dans tab_sig php Cet objet permet de d finir le div ou la carte sera affich e dans tab_sig php la carte s affiche avec le div map Id les options de la carte et les controles affich s 3 1 13 3 afficher les layers ce chapitre propose de d crire l utilisation de l objet layers d openLayers dans tab_sig php 3 1 Manuel de r f rence 97 openMairie Framework Documentation Version 4 5 dossier PCO1 a M Data Dans le lien il est possible de d finir la carte a afficher suivant l id obj Obligatoire le fond affichable par d faut sat bing osm amp fond l tendue amp etendue 1 enregistrement modifier amp idx Les cartes sont param tr es dans om_sig_map menu administration Administration Om_sig_map 3 DOSSIER a fosse Mel fair O a zoom 10 osm WW bing sat layer into ndue aoolomeraton projecton flames y
83. 44 24 Affichage dans les formulaires 32 21443 Les champs uniques 2 v 144 e bu damage 32 2 1 4 4 3 1 D finition des champs uniques 32 2 144 3 2 Fonctionnement interne du g n rateur 32 2 1 4 4 3 3 Affichage dans les formulaires 32 2 14 4 4 Les champs requis ssi suive 4 4 ram e 4 d iea 33 2 1 4 4 4 1 D finition des champs requis 33 2 144422 Fonctionnement interne du g n rateur 33 2 1 4 4 4 3 Affichage dans les formulaires 4 s o 4 40 40 0 60 e e lt 33 21445 E champlibell sacre p bas 6 3284 8 6 8 8 4 6 8087 e 3 84 33 2 1 4 4 5 1 D finition du Libell ss 424 4 SI a E R SD Abs DE A A 33 21 45 Fonctionnalit s avanc es iio a ch ep mate Noa 33 2 1 4 5 1 Ajouter une date de validit un mod le 33 2 1 4 5 1 1 Descriptio 44 4 pe opaa E a etes 33 2 1 4 5 1 2 D finition des dates de validit 34 2 1 4 5 1 3 Affichage dans les formulaires 34 2 146 Lianalysedelabase 44 2 4 su sd eed e Eu nu te de 34 2146 1 Type de champs aac 24 subie resta ea 34 2 1 4 6 2 Equivalence type pgsql type openMairie 35 2 1 4 6 3 Nom de champ et nom de table 35 2 147 Les fichiers SEN T S vers pe Se TR 5 15 E ee A 35 ZLA TL Formulaires sre 44 4 4e des gode gb de se tte 49 a E de 36 2 1 4 7 1 1 Param tres det p
84. 7 1 144 Les surcharges d openCimetiere 17 DIS Cr er SES TAIS z Sa 2 LR EN de de NAME Mes DRE Re S A 18 11351 Ereerletat services os Es a A Ra 18 1 1 5 2 Cr er le Sous tat Courrier i so o ro a 4e 19 1 1 5 3 Associer le sous tat courrier l tat service ooo o 19 1 1 5 4 Mettre le nom et le pr nom de l emetteur dans le sous tat 21 23 Manueld usage co 244444 6 4 ba h 6 6 ath e mins ea 23 211 Installation s poe mecie sente o e RE es S 23 212 gt Confisuratiofr 2 8 Bu sonate b 3 heu a Nu A 23 2a ATMAMSTAONT EE LE ab AS CURE E a a E 23 2131 Les tabl aux de bord s s p 5 us dus 4 004050 ee sp Neue een 23 ZILI Widgeta iia A a 98 N 23 2 1 3 1 2 COMPOSITION y 8 ue 4 A RR RRA A 23 24327 ES UONS mase s e ge A A AA e 16 ii 23 21321 tats et lettres DP i a rra E 23 2 1 3 2 1 1 Bloc dition oo ps dios ds se ce bas e be 23 2 1 3 2 1 2 Param tres g n raux de l dition 24 211 323 Bloc titre coo a domi ar v 6 sed eme 24 2 1 3 2 1 4 Param tres du titre de l dition cs 54 454444 82 25 2 1 3 2 1 5 BIOG COMS lt x r 48 p AR R te 0 E r a e Er ses 25 2 1 3 2 1 6 Param tres des sous tats i sordos 5 52 444 lue 26 21 3 2 1 7 Bloc Champs de fusion se mecre isa e a 26 2 1 3 2 1 8 Aide la saisie dans les diteurs de texte riche 26 2 1 3 2 1 9 Gestion des
85. BUG false Permet d effectuer des actions avant la modification des donn es dans la base form triggermodifierapres id amp db NULL val array DEBUG false Permet d effectuer des actions apr s la modification des donn es dans la base form triggersupprimer id amp db NULL val array DEBUG false Permet d effectuer des actions avant la modification des donn es dans la base 3 1 Manuel de r f rence 73 openMairie Framework Documentation Version 4 5 dbform triggersupprimerapres id amp db NULL val array DEBUG false Permet d effectuer des actions apr s la modification des donn es dans la base 3 1 6 4 Description de la classe formulaire class formulaire unused NULL validation maj champs array val array max array Cette classe permet une gestion compl te de l affichage d un formulaire Les m thodes de core om_formulaire class php peuvent tre surcharg es dans obj om_formulaire class php M thodes d affichage de widgets Les widgets sont des l ments de formulaire ils sont compos s d un ou plusieurs champs Chaque m thode permet d afficher un seul widget formulaire text champ texte format standard formulaire hidden champ non visible avec valeur conserv e formulaire password champ password formulaire textdisabled champ texte non modifiable gris formulaire textreadonly champ texte non modifiable for
86. DE L OBJET f require_once obj utils class php 3 1 Manuel de r f rence 119 openMairie Framework Documentation Version 4 5 Y f new utils NULL traitement _ remise a 0 du registre ico_registre png recherche get if isset _GET validation validation GET validation l jelse Svalidation 0 xx x Description de la page description _ Cette page vous permet de remettre a 0 le numero de registre Ce traitement est a faire en debut d annee Sf gt displayDescription description TEST VALIDATION SI 0 affichage du numero de registr SI 1 mise 0 du registre et affichage du r sultat if validation 0 Svalidation 1 REQUETE DU REGISTRE sql select id from registre_seqg res1 f gt db gt getOne sql Sf gt isDatabaseError resl AFFICHAGE DANS UN FIELDSET echo lt fieldset class cadre ui corner all ui widget content gt n echo t lt legend class ui corner all ui widget content ui state activel gt echo _ Registre lt legend gt if resl 0 echo lt br gt _ le dernier no du registre est nbsp nbsp resl snbsp enbsp else echo lt br gt _ vous avez deja fait une remise a 0 lt br gt echo lt form method POST action num_registre php validation valida
87. EN 47 ZILELE TESES so sipa ea E d a rbd de eu ma 47 STE EMP e2 SUR a e e Mise G 8 47 FIERO EPSA gus MR A EN RS ER CN Re 47 3 1 1 2 Les r pertoires du framework oses pop pus aaa dada een 48 IEZ DRD NL e e e MMS EE SM SMS Si USA 48 ILIZ Coref 44 uses RR SE rs RER REA 48 HS CSS rr a UD 48 E o A be se his sonate kgs phase 48 ILUS DES sus si sentis Ardo ARA AAA 48 A DID hs ou peus dis ss his ne ss mage 48 31127 HAE sue AE a AR REA o a 4 Gs rE 49 IRES SCT Les are di Ra N a RE Bi N SAR RAS 49 NA Spa sisi sas si dd lets wes Landes DE 49 3 1 2 Initialisation de la base de donn es 49 3 1 2 1 Description du dossier data pgsql nss pares 44 e R da sede 49 3 1 2 1 1 Description de tous les fichiers initx sql 49 31211A Le fichier 2n tt Sales nch ia Ae a do e GA 49 31 21 12 Les fichiers init_metierx sql 50 3 12 1 7 3 Les fichiers init_parametragex sql 50 3 1 2 1 1 4 Lehcmer init data SO ea Les a 50 3 1 2 1 2 Description des fichiers vX X X sqlouver_X X X sql 50 3 1 2 1 3 Description du fichier update _sequences sql 50 31214 Description du fichier install SQL se sspe sies mass 51 3 1 2 2 Param trage de la connexion la base de donn es 51 3 13 Param trage du framework 5 2 sus it e ie AE e Es Ier 51 JLL Les zones de navigation s pcos 4 rr a ttes 32 SES 729 ES ora ad dd 53 3 1 3 1 2 Lesacti ns pe
88. G pour formulaire ou comboD2 et comboG2 pour sous formulaire comboaffichage inc php param tre de l affichage dans la fen tre combo php comboparametre inc php affecte des valeus sp cifiques au formulaire parent si il y a plusieurs nregistrement en lien choix en affichage comboretour inc php meme chose que comboparametre inc si il n y a qu un enregistrement en lien pas d affichage de la fenetre Voir chapitre framework formulaire sous programme g n rique combo php 3 1 3 11 Les param tres ditions Les variables dans les ditions sont param tr es dans varpdf inc pour les pdf varetatpdf inc pour les tats et les sous tats varlettretypepdf inc pour les lettres typ Voir chapitre framework dition 3 1 3 12 Les param tres om_sig var_sig php les param tres sont les suivants 60 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Scontenu_etendue 0 array 4 5868 43 6518 4 6738 43 7018 Scontenu_etendue 1 array vitrolles Scontenu_epsg 0 array EPSG 2154 EPSG 27563 Scontenu_epsg 1 array choisir la projection lambert93 lambertSud Stype_geometrie 0 array point line polygon Stype_geometrie 1 array choisir le type de g om trie point ligne polygone ces param tres sont utilis s pour la saisie de carte voir chapitre sig
89. ISTRATEUR _ Sig Om_sig_map Modifier l enregistrement de la table Utilisateur a Retour Om_sig_wms Options Avancees Import openExemple Version 4 3 0 dev Documentation openMairie org G n rateur Suppression Accessible depuis la liste des actions contextuelles une confirmation est demand e pour chaque suppression Acc s L acc s aux formulaires se fait depuis un tableau d l ments ou depuis la consultation d un l ment via le menu contextuel Par d faut depuis les tableaux les actions d ajout et consultation sont disponible 3 1 6 2 Description technique La gestion des formulaires se base sur deux classes formulaire core om_formulaire class php dbform core om_dbform class php La classe formulaire permet la gestion de l affichage et dbform g re le traitement des donn es et la liaison la base de donn es scr form php et scr sousform php Ces scripts sont appel s pour afficher un formulaire Ils instancient l objet et appellent la m thode formulaire de celui ci Ces scripts prennent plusieurs param tres obj nom de la classe pour laquelle on souhaite afficher le formulaire action type d action ajout modification suppression consultation idx identifiant dans la base de donn es de l l ment sur lequel on souhaite effectuer l action retour deux valeurs possible tab ou form selon l origine de l action Le param tre action peut
90. Im Pour supprimer des l ments la version locale afin de les supprimer ensuite d finitivement de cd lt r pertoire d sir gt cvs remove f lt arborescence gt x f pour effacer le fichier avant de le supprimer Il faut d abord supprimer le fichier du r pertoir rm filel file2 cvs rm filel file2 cvs ci m suppression des fichiers Supprimer un r pertoire n est pas possible directement il faut aller le supprimer d ns le serveu 6 1 2 3 local Suppression d une copie locale 140 Chapitre 6 Outils openMairie Framework Documentation Version 4 5 pour viter d effacer un checkout en oubliant nos modifications Pour effacer les sources pr sentes sur le poste local et faire confiance au repository cd lt r pertoire d sir gt cvs release d lt arborescence gt x d pour effacer d finitivement l arborescence cvs release d module status Pour obtenir le d tail statut de la version locale d une arborescenc cd lt r pertoire d sir gt cvs status lt arborescence gt cvs st gt status diff log cvs diff cvs log lt nomfichier gt cvs diff lt nomfichier gt local differentiel cvs diff r 1 5 r 1 6 nomfichier entre 2 versions 6 1 2 4 export exemple opencimetiere_facture se mettre dans le repertoire openmairie_cimetiere_facture taguer la version cvs ta
91. Mairie Framework Documentation Version 4 5 Voici la liste des tapes reproduire Sur GitHub ajouter une nouvelle branch en reprenant la version majeure et mineure pour la nommer dans le readme de la documentation modifier les versions dans le fichier source conf py modifier les variables project copyright version et release dans le fichier source index rst modifier le titre de la documentation dans settings modifier la branche par d faut pour mettre la nouvelle Sur readthedoc dans le menu admin puis version changer la version par d faut d sactiver la version stable et latest Depuis URL docs openmairie org faire un refresh pour mettre jour la page de pr sentation des documenta tions http docs openmairie org refresh Dans l application modifier le lien dans le fichier doc index php pour pointer vers la nouvelle URL 5 1 R gles 133 openMairie Framework Documentation Version 4 5 134 Chapitre 5 R gles CHAPITRE 6 Outils 6 1 Outils Cette section vise rassembler des liens des informations des tutoriels sur des outils qui ne font pas partie du Framework mais qui sont utilis s par la communaut 6 1 1 Apache Subversion SVN Site officiel du projet SVN 6 1 1 1 Pr requis Installer subversion http subversion apache org packages html Il existe galement des outils graphiques comme TortoiseSVN Windows 6 1 1 2 L ar
92. Mises niveau 4 1 1 La version 4 5 4 1 1 1 Les nouveaut s de la version 4 5 4 1 1 2 Mettre niveau depuis openMairie 4 4 vers 4 5 Remplacer tous les appels au script scr requeteur php par des appels au script scr reqmo php Le code du module Reqmo a t factoris et a entrain la suppression du script en question 4 1 2 La version 4 4 4 1 2 1 Les nouveaut s de la version 4 4 4 1 2 2 Mettre niveau depuis openMairie 4 3 vers 4 4 Cette proc dure permet de mettre niveau une application utilisant openMairie version 4 3 0 vers openMairie 4 4 0 Pour conserver une application fonctionnelle tout au long de la mise niveau il est vivement conseill de suivre les tapes de cette proc dure dans l ordre ne pas utiliser le g n rateur lorsque ce n est pas indiqu Consultez la section sur les erreurs connues si des erreurs persistent apr s la mise niveau tape 1 mettre jour la base de donn es 4 1 2 2 1 1 La structure La structure de la base de donn es d openMairie a chang e sensiblement depuis la version 4 3 0 Pour mettre jour la base de donn es depuis cette version il faudra ex cuter le script SQL ver_4 4 0 sql Pour PostgresSQL data pgsql ver_4 4 0 sql 123 openMairie Framework Documentation Version 4 5 Important Le support de mysql t abandonn R g n rer les fichiers via le g n rateur V rifier les surcharges des objets
93. Pour changer votre configuration d commenter la ligne et modifier les extensions avec des comme s parateur Sconfig upload_extension gif jpg jpeg png txt pdf csv La configuration de la taille maximale des fichiers dans le module upload php Pour changer votre configuration d commenter la ligne et modifier la taille La taille maximale est en mo Sconfigl upload taille max str_replace M ini _get upload max_filesize 4 1024 Le th me de l application A partir de la version 3 1 0 le theme n est plus g r dans config inc php Il est initialis dans EXTERNALS TXT du repertoire om theme version 4 2 0 exemple pour om_ui_darkness om_theme svn scm adullact net svnroot openmairie externals jquery ui theme om_ui darkness tags 1 8 14 3 1 3 5 Le Parametrage des librairies Le param trage de l acc s aux librairies se fait dans dyn include inc php Ce fichier permet de configurer les paths en fonction de la directive include_path du fichier php ini Vous pouvez aussi modifier ces chemins avec vos propres valeurs si vous voulez personnaliser votre installation PEAR array_push include getcwd php pear DB 58 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 array_push include getcwd php db FPDF array_push include getcwd php fpdf OPENMAIRIE d
94. Tutoriaux Importer un nouveau projet Un nouveau projet est une nouvelle application qui se base sur la derni re version tagg e d openmairie_exemple Ce tutorial contient certains pr requis comme la cr ation du projet sur la forge le fait d avoir un utilisateur avec les droits corrects sur le projet le fait d avoir consulter la derni re version tagg e d openmairie_ exemple On se positionne dans la dossier tmp pour r cup rer la derni re version d openmairie_exemple cd tmp svn export ignor xternals svn scm adullact net svnroot openmairie openmairie_exemple tags lt DERNIERE_VERSION_OPENMAIRIE_EXEMPLE gt openexemple On cr l arborescence standard sur le d p t si elle n existe pas d j svn mkdir svn ssh lt NOM_DU_DEVELOPPEUR gt fscm adullact net scmrepos svn lt NOUVEAU_PROJET gt trunk svn mkdir svn ssh lt NOM_DU_DEVELOPPEUR gt fscm adullact net scmrepos svn lt NOUVEAU_PROJET gt tags svn mkdir svn ssh lt NOM_DU_DEVELOPPEUR gt fscm adullact net scmrepos svn lt NOUVEAU_PROJET gt branches On se positionne dans le dossier pr c demment import pour supprimer les r pertoires recup rer en EXTER NALS depuis le framework cd openexemple rm rf core css img js lib pdf php scr spg tests resources core On se positionne dans le dossier pr c demment import
95. _utilisateur gt Note A partir de la version 4 3 0 d openMairie le tableau options est disponible dans les fichiers sq1 de l application Il n est plus n cessaire de le d clarer manuellement La cl t ype est obligatoire Elle permet de d finir le type de l option Pour une recherche il faut saisir search La cl display est obligatoire Elle permet d afficher ou non la recherche tout en conservant sa configuration true permet d afficher la recherche false permet de masquer la recherche La cl advanced est obligatoire pour la recherche avanc e Elle permet de pr ciser que le formulaire de re cherche est un formulaire de recherche avanc e et non simple Cette cl doit contenir le tableau des champs configur s pour la recherche voir plus bas pour la configuration des champs La cl default_formest optionnelle Elle permet de choisir quel formulaire de recherche est ouvert par d faut La valeur advanced permet d afficher le formulaire multi crit res Les autres valeurs ou si default_form n est pas configur affichent le formulaire mono crit re La cl absolute_object est obligatoire Elle permet de sp cifier openMairie le nom du mod le l objet recherch Ce nom est celui du fichier dans ob3 ici om utilisateur class php sans son extension Autres param tres Wildcard Le wildcard permet de rendre la recherche stricte ou approximative Cette option peut se configurer
96. age de formulaire dbform sousformulaire enteteTab validation maj amp S db postVar premiersf DEBUG idx idxformulaire retourformulaire typefor mulaire objsf tricolsf retour actions array M thode d initialisation de l affichage de sous formulaire Ces m thodes instancient un objet formulaire et initialisent certains de ses attributs via les m thodes suivantes dbform setVal amp form maj validation Permet de d finir les valeurs des champs en contexte formulaire dbform setValsousformulaire amp form maj validation idxformulaire retour formulaire typeformulaire Permet de d finir les valeurs des champs en contexte sous formulaire dbform set_form_default_values amp form maj validation Permet de d finir les valeurs des champs en contextes formulaire et sous formulaire dbform set Type amp form maj Permet de d finir le type des champs dbform setLib amp form maj Permet de d finir le libell des champs dbform setTaille form maj Permet de d finir la taille des champs dbform setMax amp form maj Permet de d finir le nombre de caract res maximum des champs dbform setSelect amp form maj db DEBUG false M thode qui effectue les requ tes de configuration des champs dbform init select amp form null amp db null maj debug field sql sql_by_id om_validite false multiple false M thode qui
97. ale t_voie rivoli code adresse t_numero num_ voi numero dans la voie t_complement suf_voi suffixe bis ter t_geom the_geom geometry point X Y t_adresse typevoie nomvoie libelle de 1 adresse 104 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 t_quartier id parc xxx a voir St_cp nom champ cp t_ville nom champ ville St_insee nom champ insee champ du formulaire ou l adresse est saisi pour retour du point de geolocalisatior Sf_numero numero_voie nom champ du numero dans la voie f_voie voie nom champ du code de la voie rivoli f_complement complement nom champ du complement de numero Sf_geom geom nom champ geometrique point X Y Sf _libelle libelle _voie nom champ libelle de la voie xxx a voir Sf_cp nom champ cp Sf ville nom champ ville f insee nom champ insee Cas ou la table d adresse est stock es dans une autre base voir parametrage framework de database inc php Sdb_externe O0ui Oui base externe Sdsn_externe array title gt base locale des adresses de 1 IGN phptype gt pgsql dbsyntax gt pgsql username gt postgres password gt postgres protocol gt tcp hostspec gt localhost port gt 5432 socket gt database g
98. analyse de la base en cours liste des tables de la base l information sur la cl primaire de la table la longueur de l enregistrement de la table les informations sur les champs nom type et longueur les cl s secondaires exemple table om_colllectivite les sous formulaires associer A partir de la version 4 2 0 il n y a plus de choix de param trage dans l cran Les fichiers g n rer Il est propos une liste de case cocher La case est coch e sur le fichier correspondant n existe pas colonne de droite Le formulaire m tier auto g n r table inc tableform inc est toujours coch fichiers en gen gen obj table class php gen sql basededonnees table inc gen sql basededonnees table form inc La g n ration de ces 3 fichiers ne met pas en p ril votre programmation qui est en obj table class php sql basededonnees table inc sql basededonnees table form inc basededonnees mysql ou pgsql 30 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 2 1 4 3 Conditions de g n ration Contraintes de la base de donn es Pour qu un mod le de donn es puisse tre g n r il faut que la table de base de donne s qui le repr sente remplisse les conditions suivantes la table doit avoir une cl primaire compos e d une seule colonne ou une colonne portant le m me nom que la table les cl s trang res doivent r f ren
99. ani re suivante function setVal amp S form maj validation amp S db DEBUG null1 parent setVal form maj S validation db SDEBUG null r if validation 0 if maj 0 Sform gt setVal dateenvoi date Y m d Le champ dateenvoi contiendra la date syst me date Y_m d si la validation est gale O ce qui signifie que le formulaire n a pas t valid et si maj est gal O ce qui signifie qu il s agit d un ajout Les autres valeurs que peut prendre maj sont 1 modifier 2 supprimer 3 consulter 1 1 3 4 Mettre en majuscule un champ Nous souhaitons maintenant mettre en majuscule le champ nom de la table emetteur Nous allons surcharger la m thode setOnchange dans obj emetteur class php de la mani re suivante function setOnchange amp form maj parent setOnchange form ma j Sform gt setOnchange nom this value this value toUpperCase A la saisie ou la modification du nom le champ se mettra en majuscule 1 1 3 5 Principe retenir Voila quelques exemples des possibilit s de modification dans les fichiers sql r pertoire sql et dans les m thodes de l objet repertoire obJ En aucun cas il ne faut modifier les fichiers dans gen qui est l espace de travail propre au g n rateur Nous allons dans le prochain chapitre modifier la base et reg n rer les crans sans met
100. ans 63 3 1 5 12 Recherche avanc e cio La ep bus men amp o a da 63 3151 21 Recherche avanc e mono crit re 63 3 1 5 1 2 2 Recherche avanc e multi crit res 63 3 1 5 2 Configuration de la recherche avanc e 64 3150251 ACHVAUON nan jh RSR Nbr a EAU es 64 313 22 Autres param tres pa cs aa sa fines 4 8 4 64 3 41 5 3 Configuration des crit res de recherche cso 4 444 4 sorda eus 65 3 1 5 3 1 Configuration simple gt 444854 e a eo ne ee us bem 65 3 1 5 3 2 Configuration avanc e x s c x ss ss sisi us sus us 66 3 1 5 3 2 1 Cr er un intervalle de dat cocor 44 ua ri sise 66 3 1 5 3 2 2 Cr er un champ de recherche avec menu d roulant personnalis 66 3 1 5 3 2 3 Tester si une donn e est pr sente ou non dans un groupe de donn es ss st si sens stress Ads s ben 67 Les formulaires 4 3 o sas su m Dies situe mie o mue a 68 ILGI Introduction siaus 8 m dus a e E La 68 JREF Consultation e a Le es 68 IDOT2 AOU id LU da er Nr E D BAN 68 3 1 641 3 Moditicatlon 3 5 g 4 HE BR Us Lu ele sh 69 FLOTA Suppression oa su ae me N Ses nr RA 69 3657 ACCESS ses Lise Mes A saut 69 3 1 6 2 Description technig s s spos ce 4 dau geste he Ne ah bus 69 3 1 6 2 1 scr form php et scr sousform php 69 3 1 6 3 Description de la classe dbform s s soso 44e 0 6 G 6 ds 70 3 1 6 3 1 Pr sentation des m thodes de la classe
101. ans CORE depuis la version 4 2 0 define PATH_OPENMAIRIE getcwd core openmairie Par d faut les librairies sont incluses dans openmairie_exemple lib contient les librairies javascript php contient les librairies php 3 1 3 6 Le mode DEBUG Dans le code pour logger une information il suffit de d utiliser la ligne suivante Sthis gt addToLog requete sig_interne maj parcelle inexistante sql EXTRA_VERBOSE MODE Les diff rents modes DEBUG pr sents dans l application sont d finis dans le fichier core om_debug inc php EXTRA_VERBOSE_ MODE mode tr s bavard affiche tous les messages VERBOSE MODE mode bavard affiche tous les messages d erreur ainsi que toutes les requ tes ex cut es DEBUG MODE mode debug affiche tous les messages d erreur PRODUCTION_MODE mode production il n y a pas de message Dans l applicatif on peut param trer le mode DEBUG gr ce au fichier dyn debug inc php suivant Il suffit de commenter d commenter l instruction define souhait e lt php Ce fichier contient le parametrage pour le mode debug package openmairie_exemple version SVN ld debug inc php 2198 2013 03 28 17 08 33Z fmichon Jx x defined PATH_OPENMAIRIE define PATH_OPENMAIRIE require once PATH_OPENMAIRIE om_debug inc php
102. ans le repertoire css et sont cascadables 3 1 Manuel de r f rence 109 openMairie Framework Documentation Version 4 5 main css feuille de style principale openMairie om theme om css suivant la feuille de style jquery voir EXTERNALS txt app css surcharge sp cifique a l application exemple le logo de l application 3 1 15 Abstraction du filestorage stockage des fichiers Avertissement Cette rubrique est en cours de r daction 3 1 15 1 Principe g n ral L objectif de cette rubrique est de g rer le stockage des fichiers dans les applications Ce stockage permet d avoir des stockages complexes Termes abstracteur classe d abstraction c est elle qui est instanci e et qui instancie les classes sp cialis es en fonction des crit res connecteur classe sp cialis e Description des fichiers permettant de g rer le filestorage D dyn F filestorage inc php g F om_filestorage class php F om_filestorage_deprecated class php F om_filestorage_filesystem class php F om_filestorage_filetransferprotocol class php F om_filestorage_alfresco class php ce fichier n existe pas il est l a titre d illustration de ce que le system st 3 1 15 2 Fonctionnement Description de l abstracteur core om_filestorage class php Ce fichier est compos de deux classes la classe d abstraction la cla
103. ans obj Ajouter om_table class php om_dbform class php et om_formulaire class php Evolution om_sig_point vers om_sig_map om_sig_map est le nouvel outil SIG d openMairie Ne concerne que PostgresSQL Executer le script data pgsql ver4 2 0 sql Reg n rer les 4 nouvelles tables Ajouter les scripts sp cifiques dans ob et sql pgsql 130 Chapitre 4 Historique amp Mises niveau CHAPITRE 5 Regles 5 1 Regles 5 1 1 Convention de codage La convention de codage openMairie s applique tout le code qui fait partie de la distribution officielle d open Mairie ainsi qu aux applicatifs de la gamme La convention de codage permet de conserver un code consistant et de le rendre lisible et maintenable facilement par les d veloppeurs openMairie 5 1 1 1 L indentation du code Pour am liorer la lisibilit il faut utiliser une indentation de 4 espaces et non pas des tabulations En effet les diteurs de texte interpr tent diff remment les tabulations alors que les espaces sont tous interpr t s de la m me fa on De plus lors de commit les historiques des gestionnaires de versions CVS ou SVN sont fauss s par ces caract res Il est recommand que la longueur des lignes ne d passe pas 75 85 caract res 5 1 1 2 Encodage des fichiers L encodage des fichiers doit tre UTF 8 5 1 1 3 Tags dans le code PHP Il faut utiliser toujours lt php gt pour d limiter du code PHP et non la version abr
104. apitre framework util notament sur la mise jour du registre 1 1 5 Cr er ses tats Il vous est propos de cr er un tat des courriers par service Il sera utilis dans ce chapitre l assistant tat et sous tat du g n rateur Quittez le projet openCimetiere et revenez openExemple 1 1 5 1 Cr er l tat service Nous allons utiliser l assistant tat du g n rateur dans le menu Administration gt G n rateur gt Assistants Choisir Cr ation d tat puis choisir dans le select l option service Ensuite avec la touche CTRL s lectionner les champs service service et service libell Cliquer ensuite sur Import service dans la base Administration G n rateur tat cet assistant vous permet de cr er des tats directement partir de vos tables H Choix table fichier service r choix des champs Utilisez ctrl key pour choix multiple service service Service libelle Import service dans la base openExemple Version 4 4 0 dev Documentation openMairie org Un message appara t service enregistr Vous avez cr un enregistrement qui a pour identifiant service dans la table om_etat SELECT FROM om etat LIMIT 50 E3 Modifier modifier om_etat om _collectivite id libelle actif E P 1 1 om_collectivite om_collectivite gen le 12 11 2010 t D 2 1 service service gen le 22 11 2013 f Vous devez rendre d abord votre tat service actif pour pouvoir y acc
105. aram tre method correspond la m thode appel e lors de la validation du formulaire button est le texte du bouton de validation permission_suffix est le suffixe du droit qui sera test lors de l affichage de l action condition permet de d finir une m thode qui sera appel e avant l affichage de l action dans le portlet si cette m thode retourne true l action sera affich e Si la cl portlet est d finie l action correspondante sera affich e sous condition la cl libelle est le texte affich sur le lien la classe d finie dans class sera ajout e celles du lien order permet de d finir l ordre la cl url peu tre utilis pour d finir une url sp cifique Les action de classes permettent de surcharger les actions ajouter modifier consulter et supprimer d finies dans core om_db_form class php D finition des actions dans form inc php obsol te Dans dyn config inc php lt php config activate_class_action 2 gt false La configuration des actions du menu contextuel des formulaires en consultation se fait via les scripts sql sgbd objet form inc php Dans ces scripts peuvent tre surcharg s la liste des champs ordre ou champs affich s requ tes sql permettant de remplir les widget de formulaires ainsi que les actions du menu contextuel L ajout d une action se pr sente de cette fa on lt php portlet_action
106. ation de g om trie dans un pannier et son enregistrement en multi g om tries Param trage de la carte Le param trage g n ral contenu dans scr tab_sig php des cartes est modifiable dans dyn var_sig inc xxx parametre de tab_sig php generer une cle pour le site http code google com intl fr apis maps signup html Scle_ google Sfichier_jsons json_points php obj Sfichier_wkt wkt_point php zoom par couche zoom standard permettant un passage de zoom a l autre zoom_osm_maj 18 Szoom_osm 14 Szoom_sat_maj 8 zoom_sat 4 zoom_ bing_maj 8 zoom_ bing 4 96 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 popup data contenuHTML Swidth_popup 200 Scadre_popup 1 Scouleurcadre_popup black fontsize_popup 12 couleurtitre_popup black Sweightitre_popup bold Sfond_popup yellow Sopacity_popup 0 7 image localisation maj ou consultation img_maj img punaise png Simg_maj_hover img punaise_hover png Simg_consult img punaise_point png Simg_consult_hover img punaise_point_hover png Simg_w 14 Simg_h 32 Simg_click 1 3 multiplication hauteur et largeur image cliquee xxx parametres d om_sig_map class php om_sig_wms class php Scontenu_etendue 0 array 4 5868 43 6518 4 6738 43 7018 4 701 43 3966 4 7636 43 4298 14 71417 43 64 4 72994 43 65166 14 72345 43 55348 4 7313
107. aux associatifs dans la variable Sact ions Chaque tableau associatif repr sente un lien lt php LA Sactions array L Sactions array title gt _ Link description gt _ Description href gt scr link php target gt _blank class gt action link right gt link 2 gt Description de chaque param tre du tableau associatif Param tre Requis Description title O Texte description N Texte qui s affiche au survol de l l ment href N Contenu du lien href target N Attribut pour ouvrir le lien dans une nouvelle fen tre class N Classe CSS qui s affiche sur l l ment right N Permission n cessaire l utilisateur pour visualiser l l ment Les raccourcis Le but de cette zone de navigation est de regrouper des liens vers des fonctions pr cises utilis es tr s souvent Elle se situe en haut droite de l cran juste au dessous des actions personnelles et est visible uniquement lorsque l utilisateur est authentifi admin LIBREVILLE Mot de passe L D connexion Tableau de bord Par d faut les raccourcis contiennent uniquement un lien vers le tableau de bord La configuration des liens se fait dans le fichier dyn shortlinks inc php Ce fichier de param trage n est pas obligatoire Si il n existe pas aucun lien n est affich Ce fichier de param trage doit contenir la d claration d
108. ble au lien suivant svn scm adullact net scmrepos svn opencimetiere trunk La base de donn es d openCimetiere est plus complexe Si les surcharges qui ont t faites dans notre exemple sont celles d openCourrier il y a d autre surcharges dans le script courrier class php d openCimetiere Les m thodes setLib setGroupe et setRegroupe permettent une pr sentation en fieldset du courrier utilisation des champs vide 1 a 5 voir sql pgsql courrier form inc Il y a d autres objets m tier qui ont des surcharges int ressantes par exemple l objet obj dossier class php o vous avez un upload pour t l charger des fichiers Vous pouvez regarder galement l application openCourrier mais attention la base de donn es qui est en MySQL openCourrier fonctionne avec des restrictions d acc s par service et les m thodes de login ont t modifi es dans obj utils class php ainsi qu utilisateur class php qui a dans openCourrier un champ service l objet obj tachenonsolde class php est un exemple de surcharge de tache class php qui affiche que les t ches non sold es 1 1 Tutoriel Cr er une application 17 openMairie Framework Documentation Version 4 5 vous pouvez aussi regarder deux scripts de traitement trt num_registre php qui remet O le num ro de registre trt archivage php qui tranfere en archive les courriers avant une date Vous avez galement des d tails sur les traitements dans le ch
109. bord gt Export Administration Utilisateur 1 ADMINISTRATEUR Param trage v Administration ad Collectivit Param tre Utilisateur 1 Z Modifier Gestion Des Utilisateurs nom Administrateur Profil email contact openmairie org H Supprimer Droit login admin T dition mot de passe Tableaux De Bord Profil ADMINISTRATEUR Widget Actions contextuelles Sig lt q Retour Om_sig_map Om_sig_wms Options Avancees openExemple Version 4 3 0 dev Documentation openMairie org Import G n rateur Ajout L ajout permet l ditions de donn es Lors de la validation un traitement sp cifique des donn es est effectu Si la cl primaire de la table est automatique alors elle est g n r e 68 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Modification L ouverture d un l ment en modification permet l ditions de donn es d j existantes lors de la validation du formulaire les donn es sont trait es v rifi es puis envoy es dans la base admin Ville d ARLES Mot de passe 4 D connexion Open MAIRIE Tableau de bord Export Administration Utilisateur 1 Param trage v Administration LARA Collectivit Param tre Utilisateur 1 Gestion Des Utilisateurs nom Administrateur Profil email contactGopenmairie org Droit login admin Utilisateur mot de passe ESS Tableaux De Bord Widget Prof ADMIN
110. borescence Voici l arborescence standard d un projet versionn sur un SVN trunk tags branches trunk la version en cours de d veloppement tags les diff rentes versions publi es Les dossiers dans tags sont des copies du dossier trunk a un instant pr cis Ils permettent de fixer une version pour la publier Il est interdit d effectuer une modification dans un de ces dossiers la bonne m thode tant de faire la modification dans le trunk et de faire une nouvelle version dans le dossier tags branches 6 1 1 3 Les r gles d or Ne jamais commiter dans un tag Ne jamais commiter sans message de commit Ne jamais tagger une version qui contient des externals vers un trunk 135 openMairie Framework Documentation Version 4 5 6 1 1 4 Les commandes basiques conna tre R cup rer une copie locale svn co svn ssh nom du d veloppeur scm adullact net openmairie openmairie exemple tfunk openmairie exemple Mettre jour sa copie locale svn up Voir l tat de sa copie locale svn st Voir la diff rence entre sa copie locale et le d p t svn diff svn ci 6 1 1 5 Externals C est une propri t sur le d p t SVN permettant d importer du code provenant d un d p t diff rent Le fichier EXTERNALS txt created by sv
111. celui utilis dans les versions d openMairie 4 2 0 et inf rieures Enfin s il n existe pas de seconde colonne la cl primaire de la table est utilis 2 1 4 5 Fonctionnalit s avanc es Ajouter une date de validit un mod le 2 1 4 5 1 1 Description Le g n rateur permet de cr er des objets qui seront consid r s comme valides seule ment pendant une p riode donn e Qu est ce qu un objet date de validit Un objet date de validit est un objet contenant deux champs sp cifiques om_validite debut d terminant la date de d but de validit om_validite fin d terminant la date de fin de validit Un objet valide se comporte comme un objet traditionnel Par contre lorsqu il arrive expiration l objet n appara t plus dans les tableaux les sous tableaux et les champs de s lection sauf s il est actuellement valeur de l un de ses champs Un tel objet est valide lorsque 2 1 Manuel d usage 33 openMairie Framework Documentation Version 4 5 sa date de d but de validit est nulle ET sa date de fin de validit est nulle OU sa date de fin de validit est strictement sup rieure la date actuelle OU sa date de d but de validit est inf rieure ou gale la date actuelle ET sa date de fin de validit est nulle OU sa date de fin de validit est strictement sup rieure la date actuelle A l inverse il est consid r comme non valide expir lorsqu
112. cer des tables remplissant la condition ci dessus Si l une de ces conditions n est pas satisfaite les interfaces de g n ration affichent une erreur Contraintes du syst me de fichiers Le g n rateur cr e les classes m tier de l application ainsi que les fichiers de surcharge Pour pouvoir cr er ces fichiers le serveur web PHP doit avoir les droits d criture dans les dossiers suivants gen obj gen sql pgsql gen sql mysql obj sql pgsql sql mysql Si des droits sont manquants les scripts genauto et gensup ne permettent pas de g n rer ces fichiers que le serveur ne peut pas crire le script genfull quant lui affiche des messages apr s la g n ration indiquants quels fichiers ne sont pas accessibles ces fichiers ne sont bien entendu pas g n r s 2 1 4 4 D finition des mod les de donn es Lidentifiant Chaque mod le de donn es doit avoir un champ destin contenir l identifiant des objets Sans ce champ il n est pas possible de cr er un mod le 2 1 4 4 1 1 D finition de l identifiant Il suffit d ajouter la contrainte SQL PRIMARY KEY une colonne d une table pour cr er un champ identifiant Il sera ensuite automatiquement g r par openMairie lors de l ajout la modification et la suppression d enregistrements 2 1 4 4 1 2 Fonctionnement interne du g n rateur Comment ce champ est d termin lors de la g n ra tion d un mod le Le g n
113. ces Permet de choisir par quel moyen sont r cup r es les cl s primaires et les cl s trang res constraints gt en interrogeant les contraintes de la base de donn es 38 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 postulate gt par les postulats le nom d un champ cl primaire a pour nom le nom de la table le nom d un champ cl trang re a pour nom le nom de la table vers laquelle elle fait r f rence et fait r f rence au champ cl primaire de cette table Default Skey_constraints_mode constraints Skey_constraints_mode postulate Liste des tables ne pas g n rer Permet de lister les tables dont la g n ration n est pas souhaitable Ces tables n apparaissent donc plus dans le menu de g n ration ni dans la g n ration compl te Default Stables_to_avoid array tables_to_avoid array om_version spatial_ref_sys Ce tableau de configuration permet de donner des informations de surcharges sur certains objets pour qu elles soient prises en compte par le g n rateur Stables_to_overload array lt table gt gt array d finition de la liste des classes qui surchargent la classe lt table gt pour que le g n rateur puisse g n rer ces surcharges et les inclure dans les tests de sous formulaire extended_class g
114. chiers existants ou non les options de g n ration 2 1 Manuel d usage 29 openMairie Framework Documentation Version 4 5 demo acem sur mysql A t pS Tableau de Dord table bdd om _collectmte dror om_etat om_lettretype om_profil om_sousetat om_utilisateur om parametre cla N cla atoms longueur enregistrement 92 champ om_parametre 11 int libelie 20 string valeur 50 string om_colectivte 11 rt soustormualre clesecandaire am_callactrata choix paramatrage standards generation formulaire M abienc om parametre inc php anys i parametre inc php existant tablene om_parametre mo J5 s parametre ine existant Z cable forminc om parametre forminc php f srametre forminc php existant 7 tableforminc om_paremetre formine Se fon _parametre form inc existant ametre class php obyom_parametre class php existant obi om_parametre class php Jabj om_parametre class php existant generation edition om_parametre pdf inc fsoVmysql em_parametre pdf inc non existant generation reqmo om_parametre reqmo inc Squrysquom_parametre reqmo nc existant om_parametre_om_collectivite regmo Inc Jsqumwysquom_parametre_om_collectivtte resmo Inc non existant generation divers Z al mysqlom_ parametre mport Inc fsqiimysql om_parametre import inc estant openExemple Version 4 0 0 dev Documentation openMairie org Analyse de la base Le programme propose une
115. classe om_collectivite unecran php s lectionnera l entr e d s lors que le script unecran php est appel quelque soit la classe ob3 Les actions personnelles Le but de cette zone de navigation est de regrouper des liens vers des fonctions qui concernent les informations de connexion de l utilisateur Elle se situe dans le coin en haut droite de l cran et est visible uniquement lorsque Putilisateur est authentifi Mot de passe 4 D connexion Tableau de bord 54 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Par d faut les actions personnelles sont compos es de quatre l ments le login de l utilisateur le libell de la collectivit un lien vers la page de modification du mot de passe un lien vers la page de d connexion du logiciel Le login de l utilisateur est r cup r par la m thode displayActionLogin de la classe om_application Cette m thode peut tre surcharg e dans la classe utils Le libell de la collectivit est r cup r par la m thode displayActionCollectivite de la classe om_application Cette m thode peut tre surcharg e dans la classe utils La configuration des liens se fait dans le fichier dyn actions inc php Ce fichier de param trage n est pas obligatoire Si il n existe pas aucun lien n est affich Ce fichier de param trage doit contenir la d claration d un tableau de table
116. colonne en UNIQUEMENT par rapport la hauteur du tableau Par exemple si le tableau fait une hauteur de 50 cm et que la hauteur de la colonne est de 25 la colonne fera 12 5 cm de hauteur Type de cellule Permet de d finir si c est une cellule normale ou une cellule qui va servir d en t te dans le tableau Valeurs possibles Cellule Cellule d en t te tendue Param tre sur quoi doivent s appliquer les param tres renseign s Valeurs possibles n a aucun Ligne Colonne Groupe de lignes Groupe de colonnes Alignement Permet de choisir le type d alignement du texte dans la cellule Valeurs possibles n a aucun Gauche Centr Droite Fusionner des cellules En s lectionnant les cellules fusionner et en cliquant sur Tableau Cellule Fusionner les cellules les cellules seront fusionn es Si aucune cellule n est s lectionn e un menu appara t Colonnes Nombre de colonnes qui vont tre fusionn es partir de la cellule dans laquelle le curseur est posi tionn Lignes Nombre de lignes qui vont tre fusionn es partir de la cellule dans laquelle le curseur est positionn Diviser les cellules Divise la cellule dans laquelle le curseur est positionn si elle avait t fusionn e avant Param trage des lignes Type de ligne Permlet de d finir le type de la ligne Valeurs possibles En t te Corps Pied Alignement P
117. comme suit Postgressol WHERE user is_admin varchar like true Il est possible de saisir n importe quelle cha ne de caract res dans Sargs 0 et pas seulement des valeurs bool ennes Attention Cette recherche n est pas sensible la casse Plusieurs fonctions de formatage sont appel es sur user is_admin avant de tester l galit 3 1 5 3 2 3 Tester si une donn e est pr sente ou non dans un groupe de donn es Exemple recherche des utilisateurs administrateurs Dans cet exemple l information se trouve non pas dans la table utilisateur mais dans la table administrateur disposant d une colonne user_id cl trang re Il nous faut utiliser une sous requ te pour r cup rer l ensemble des identifiants de la table administrateur afin de tester si un identifiant utilisateur est effectivement pr sent dans cette liste lt php soit user une table contenant pas la colonne is_admin soit admin une table contenant une colonne user_id args array Sargs 0 array true false Sargs 1 array _ Tous _ Administrateurs _ Utilisateurs simples Ssubquery SELECT user_id FROM admin Schamps administrator array colonne gt id table gt user libelle gt _ Administrateur 3 1 Manuel de r f rence 67 openMairie Framework Documentation Version 4 5 type gt select subtype gt man
118. de sous formulaire avec om_collectivite inc php sousformulaire array om_etat om_lettretype om_parametre om_sousetat om_utilisateur De Il est possible de surcharger les liens du tableau voir la configuration des actions 3 1 4 3 Les fonctionnalit s la recherche simple la recherche avanc e la pagination le tri les l ments archiv s Pexport PDF l export CSV les actions 3 1 4 4 Le composant openMairie tab php utilise les m thodes d om_table class php qui est une classe d openMairie core om_table class php Les m thodes de ce composant peuvent tre surcharg es dans obj om_table class php 62 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 3 1 5 La recherche avanc e 3 1 5 1 Les diff rents types de recherche Recherche simple Cette recherche est celle disponible par d faut sur les tableaux d openMairie Elle permet de rechercher une valeur dans une colonne parmi toutes celles affich es rechercher une valeur dans toutes les colonnes affich es rechercher des valeurs approximatives Note Il est possible de modifier la liste des colonnes dans laquelle est effectu e la recherche Cette liste ne correspond pas forc ment aux colonnes affich es Elle correspond seulement par d faut c est dire lorsqu aucune surcharge ne modifie les fichiers g n r s dans gen sql
119. difiable Selectdisabled Select non modifiable Textreadonly Text non modifiable Hidden champ cach Checkbox case a cocher oui non Upload chargement d un fichier voir voir un fichier t l charg Rvb choisir une couleur rvn avec la Palette de couleur voir framework formulaire Etats Seul l tat pdf est g n r par le g n rateur Dans le menu gen generateur les tats sont g n r s automatiquement avec un assistant Cet assistant vous permet de construire un tat en choisissant une table de la base 2 1 Manuel d usage 37 Sval openMairie Framework Documentation Version 4 5 en choisissant les champs mettre dans l tat L etat est enregistr dans la table om_etat et peut tre modifi menu gt administration gt etat De la m me mani re il est possible de cr er un sous etat Il est possible de choisir le champ qui sera la cl secondaire en lien avec la table m re Le sousetat est enregistr dans la table om_sousetat et peut tre modifi menu gt administration gt sousetat Le calcul de la largeur des colonnes est automatique dans les sous tats et l tat pdf Attention les champs blob ne sont pas pris en compte dans les ditions Requ tes m moris es Les requ tes param tr es sont cr es suivant le principe suivant une requ te globale une requ te avec un champ select pour chaque cl
120. directement dans le dossier trunk svn import lt NOM_DU_MODULE gt svn ssh lt NOM DU_DEVELOPPEUR gt scm adullact net svnroot lt 6 1 2 9 5 2 Cas 2 Dans le cas de figure o l application va tre migr e vers OM4 nous allons placer le code r cup r sur le CVS dans une branche du d p t correspondant sa version svn import lt NOM_DU_MODULE gt svn ssh lt NOM DU_DEVELOPPEUR gt scm adullact net svnroot lt Dans ce cas il faut donc importer le nouveau code dans le dossier trunk Soit le d veloppement du projet n a pas encore commenc et il suffit de suivre le tutorial ver sions svn Importer un nouveau projet Soit le d veloppement du projet a d j commenc et il suffit d importer le dossier en cours de d veloppe ment attention il ne faut pas que des dossiers svn soient pr sents dans ce dossier et il faut prendre soin de supprimer les dossiers r cup r s depuis les EXTERNALS avant l import svn import lt NOM_DU_DOSSIER gt svn ssh lt NOM DU_DEVELOPPEUR gt scm adullact net svn Il faut bien sur valider les EXTERNALS pour r cup rer les librairies externes 6 1 3 GIT Site officiel du projet GIT 6 1 Outils 143 OM_DU_PROJET OM_DU_PROJET root lt NOM_DU_ openMairie Framework Documentation Version 4 5 6 1 4 Meld Site officiel du projet Meld exemple d utilisat
121. durant jacques informatique De la m me mani re toujours dans le m me fichier vous pouvez changer les options de la zone de recherche en r affectant la variable champRecherche Actuellement on peut en plus de Tous faire une recherche sur courrier emetteur et service C est parce qu l orgine dans le fichier g n r champRecherche avait t affect e comme telle SchampRecherche array courrier courrier as _ courrier emetteur nom as _ emetteur service libelle as service Supprimez un ou plusieurs l ment s du tableau et il dispara tra de la zone de recherche Par exemple 1 1 Tutoriel Cr er une application 13 openMairie Framework Documentation Version 4 5 SchampRecherche array emetteur nom as _ emetteur donnera i Recherche Tous service registre telephonie 2013 3 informatique 2013 1 Nous souhaitons maintenant avoir les derniers courriers au d but de la page affich e Nous n avons pas besoin d aller r crire la requ te il existe une variable texte comprenant l instruction de tri R affectez cette variable tri dans votre courrier inc php de la mani re suivante Stri order by dateenvoi desc Le r sultat est le suivant dateenvol emetteur A 02 12 2010 durant 01 12 2010 dupont Pour en savoir plus sur ces variables voir framework affichage 1 1
122. e Modifier les cartes de om_sig_point R cup rer les donn es de l IGN Les bases suivantes sont fournies gratuitement aux collectivit s base topographique base parcellaire base adresse L application openReferentiel Vitrolles permet de cr er un r f rentiel local sur la collectivit Les donn es sont fournies par d partement Il faut r cup rer les fichiers shape dans une base IGN puis ensuite construire le r f rentiel de la commune avec openReferentiel Recup rer des donn es shape Il est propos un exemple de r cup ration de donn es parcelle Les donn es de l IGN sont fournies aux communes par d partement Ins rer le fichier parcelle dans la base exemple IGN shp2pgsql s 2154 I D W LATIN1 PARCELLE SHP psal ign Il est cr er dans la base ign une table parcelle d crite ci dessous 108 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 gid serial NOT NULL numero character varying 4 feuille smallint section character varying 2 code_dep character varying 2 nom_com character varying 45 code_com character varying 3 com_abs character varying 3 code_arr character varying 3 the_geom geometry ainsi qu un enregistrement parcelle dans g ometry_columns postgis est obligatoire dans la base et un index Selectionner les parcelles de la commune concern e et inserer les dans u
123. e il n est pas valide Est il possible de consulter la liste des objets expir s d un mod le donn Oui Le tableau du mod le dispose d un bouton Afficher les l ments expir s permettant d afficher en plus des objets valides les objets expir s Lorsque les l ments expir s sont affich s bouton devient Masquer les l ments expir s 2 1 4 5 1 2 D finition des dates de validit Pour que le g n rateur consid re un mod le comme date de validit il faut que sa table de base de donn es contienne les deux colonnes suivantes om_validite_ debut DATE om_validite fin DATE Important Il ne faut surtout pas d finir de contrainte NULL ou DEFAULT sur ces deux colonnes sinon ces champs seront obligatoires chaque validation de formulaire 2 1 4 5 1 3 Affichage dans les formulaires Ces champs apparaissent dans les formulaires sous la forme de datepicker comme des champs de type date classiques 2 1 4 6 L analyse de la base Les informations de la base sont analys es par la m thode constructeur de gen class php La construction des formulaires se fait suivant 5 types de champs reconnus par le g n rateur string cha ne de caract re int nombre entier ou d cimal date blob texte geom geometry pour postgres Type de champs la champ String est du type openMairie m thode setType text dans le cas g n ral
124. e sql pgsgl service form inc php Aucun changement de gen obj service class php Aucun changement de obj service class php gt affichage colone ok 9 0322580645161 gt 2 5 Aucun changement de sql pgsql service pdf inc php Aucun changement de sql pgsql service regmo inc php Aucun changement de sql pgsql service import inc php 8 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 1 1 2 4 Int grer les formulaires dans le menu Pour acc der nos formulaires nous allons les int grer dans le menu voir framework parametrage menu gauche Nous allons appeller le formulaire depuis le menu option Application gt tab php obj courrier option Param trage gt tab php obj emetteur option Param trage gt tab php obj service Il faut ouvrir avec un diteur le fichier dyn menu inc php et ins rer le code suivant Rubrique APPLICATION Slinks array href gt scr tab php obj courrier class gt courrier title gt _ courrier right gt courrier Rubrique PARAMETRAGE Slinks array href gt scr tab php obj emetteur class gt emetteur title gt _ emetteur right gt emetteur Slinks array href gt scr tab php obj service class gt service title gt _ service right gt service Il faut ga
125. e la table emetteur application emetteur emetteur 1 0 enregistrement s sur O Tous Recherche emetteur 2 nom D gt prenom D Aucun enregistrement openExemple Version 4 4 0 dev Documentation openMairie org En appuyant sur on acc de la saisie L onglet courrier est inactif tant que l emetteur n est pas saisi et valid 10 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 application emetteur emetteur a Retour nom prenom Ajouter l enregistrement de la table emetteur a Retour openExemple Version 4 4 0 dev Documentation openMairie org Param trage gt Service Cette op ration affiche la table service application service service 1 0 enregistrement s sur O Tous service 2 gt libell O Aucun enregistrement openExemple Version 4 4 0 dev Documentation openMairie org En appuyant sur on acc de la saisie TL onglet courrier est inactif tant que le service n est pas saisi application service service a Retour libell Ajouter l enregistrement de la table service a Retour openExemple Version 4 4 0 dev Documentation openMairie org Vous pouvez acc der aux ditions et requ tes m moris es Export gt Edition Cet option affiche l ensemble des ditions pdf Export dition Cette page vous permet de visualiser les ditions disponibles dans l application
126. e table e 4 Lu sus do de 8 36 2 1 4 7 1 2 Param tres de type Form 36 2 1 47 2 Objets MENET lt lt ula Le ae op de ons hu de cle e ere 046 e 9 04 36 DAATIS Etats esera e MG AM E OS me dust VEM es 37 241474 R qu tes M MOS ES coro ne hu doit dent 47 ar eda Ad 38 ZLATI IMpOrts oe sencera 6 BA sa han di be 38 2 1 4 7 6 Mots clefs Robot Framework 38 2 148 Param trage g n rateuf bois sua dus dima dieu ut 38 21481 gen dyn gen Imne php ess asme x de na da see La va 38 21482 dgen dyn tab inc phb 2 44 rak eee eue a 8016 4 40 2 14 83 gen dyn form inc php esoo vu d s se E A 40 2 1 4 84 gen dyn permissions inc php 41 21485 Gen dyn pdt 1nCPHD checar 41 21486 den dyn etat inc Php srca re a pecha Eee ma 42 21487 dgen dyn sous tat inc php s cnie cape dn R E 484 42 A a A RN 43 2 1 6 Pourall r plus LO sorag ece a E a Dee ten 43 3 Manuel de r f rence 45 3 17 Manuelider l rence ori se Lea dispos du A demi de MR 6 sd nos dd 45 3 1 1 ATbOresCeNCe 5 44 us de a Spin 2 Be de dn mon dose ae a an l 0 40 i de 45 3 1 1 1 Les r pertoires sp cifiques l applicatif 46 ST Aata os e A RE AR URL RD SR DD E 46 EE TE AE e a aris ee darda bo d 1 art 24 46 SES CANAS iii ARS EM a A DE a 24 46 EN E E AE ER ANA NN Re RTE Ne eat 46 FAS Locales L EAU IA AAA 16 Ler 47 SLLT O GBI iia rr a RA A o OR a ERA 47 SAIT E
127. e tableau premier num ro de la premi re ligne affich e dans le tableau recherche cha ne de caract res recherch e depuis le modules de recherche selectioncol num ro de la colonne s lectionn e dans le module de recherche tricol num ro de colonne et orientation du tri du tableau valide true false affiche ou non les enregistrements non valide L appel scr soustab php est fait en javascript depuis un formulaire afin d afficher les informations li es l enre gistrement en cours d dition 3 1 Manuel de r f rence 61 openMairie Framework Documentation Version 4 5 3 1 4 2 La requ te SQL d affichage Elle se trouve dans sq DBTYPE objet inc php Les param tres sont les suivants pour om_parametre inc php lt php Nombre d enregistrements par page Sserie 15 Icone affich XXX voir deprecated ico img ico application png Titre du tableau Sent _ option gt _ om parametre Table de r f rence il peut y avoir une ou plusieurs jointure Stable DB_PREFIXE om parametre Liste des champs du tableau SchampAffiche array om parametre libelle valeur om_collectivite Champs pour la recherche SchampRecherche array libelle valeur Crit re de tri par d faut Stri dition PDF Sedition om parametre sous formulaire s associ s Ssousformulaire array autre exemple
128. ea A male Re aie AA 92 3141152 Par metro 2 02 sns na e RS ie A e LS 93 3 1 11 2 1 Le script de param trage sql pgsql lt OBJ gt import inc php 93 21 11 53 Composants aren dr se ean RETIRE e ER is D PERRIER 94 3 112 Module Reqmo p a 5 540 e deu La et nes 0800 B a en o 94 SAD Phineipe 2 2 r Le ame is ah A Ms nine ee ERNE 94 3 1 122 Param trage 2 2 a a a ie eut aaa lt a E 94 3 1 12 2 1 Le script de param trage sql pgsql lt OBJ gt reqmo inc php 94 3 1 1123 Composants se e 54 be ie aussi RASE mb Bu phrases 95 3 1 15 Module G olocalisation s u seri ce e du du du nus nine Een 95 ASUS Principe re LD ARE SUR Ne PUDEUR A RTE GB a h 95 3 1 13 1 1 G o localisation automatiqUe s s e so ceee le a a us 4 96 3 1 13 1 2 Affichage de carte iodo di Lund Du A 96 3 1 13 1 3 Param trage de la carte 2 44 ds 080 he de Vn 96 NAIZ ODI t MAP 5 4424 heal E num ce RUN Hat Ed 97 aa afficher les layers rara e eaa 1 ee ID AE UE vue 97 3 113 341 Les tonds 5 c redace e ari ha us 99 19 32 Les data ciao e Tera 99 3 111933 L s Nux WNS ir e a A e 16 t s 99 31 13 34 Lanotion de paner ose onte o AA 101 3 1 13 3 5 La g om trie modifier couche vectors 102 3 1 13 3 6 Les g om tries compl mentaires 103 3 1 13 4 installation d om_sig map 103 3 1 13 4 1 optimisation composant openLayers
129. emetteur choisir la cl de s lection courrier service Import courrier dans la base openExemple Version 4 4 0 dev Documentation openMairie org En cliquant sur Import courrier dans la base vous cr ez un enregistrement ayant pour identifiant courrier service dans la table om_sousetat SELECT FROM om sousetat LIMIT 50 E3 Modifier modifier com_sousetat om _collectivite id libelle actif P 1 1 om_parametre om_collectivite gen le 12 11 2010 t P 2 1 courrier service gen le 22 11 2013 f 1 1 5 3 Associer le sous tat courrier l tat service Vous devez rendre d abord votre sous tat courrier service actif pour pouvoir l associer Allez dans l option Sous Etat du menu Param trage 1 1 Tutoriel Cr er une application 19 openMairie Framework Documentation Version 4 5 Recherchez le sous tat courrier service et modifiez le en cochant actif premier fieldset collectivit Il vous faut maintenant associer le sous tat courrier service l tat service Allez dans l option Etat du menu Param trage Modifiez l tat service et dans le fieldset d plier Sous tat s apr s l avoir coch actif s lectionnez le sous tat courrier service EJ Sous tat s Choisir sous tat om_parametre om_collectivite gen le 12 11 2010 ourrier service gen le 22 11 2013 sous tat se_font helvetica se_margeleft 8 se_margetop 5 se_margeright 5 se_couleurt
130. erche lib gt lt span class om icon om icon 16 om icon fix delete 16 title rights gt array list gt array 50b S obj _supprimer operator gt ordre gt 30 gt 4 1 Historique amp Mises niveau 127 recherchel 1 Supprimer OR openMairie Framework Documentation Version 4 5 4 1 3 2 3 5 Les actions personnalis es Red finir les actions avec la nouvelle mani re Les actions personnalis es doivent tre d fini selon la nouvelle mani re Exemple lt php tab_actions left edition array lien gt pdf pdfetat php obj om_collectivite amp amp idx id gt ae Lib gt lt span class om icon om icon 16 om icon fix pdf 16 title _ Edition gt _ E ajax gt false ordre gt 21 2 gt 4 1 3 2 3 6 D finition de l action La premi re cl de tab_actions permet choisir la position d affichage corner pour les actions en coin left pour les actions de gauche La seconde cl de Stab_actions permet de d finir la nouvelle action Cette cl doit tre diff rente de ajouter consulter modifier et supprimer Les cl s lien id et lib s utilise de la m me mani re qu avant 4 1 3 2 3 7 D finition du mode d affichage en sous tableau La cl ajax permet d indiquer si l action doit tre affich e en ajax ou non dans les sous tableaux true l action utilisera la fonction ajaxIt
131. erer les tables avec genfull php Modifier les param tres dym s 4 444 rss aca ai in 84 Da s Gb ss des e b das boin a a o db Da Evolution om_sig_point vers om_sig Map 123 123 123 123 123 123 123 123 123 123 124 124 124 124 124 124 124 124 124 125 125 125 125 125 125 126 126 126 126 126 126 126 127 127 128 128 128 128 128 129 129 129 129 129 129 130 130 130 131 vii dl 5 1 3 5 1 4 6 Outils 6 1 Outils 6 1 1 6 1 2 6 1 3 6 1 4 6 1 5 6 1 6 6 1 7 E VA ae e D A er EE a e A E a a A aaa 0 G 131 Convention de codage sp 4 r ch nb a a ae Jh sl 06 8 a ri 131 5 1 1 1 L indentation du Cod lt 2er e AB d a d Vin ab SU ia cal i e 131 9 112 Encodage des fichiers y o roere aa 4 Baume sh CRE Vadba R AE E J 131 las Taesdanslecode PHPH cars Tiya er a EA E aA g 131 SA HTML Vahdet W3C lt 2 a dador bo dA Tan Ars b a 131 Mo Les commentarres dansleicode o 5 5 14 su ra 3 e N 6 e a Cr e E 131 JG mara aria A a Ne RS 132 VOFSIONNADE o e e e E a e Ne 0 De E e 132 5 1 2 1 Convention de num rotation des versions 132 Documentation sc s ec eae Len e dE ae p J dec tar mais dur B E 132 PUDICALION o 5 4 o me ea ri Rue ane eat ms E men 132 SHAN Ladoc ment ti n lt 44H23 Lure distri sem E aie Res Es 132 135 PR Der STOMIES LE CNT OMR UMTS A 135 Apache Subversion SVN we s s su same rs Fraude er RSS
132. ermet de choisir le type d alignement du texte dans la ligne Valeurs possibles n a aucun Gauche Centr Droite Hauteur Ce champ sert indiquer la hauteur de la ligne en UNIQUEMENT par rapport la hauteur du tableau Par exemple si le tableau fait une hauteur de 50 cm et que la hauteur de la ligne est de 25 la ligne fera 12 5 cm de hauteur Ins rer une ligne Permet d ins rer une ligne avant ou apr s la ligne sur laquelle le curseur est positionn 2 1 Manuel d usage 27 openMairie Framework Documentation Version 4 5 Effacer une ligne Supprimer la ligne sur laquelle le curseur est positionn Couper une ligne Coupe la ligne sur laquelle le curseur est positionn Copier une ligne Copie la ligne sur laquelle le curseur est positionn Coller une ligne Colle la ligne qui avait t copi e coup e avant ou apr s la ligne sur laquelle le curseur est positionn Ins rer une colonne Ins re une colonne avant ou apr s la colonne sur laquelle le curseur est positionn Effacer une colonne Supprime la colonne sur laquelle le curseur est positionn 2 1 3 2 1 10 Gestion des code barres Saisir le champ de fusion S lectionner le champ de fusion Cliquer sur le bouton de g n ration du code barres puis valider le formulaire pour enregistrer les changements 2 1 3 2 1 11 Gestion des sauts de page 2 1 3 2 1 12 Gestion du mode plein cran 2 1 3 2 1 13 Ins
133. ertion de sous tats Sous tats Requ tes Logos 2 1 3 3 La g olocalisation Ce document a pour objet de d crire le module sig interne d openMairie dans la version om 4 4 5 Dans sa version 4 4 5 int gration des formulaires dans le sig interne integration des r sultats du moteur de recherche dans les cartes cas utilisation moteur de recherche int gration dans les cartes d un r sultat dans reqmo cas d utilisation reqmo acc s multiples aux objets acc s des objets multi g om trie Dans un premier temps il sera d crit l ergonomie du sig interne Dans une deuxi me partie nous aborderons le param trage du sig interne Enfin dans une troisi me partie nous aborderons les l ments de d veloppement 2 1 4 G n ration Pr cision sur le vocabulaire utilis dans cette documentation Mod le de donn es En informatique un mod le de donn es est un mod le qui d crit de fa on abstraite comment sont repr sent es les donn es dans une organisation m tier un syst me d information ou une base de donn es 28 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 Cf Wikip dia Article Modele de donn es Dans la documentation suivante le terme mod le de donn es est utilis pour d signer les classes m tier d open Mairie ainsi que les formulaires qu elles repr sentent Objet Le mot objet fait r f rence aux instances des cla
134. ertissement Cette rubrique est en cours de r daction Le framework openMairie permet d effectuer des ditions au format PDF Ce module est compos de trois l ments fonctionnels les tats et lettres types les listings les tiquettes 3 1 10 1 Les tats et lettres types C est la fonctionnalit la plus volu e du module dition elle permet l utilisateur final de composer directe ment depuis l interface du logiciel des ditions complexes au format PDF comme des factures des courriers des proc s verbaux Il est possible d ins rer dans ces ditions un logo des sous tats des champs de fusion Param trer des tats Il est conseill d utiliser l assistant tat du g n rateur Les param tres sont les suivants orientation portrait ou paysage format A4 A3 position et nom du logo titre de 1 tat position et caract ristiques du titre corps de 1 tat position et caract ristiques du corps 88 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 la requ te SOL les sous tats associ s et les caract ristiques Pour le corps et le titre les zones entre crochets exemple nom sont les champs de fusion s lectionn s par la requ te SQL Ces champs de fusion peuvent tre mis en majucule ou en minuscule selon les besoins gr ce aux balises lt MAJ gt lt MAJ gt et lt min gt lt min gt
135. ervice VALUES nextval courrier_seq 2010 12 01 Proposition de fourniture de service 1 1 nextval courrier_seq 2010 12 02 Envoi de devis pour formation openMairie 2 1 1 1 3 1 Faire un affichage courrier plus convivial L affichage des courriers se fait avec des libell s g n r s automatiquement Ainsi dans le fichier gen sql pgsql courrier inc php qui est inclus dans le fichier sql pgsql courrier inc php que vous pourrez modifier vous avez la variable champAffiche Vu que ce fichier a t cr par le g n rateur et est en lecture seule et vu que nous souhaitons modifier la variable pour par exemple avoir le nom et le pr nom de l emetteur au lieu de simplement son nom il nous faut ouvrir le fichier sgl pgsql courrierinc php o nous allons apr s l include r affecter la variable champAffiche la valeur suivante SchampAffiche array courrier courrier as _ courrier to_char courrier dateenvoi 1 DD MM YYYYX as _ dateenvoi concat emetteur nom X emetteur prenom as _ emetteur service libelle as _ service Il est possible que l op ration vous soit refus e seul www data ayant les droits d criture Si tel est le cas ch ant il faudra se rajouter les permissions Le r sultat est le suivant Courrier Dateenvoi Emetteur Service 1 01 12 2010 dupont pierre informatique 2 02 12 2010
136. es 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 for mulaires 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 open Mairie 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 distributio
137. eur propre collectivit 3 1 8 5 Les login et logout Le login se fait par le script scr login php login php valorise les variables sessions permettant la gestion des acc s et s curit s lt php _SESSION profil profil S_SESSION nom nom _SESSION login login 2 gt La d connexion se fait avec le script scr logout php Le changement de mot de passe se fait avec le script scr password php L acc s au changement de mot de passe se fait par d faut dans le menu haut voir framework param trage 3 1 8 6 Les utilitaires La gestion des droits d acc s se fait dans les m thodes des utilitaires php openmairie om_application class php composant openMairie obj utils class php voir framework utilitaire 3 1 9 Module Tableau de bord Avertissement Cette rubrique est en cours de r daction 3 1 9 1 principe Il est propos dans ce chapitre de d crire le tableau de bord param trable pour les utilisateurs 82 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 param trage l acc s au tableau de bord param trable dyn dashboard inc php voir framework param trage Par d faut le tableau de bord param trable est activ il peut tre d connect en enlevant le commentaire die les widgets Les widgets sont des liens et ou de petits scripts param trables qui peuvent tre rajout s dans le tableau de bord Ces scripts s
138. exte 000000 l Vous avez d sormais un tat des courriers par service Param trage gt Service gt Edition PDF application service service 1 2 enregistrement s sur 2 Tous Recherche service D gt libell O E 1 informatique y 3 2 telephonie openExemple Version 4 4 0 dev Documentation openMairie org nMairie le 22 11 2013 1 informatique liste courrier DATEENVOI OBJETCOURRIER EMETTEUR REGISTRE Proposition de fournitures de voi de devis pour 2013 11 21 formation openMairie 1 2152 20 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 1 1 5 4 Mettre le nom et le pr nom de l emetteur dans le sous tat Nous souhaitons mettre le nom et le pr nom de l emetteur la place de la cl secondaire Vous devez modifier la requ te sql du sous tat courrier service dans la table om_sousetat de la mani re suivante select courrier dateenvoi as dateenvoi courrier objetcourrier as objetcourrier concat emetteur nom emetteur prenom as emetteur courrier registre as registr from amp DB_PREFIXEcourrier LEFT JOIN 6 DB_PREFIXEemetteur on emetteur emetteur courrier emetteur where courrier service 8idx Votre nouvel tat a la forme suivante enMalilrie le 22 11 2013 1 informatique liste courrier DATEENVOI o OBJETCOURRIER EMETTEUR REGISTRE voi de devis pour z
139. fichier mulaire voir2 fait appel spg voir php pour visualiser un fichier depuis un sous formulaire mulaire localisation fait appel spg localisation php mulaire localisation2 fait appel spg localisation php mulaire rvb fait appel spg rvb php pour affichage de la palette couleur mulaire rvb2 fait appel spg rvb php pour affichage de la palette couleur for mulaire geom ouvre une fen tre tab_sig php pour visualiser ou saisir une g om trie selon l action la carte est d finie en setSelect Les widgets comboG comboD date upload voir et localisation sont mettre dans les formulaires Les contr le comboG2 comboD date2 upload2 voir et localisation sont mettre dans les sous formulaires Les widgets font appel des scripts d aide la saisie stock s dans le r pertoire spg ils sont appel s par js script js Ce script peut tre surcharg dans app js script js 3 1 Manue I de r f rence 75 openMairie Framework Documentation Version 4 5 spg combo php Ce programme est appel par le champ comboD comboG comboD2 comboG le param trage se fait dans les fichiers dyn comboparametre inc php dyn comboretour inc php dyn comboaffichage inc php spg localisation php et js localisation js ce programme est li e au champ formulaire localisation spg voir php Ce script est associ au champ upload Ce sous programme permet de visualiser
140. fichier de rejet reprenant les enregistrements csv rejet s ce fichier contient les enregistrements en erreur et permet de relancer 1 traitement apr s correction manuelle Sfic_rejet 1 fichier de rejet pour relance traitement 0 pas de fichier rejet La premi re ligne affiche le nom des champs lignel 1 la premi re ligne contient les noms de champs 0 sinon Les zones obligatoires tableau Sobligatoire Sobligatoire nom 1 obligatoire 1 Sobligatoire login 1 obligatoire 1 les tests d existence d une cl secondaire Sexit profil 1 gt O non 1 oui sql_exist profil s lect profil froc profil cherre profil La liste des champs ins rer il faut mettr n commentaire les zones non trait es Szone nom 0 gt la l re zone contient le nom zone login 1 gt la 2 me zone contient le login zone pwd 2 gt la 3 me zone contient le mot de passe crypt zone profil 3 gt la 4 me zone contient le profil La valeur par d faut 3 1 Manuel de r f rence 93 openMairie Framework Documentation Version 4 5 En effet si zone profil on peut d finir un profil par d faut Sdefaut profil 5 Le profil par d faut sera 5 3 1 11 3 Composants Les scripts du framework qui g rent le module Import sont core om_import class php scr import php 3 1 12 Module Reqmo Avertissement Cette
141. frame lt iframe width 200 height 150 src http www youtube com embed gS5B4LlgkfI frameborder 0 allowfullscreen gt lt iframe gt La meteo grace un javascript du site tameteo com lt div id cont_f50895722555454d1872b91f52beafd4 gt lt h2 id h_f50895722555454d1872b91f52beafd4 gt lt a href http www tameteo com title M t o gt M t o lt a gt lt h2 gt lt a id a_f5089 b722555454d1872b91f52beafd4 href http www tameteo com meteo_Arles Europe France Bouches du Rhone 1 25772 html target _blank title M t o Arles style color 666666 font family 1 font size 14px gt lt a gt lt script type text javascript src http www tameteo com wid_loader f5089b722555454d1872b91f52beafd4 gt lt script gt lt div gt Horoscope au travers d un iframe qui pointe sr astroo com 84 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 lt DEBUT CODE ASTROO gt lt debut code perso gt lt iframe width 232 height 302 marginheight 0 marginwidth 0 frameborder 0 align center src http www astroo com horoscope htm name astroo allowtransparency true gt lt fin code perso gt lt a href http www astroo com horoscope php target _top title Cliquez ici pour afficher 1 horoscope quotidien gt lt font face Verdana size 2 gt lt b gt afficher l horoscope du jour lt b gt
142. g version_2_03 commence par une lettre pas de point faire l export cvs export r version_2_03 d version opencimetiere_ facture 2 03 openmairie_ version repertoire export module 6 1 2 5 tag Les identifiants logiques noms donn s une version par un utilisateur sont diff rents des identifiants CVS du type 1 1 2 1 La gestion d identifiant ou tag d une arborescence se fait ainsi lcimetiere_fac cd lt r pertoire d sir gt cvs tag R d r lt nom de l identifiant gt lt arborescence gt cvs tag tag_ name creer un tag R commande appliqu e r cursivement sur les sous r pertoires d r suppression de l identifiant existant Exportation m mes options que cvs check out Pour exporter les sources du projet en vue d une livraison pas de r pertoires CVS dans l arborescence cd lt r pertoire d sir gt cvs export r lt nom du tag gt D lt date d sir e gt lt arborescence gt cvs export Les fichiers cvsignore sont export s et apparaissent dans l arborescence contrairement aux r pertoires CVS Des probl mes apparaissent lors d export de fichiers binaires sur plateformes h t rog nes Par exemple un export sur PC transforme les retours chariots n gt r n 6 1 Outils 141 openMairie Framework Documentation Version 4 5 6 1 2 6 Import requete cvs cvs d
143. gt Int Doubleprecision 8 Float8 gt Int Numeric 20 Numeric gt Int Money 8 Money gt Int Char 1 Char gt String Quelque soit la longueur 1 Character 1 Bpchar gt String Utilisation de la longueur d affichage Character varying 1 Varchar gt String Utilisation de la longueur d affichage Text L text gt blob Utilisation des param tres de form inc Date 4 Date gt Date Utilisation des param tres de form inc Spgsql_longueur_date geometry 5 gt geom boleen bolean gt checkbox Pour postgresql il est propos dans form inc 2 variables qui sont avec la version 4 2 0 inutiles car les sont g r es par le g n rateur valeurs n gatives longueurs Spgsql_taille_defaut 20 Spgsql_taille_minimum 10 taille minimum d affichage d un champ taille du champ par d faut si retour pg_field prtlen Attention pour les champs geom il faut g rer la carte chercher pour l affichage de la carte en fen tre exemple de surcharge de la m thode setSelect pour afficher la carte dossier if maj 1 modification contenu array Scontenu 0 array dossier this gt getParameter idx Sform gt setSelect geom contenu de la t Nom de champ et nom de table Attention au nom de tables ou de champs vitez les termes SQL match table index type len ou openMairie objet pour les noms de champs ou table 2 1 4 7 Les fic
144. gt phptype courrier_scr inc lancement de la requete sql_courrier et test erreur Sres f gt db gt query sql_courrier Sf gt isDatabaseError res Pour parcourir les enregistrements vous utilisez les m thodes dbpear suivantes du debut la fin de la requ te whil row amp S res gt fetchRow DB_FETCHMODE_ASSOC j affiche le champ courrier echo S row courrier Pour ecrire dans la base vous pouvez utiliser les m thodes insert ou update mais vous pouvez utilisez la m thode autoexecute sp cifique db pear requ te sql Ssql INSERT INTO Sres2 f gt db gt query sql f gt isDatabaseError res2 ou avec un tableau valF obj table valF obj f gt db gt nextId DB_PREFIXE Sob3 resl f gt db gt autoExecute DB_PREFIXE S obj valF DB_AUTOQUERY_INSERT Sf gt isDatabaseError resl 118 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Vous pouvez faire une Description du role de la page de la mani re suivante Sdescription _ Cette page vous permet de Sf gt displayDescription description Un message d erreur s affiche suivant class qui est la classe css qui s affiche sur l element et qui peut tre error pour le message erreur valid
145. hiddenstatic si modification pour cl primaire select pour cl secondaire Le champ date est du type openMairie date avec calendrier et java script de contr le de saisie de date La date est au format fran ais JJ MM AAAA le champ Int est du type openMairie methode setType hidden si cl primaire en ajout hiddenstatic si cl primaire en modification text avec contr le num rique en javascript select pour cl secondaire Le champ Blob est du type openMairie textarea La longueur et la largeur sont d finis en fichier de param trage form inc La taille n est pas pris en compte dans la longueur d enregistrement Les param tres de dyn form inc permettent d tablir la longueur et la largeur d affichage d un blob 34 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 nombre de ligne blob taille du blob max 6 taille 80 Les champs de type geometry sont des champs geom acc s a la fenetre tab_sig php Equivalence type pgsql type openMairie L information fournie par postgresql est moins compl te que celle de mysql surtout au niveau de la longueur des champs string o 1l est fourni la longueur de stockage qui est gal 1 quand le stockage est variable type pgsql longueur type tableinfo si different gt type openMairie Bigint 8 int8 gt int Smallint 2 Int2 gt Int Integer 4 Int4 gt Int Real 4 Float4
146. hiers g n r s Les fichiers g n r s concernent les formulaires les requ tes m moris es le script d import de donn es 2 1 Manuel d usage 35 able om_sig_m openMairie Framework Documentation Version 4 5 Formulaires Les formulaires sont g n r s suivant le nom de la table dans le r pertoire sql sous repertoire portant le nom de la base pour r gler le probl me de compatibilit SQL concat nation extraction Deux types de formulaire sont g n r s type table type form 2 1 4 7 1 1 Param tres de type table gen sql basededonnees nom_table inc sql basededonnees nom_table inc Par d faut tri en affichage vide champ de recherche avec les champs string pas d affichage de champ blog rattachement de sous formulaire affichage de l dition de la table Dans le fichier param tres form inc serie nombre d enregistrement par page ico ic ne par defaut 2 1 4 7 1 2 Param tres de type Form gen sql basededonnees nom_table form inc sql basededonnees nom_table form inc Dans le fichier param tres form inc ico ic ne par defaut Par d faut tous les champs sont affich s les uns en dessous des autres Objets m tier L objet m tier g n r est stock en gen obj nom_table class php Ce script ne doit pas tre modifi car il est reconstitu chaque g n ration Cela permet de pouvoir modifier la base de donn es ajout
147. i NAS astext gamn as geam parcelle as titra dose damandaur_nom as dascdmian dosslar as idx fram ADS_PREFIKE danser omar ny gaam dossier requ te sul me mee FT Entro pare a gt a doses Feux TS ee Moder fecrogsremert dla ml Om sig magi 4 Retour Il est possible de copier une carte et de param trer les champs suivants id identifiant unique obligatoire libelle fonds a afficher et data osm bing sat google tendue et epsg voir sig var_sig_point inc url qui pointe sur la fiche ou le formulaire de saisie requete sql qui affiche les donn es json et qui doit d sign le titre la description 1 idx la mise a jour si oui le champ g ometrique et la table maj le type de g ometrie et le nom de la couche openLayers version 4 2 0 le retour de la carte Dans tab_sig php il y a 3 types de layers 98 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 les fonds de cartes existants sur internet base layers les donn es issus de postgresql overlays les donn es wms overlay Les fonds Il est propos les fonds suivants osm openstreetmap sat satelite google bing satellite microsoft Les datas Information de la carte layer_info Cette couche fait appel sig_json php Il est possible de faire appel a un autre script voir dyn var_sig inc La requ te pgsql est param tr e dans la table om_sig_map et doit d
148. ibles salfilter possibilit de filtre du flux wms attribut FILTER compl ter la zone avec une requ te SQL qui va g n r le filtre syntaxe suivant le serveur WMS 100 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 exemple d un filtre pour produire le filtre suivant layer1 champl valeurl layer2 champ2 valeur2 il faut entrer la requ te suivante pour selectionner les electeurs d un bureau select electeur bureau bureau bureau as buffer from amp DB_PREFIXEbureau where bureau select electeur bureau sidx as buffer from DB_PREFIXEbureau where bureau idx 2 caract re utilis pour les doubles quotes concatenation sql permet d echapper la simple quote sql remplace les deux quotes par une quote caractere quote le filtre final appliqu au flux wms est electeur bureau 04 pour le bureau 04 base_layers possibilit d utiliser le flux wms comme base layers au m me niveau qu OSM single_tile ram ne le flux wms en une seule image pour la fen tre et non en imagette permet de corriger les labels tronqu s Attention les temps de r ponses peuvent s allonger car il n y a pas de cache La notion de pannier Le pannier permet de pouvoir stocker des g om tries au travers de flux wms mais attention la g om trie est r cup r e dans une table ou une v
149. int8 automatique nom var30 proifil int2 login var30 libelle profil var30 pwd var100 profil int2 ajouter modifier supprimer formulaire droit var30 profil int2 3 1 Manuel de r f rence 81 openMairie Framework Documentation Version 4 5 3 1 8 3 Les r gles Le droit sur un objet porte le nom de l objet pour chaque objet il existe deux types de droits g n raux il n est compos que du nom de l objet et permet d acc der toutes les actions sur celui ci sp cifique il se compose du nom de l objet puis d un suffixe D tails des suffixes de droits _tab permet d acc der au tableau _ajouter permet d ajouter un objet _modifier permet de modifier l objet _supprimer permet de supprimer l objet _consulter permet de consulter l objet 3 1 8 4 La multi collectivit Les collectivit s peuvent tre de niveau 1 ou de niveau 2 Les utilisateurs de chaque collectivit h ritent de ce niveau Les utilisateurs de niveau 1 n ont acc s qu leur collectivit tandis que les utilisateurs de niveau 2 ont acc s toutes les collectivit s disponibles Lors de la conception de la base de donn es un champ om_collectivite peut tre ajout chaque table ayant besoin d un filtrage par collectivit Les utilisateurs de niveau 1 ne verront aucune notion de collectivit et n auront acc s qu aux l ments li s l
150. intenance l horoscope la m t o une vid o des photos 3 1 Manuel de r f rence 83 openMairie Framework Documentation Version 4 5 Le widget de type Web 3 1 9 2 2 1 interne les liens sur les cartes mettre danbs le champ lien la carte de raphele avec tab_sig_point php scr tab_sig_point_db php obj raphele_l zoom 6 celle de mas thibert scr tab_sig_point php obj odp_6 amp zoom 7 les acc s personnalis s ajax au travers de son code utilisateur dans openCourrier lt script type text javascript gt S ajax type GET url app tab_wid php cache false data sobj tachenonsolde_service success function html aff3 append html lt script gt lt div id aff3 gt lt div gt Ce code lance dans le widget app tab_wid php obj tachenonsolde_service tachenonsolde_service est initialis dans sql mysql tachenonsolde_service inc Il ne s affichera que la premi re page param trer serie pour le nombre d enregistrement affich s Attention si vous affichez plusieurs widgets openmairie mettre un id different pour chaque div ici aff3 3 1 9 2 2 2 externe Les autres applications openMairie peuvent aussi tre accessibles par widget de la m me mani re que le paragraphe ci dessus D autres widgets externes sont accessibles en mettant dans le champ texte les scripts suivants Acces une video externe avec un i
151. ion meld openmairie_recensement svn openmairtrunck trunk 6 1 5 POEdit POEdit est un diteur de traductions de cha nes en plusieurs langues Les cha nes pr sentes dans l interface des applications openMairie sont celles pr sentes dans le code Elles ne peuvent pas comporter d accent Les tapes sont les suivantes 1 avoir dans le code php les cha nes traduire en texte sans accent ni caract res sp ciaux 2 pr parer les dossiers de traductions dans le dossier de locales 3 avoir pr alablement install et configur POEdit 4 configurer le projet dans POEdit et effectuer scan du code afin de d tecter les cha nes traduire 5 traduire les cha nes dans POEdit et sauvegarder 6 1 5 1 Sp cification dans le code des cha nes traduire Les cha nes peuvent tre traduites soit en fran ais accentu soit dans d autres langues Pour cela il est n cessaires qu elles soient pr sentes dans les fichiers php en respectant la syntaxe suivante _ Ma chaine a traduire sans accent Toutes les cha nes de caract res correspondant aux noms de tables et de champs sont g n r es par le g n rateur et sont ainsi directement disponibles 6 1 5 2 Pr paration des dossiers de locales Chaque application openMairie comporte la racine un dossier appel locales Ce dossier comporte une structure de type locales fr_FR LC_MESSAGES openmairie po openmairie mo
152. it push tags tape 6 Suppression de l ancien d p t de documentation sur l adullact pour que personne ne committe dessus svn del m D placement de la documentation vers Github svn ssh S ADULLACTUSER fs echo Documentation d plac e vers https github com openmairie NEWPRODUCTNAME do tm adullact n tumentation svn import m D placement de la documentation vers Github MOVED TO GITHUB txt syn ssh ADI 6 1 7 3 Faire l import initial d un projet sphinx Public s concern s Administrateur de projet openMairie 6 1 7 4 Contribuer une documentation Public s concern s Contributeur membre du projet openMairie 6 1 8 readthedocs org readthedocs org est un site qui h berge de la documentation la rendant accessible et facile trouver Il est pos sible d importer les documentations sur ce site depuis les syst me de gestion de version tel que Subversion Git ou d autres Ce site permet de g rer la mise jour automatique des documentations chaque commit dans ces syst mes de gestion de version Le site supporte galement le support des versions mais seulement pour Git et non pas pour Subversion l heure o cette documentation est r dig e L objectif d utiliser ce site est donc de ne pas avoir se soucier de la g n ration des documentations C est ReadTheDcs org qui s en occupe et dans tous les formats html pdf epub Pour pouvoir g rer un
153. itre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 reqmo libelle contient le lib ll affich en haut reqmol sql contient la requete SQL Dans la requete les param tres sont mis entre et ils sont d finis en dessous sous la forme reqmo parametre checked la colonne est affich ou non un tableau array a b et le choix a ou b est donn 1 utilisateur de requete une requete sql le choix se fait dans la table du select La requete execut e est celle qui est reconstitu e avec les zones sasisies par l utilisateur voies sous openCimetiere Sreqmo libelle Voies par cimetiere Sreqmo sql select voie voietype voielib zonetype zonelib cimetierelib from voie inner join zone on voie zone zone zon inner join cimetiere on zone cimetiere cimetiere cimetier where cimetiere cimetiere cimetiere order by tri Sreqmo tri array voielib zonelib Sreqmo zonetype checked Sreqmo zonelib checked Sreqmo cimetierelib checked Sreqmo cimetiere select cimetiere concat cimetiere cimetierelib from cimetiere 3 1 12 3 Composants Les scripts du framework qui g rent le module Reqmo sont core om_reqmo class php scr reqmo php 3 1 13 Module G olocalisation Il est necessaire que l API openLayers soit dans le framework lib openlayers
154. k 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 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 Poutil 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
155. l pgsql om_lettretype form inc php sql pgsql om_lettretype inc php core sql pgsql om lettretype form inc php core sql pgsql om lettretype inc php gen sql pgsql om_lettretype form inc php gen sql pgsql om_ lettretype inc php Actif non actif Les sous etats sont li s a un ou plusieurs tat 3 1 Manuel de r f rence 89 openMairie Framework Documentation Version 4 5 Les tats sous tats et lettre type peuvent tre actif ou non actif Par d faut sont pris en compte 1 l dition actif de la collectivit 2 l dition actif de la multicollectivit 3 l dition non actif de la multicollectivit Les ditions d une collectivit ayant le statut non actif ne sont pas prises en compte Les requ tes 3 1 10 1 4 1 Description Une requ te peut tre de type SQL de type OBJET 3 1 10 1 4 2 Mod le de donn es CREATE TABLE om _ requete om_requete integer NOT NULL Identifiant unique code character varying 50 NOT NULL Code de la requ te libelle character varying 100 NOT NULL Libell de la requ te description character varying 200 Description de la requ te requete text Requ te SOL merge_fields text Champs de fusion type character varying 200 NOT NULL Requ te SOL ou objet classe character varying 200 Nom de s la classe s contenant la
156. laire multi crit res n aura pas t cr e Ces champs sont appel s ici des crit res de recherche Configuration simple Un crit re de recherche est repr sent par un tableau PHP contenant sa configuration lt php Schamps identifiant_utilisateur array colonne gt om utilisateur table gt om_utilisateur type gt text libelle gt _ Identifiant taille gt 10 max gt 8 2 gt La cl identifiant_utilisateur est le nom du champ HTML qui sera affich sur le formulaire La cl colonne est obligatoire Elle contient le nom de la colonne de la base de donn es qui sera interrog e si la variable _ POST contient la cl identifiant_utilisateur La cl table est obligatoire Elle contient le nom de la table de la base de donn es qui sera interrog e si la variable _POST contient la cl identifiant_utilisateur La cl type est obligatoire Elle contient le type du champ HTML afficher Cela peut tre date text select ou tout autre m thode de la classe formulaire Pour les champs de type select le nom du champ HTML doit tre le m me que le nom de la colonne La cl 1ibelle est obligatoire Elle contient le libell qui sera affich c t du champ dans le formulaire de recherche La cl taille est optionnelle Elle contient la taille du champ HTML attribut HTML size La cl max est optionnelle Elle contient la longueur maximale de la va
157. le g om tri Mise a jour coch autoris la mise a jour type de g om tri polygone polygone point ligne table dossier table du champ g om trique champ geoml champ g ometrique concern Administration Om_sig_map 3 DOSSIER a ia Administration Om_sig map comp 1 om_sig_map_comp 1 om_sig_map 3 Titre polygone Ordre d affichage 1 Actif g Mis jour g Type de g om trie polygone x Table dossier gt Champ geomt stream maso eor Dans 1 exemple pr c dent il apparait une fen tre select ou l utilisateur a le choix entre une g om trie point et une g om trie polygone du fait de la mise en place d une g om trie compl mentaire 3 1 13 4 installation d om_sig_map Pour faire fonctionner tab_sig php il faut installer postgis sous postgres openlayers qui est de base dans le framework lib openlayers optimisation composant openLayers construire un OpenLayers js compresse dans le repertoire build cd buill python build py 3 1 Manuel de r f rence 103 openMairie Framework Documentation Version 4 5 le fichier fait 800 ko au lieu de 3 Mo compression lite python build py lite cfg le fichier fait 120 ko regarder dans le fichier lite les fichiers qui sont inclus t ventuellement le compl ter 3 1 13 5 postgis ce chapitre propose de d crire les possibilit s d utilisation de postgis
158. lement bien placer le code c est dire dans la bonne rubrique pr cis e en commentaire apr s links array et avant Srubrik links links Enfin pour y acc der il faut soit donner les droits via le menu framework soit et c est en l occurrence le cas dans le fichier config inc php option utilis e que pour le d veloppement d commenter la ligne Sconfig permission_if_right_does_not_exist true Vous pouvez maintenant acc der vos formulaires par le menu 1 1 2 5 Menu Application gt Courrier Cette op ration affiche la table courrier 1 1 Tutoriel Cr er une application 9 openMairie Framework Documentation Version 4 5 application courrier courrier 1 0 enregistrement s sur 0 Tous M Recherche z courrier D gt dateenvoi emetteur 2 service 2 Aucun enregistrement openExemple Version 4 4 0 dev Documentation openMairie org On acc de en appuyant sur au formulaire d insertion o les champs sont la date du courrier avec calendrier l objet du courrier dans un champ textarea deux contr les select pour le service et l emetteur application courrier courrier Retour dateenvoi E objetcourrier service Choisir service Ajouter l enregistrement de la table courrier lt Retour openExemple Version 4 4 0 dev Documentation openMairie org Param trage gt Emetteur Cette operation affich
159. leur du champ HTML attribut HTML maxlength 3 1 Manuel de r f rence 65 openMairie Framework Documentation Version 4 5 Une fois tous les crit res de recherche configur s il faudra simplement v rifier que le tableau des crit res est bien utilis par l option de type search Exemple de formulaire pour le tableau du mod le om utilisateur lt php Schamps array Schamps login array table gt om_utilisateur colonne gt login type gt text libelle gt _ Login Schamps email array table gt om_utilisateur colonne gt email type gt text libelle gt _ E mail Schamps om_profil array table gt om_utilisateur colonne gt om profil type gt select tiibelle gt Protil Soptions array type gt search display gt true advanced gt Schamps default_form gt advanced absolute_object gt om_utilisateur gt Configuration avanc e 3 1 5 3 2 1 Cr er un intervalle de date Exemple recherche des utilisateurs cr es entre telle et telle date lt php Schampsl date_ de _creation array colonne gt creation_date table gt user libelle gt _ Date de creation type gt date where gt intervaldate 2 gt Cette configuration permet de cr er deux champs HTML datepicker date_de_ creation _ min
160. m thode methode character varying 200 M thode de la premi re classe si plusieurs d f CONSTRAINT om_requete_pkey PRIMARY KEY om_requete obj om requete class php sql pgsql om_requete form inc php sal pgsql om_requete inc php core obj om requete class php core sql pgsql om requete form inc php core sql pgsql om requete inc php gen obj om_requete class php gen sql pgsql om requete form inc php gen sql pgsql om requete inc php Les sous tats Il est conseill d utiliser l assistant sous etat du g n rateur Les param tres sont les suivants inies fourni texte et caract ristique du Titre Intervalle avant et apr s le tableau Ent te de tableau nom de colonne caract ristique du tableau caract ristique des cellules total moyenne nombre requ te SOL Pour le titre les zones entre crochets sont les champs de fusion s lectionn s par la requ te Les variables commen ant par 82 sont celles d finies dans dyn varpdf inc exemple amp aujourdhui et dans la table om_parametre 90 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 obj om sousetat class php core obj om sousetat class php gen obj om_ sousetat class php sql pgsql om_sousetat form inc php sql pgsql om_sousetat inc php core sql pgsql om sousetat form inc php
161. me les retours charriot en lt br gt mulaire select champ select mulaire selectdisabled champ select non modifiable mulaire selectstatic affiche la valeur de la table li e non modifiable mode consultation mulaire selecthiddenstatic affiche la valeur de la table li e non modifiable ainsi que la valeur dans un champ hidden mulaire select_multiple affiche un select multiple les valeurs pass es au formulaires doivent tre s par es par une vir gule mulaire select_multiple static affiche seulement les valeurs d un select multiple les valeurs pass es au formulaires doivent tre s par es par une virgule mulaire comboG permet d effectuer une corr lation entre un groupe de champ et un identifiant dans les formu laires for for for for for for for for mulaire comboGz2 permet d effectuer une corr lation entre un groupe de champ et un identifiant dans les sous formulaires mulaire comboD permet d effectuer une corr lation entre un groupe de champ et un identifiant dans les formu laires mulaire comboD2 permet d effectuer une corr lation entre un groupe de champ et un identifiant dans les sous formulaires mulaire upload fait appel spg upload php pour t l charger un fichier mulaire upload2 fait appel spg upload php pour t l charger un fichier dans un sous formulaire mulaire voir fait appel spg voir php pour visualiser un
162. metteur_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1 open Exemple openMairie Framework Documentation Version 4 5 CREATE SEQUENCE service_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1 CREATE SEQUENCE courrier_seq START WITH 1 INCREMENT BY 1 NO MINVALUE NO MAXVALUE CACHE 1 Cr ation des tables CREATE TABLE emetteur emetteur int PRIMARY KEY cl primaire nom varchar 20 prenom varchar 20 CREATE TABLE service service int PRIMARY K libelle varchar 20 E K cl primaire CREATE TABLE courrier courrier int PRIMARY KEY cl primaire dateenvoi date objetcourrier text emetteur int REFERENCES emetteur cl trang re service int REFERENCES servic cl trang r Modifier le param trage openMairie pour faire un acc s la base cr e dyn database inc php voir framework parametrage Acc der avec votre navigateur sur openExemple login demo mot de passe demo 1 1 2 Cr er les formulaires Nous allons maintenant cr er les formulaires l aide du g n rateur Pour cela il faut aller dans le menu Administration gt G n rateur Vous devez avoir 3 nouveau
163. mp id file_download_link obj Sobj amp amp champ Schamp amp amp id Sid else file _ download link uid fic 114 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 25 3 1 15 3 3 2 spg voir php Le script permet de visualiser le fichier lt php file_voir_link spg voir php if Sobj amp amp champ amp amp Sid Sfile_voir_link obj 0bJ samp champ champ samp id id else file voir link uid fic 7 gt 3 1 16 Tests et Int gration Continue 3 1 16 1 Pr requis PHPUnit https phpunit de 3 1 16 1 1 1 Installation wget https phar phpunit de phpunit phar chmod x phpunit phar sudo mv phpunit phar usr local bin phpunit Selenium Server http www seleniumhq org 3 1 16 1 2 1 Installation wget http selenium release storage googleapis com 2 45 selenium server standalone 2 45 0 jar java jar selenium server standalone 2 45 0 Jar Robot Framework http robotframework org 3 1 16 1 3 1 Installation sudo apt get install python python pip sudo pip install robotframework robotframework selenium2library robotframework selenium2screensho Avertissement La librairie selenium2screenshots doit tre modifi e pour fonctionner correctement vim usr local lib python2 7 dist packages Selenium2Screenshots keywo
164. mulaire hiddenstatic champ non modifiable la valeur est r cup r par le formulaire formulaire hiddenstaticnunm champ num rique non modifiable et valeur r cup rer formulaire statiq Valeur affich e et non modifiable formulaire affichepdf r cup re un nom d objet un scan pdf formulaire checkbox case cocher valeurs possibles True ou False formulaire checkboxstatic affiche Oui Non non modifiable mode consultation formulaire checkboxnum coch e 1 non coch e 0 formulaire http lien http avec target _blank affichage dans une autre fen tre formulaire httpclick lien avec affichage dans la m me fen tre formulaire date date modifiable avec affichage de calendrier jquery formulaire date2 date modifiable avec affichage de calendrier jquery pour les sous formulaires formulaire hiddenstaticdate date non modifiable Valeur r cup r par le formulaire formulaire datestatic affiche la date format e non modifiable mode consultation formulaire textarea affichage d un textarea 74 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 for for for for for for for for mulaire textareamulti textarea qui r cup re plusieurs valeurs d un select mulaire textareahiddenstatic affichage non modifiable d un textarea et r cup ration de la valeur mulaire pagehtml affichage d un textarea et transfor
165. n de stockage pour le syst me d abstraction de stockage des fichiers Le principe de ce plugin est de stocker tous les fichiers en renommant le fichier avec un UUID identifiant unique et en cr ant une arborescence deux niveaux Le premier est compos des deux premiers caract res de l UUID du fichier et le second niveau des quatre premiers caract res de 1 UUID du fichier Un fichier avec l extension info permet de stocker les informations de base du fichier ainsi que des m tadonn es Sch ma du stockage repertoire de stockage 25 252e 252ece72d4c0f88782d9fd6b99 43dfd repertoire de stockage 25 Le premier niveau des dossiers contenant les deux premiers caract res de l uuid du fichier 252e Le second niveau des dossiers contenant les 4 premiers caracteres de 1 uuid 252ece72d4c0f88782d9fd6b99f43dfd Le fichier est stock avec pour nom un uuid sans du fichier extension la h tadonn es d 252ece72d4c0f88782d9fd6b99f43dfd info Les fichiers info sont l pour stocker les y trois informations obligatoires ces commentaires ne doivent pas appara tre dans l filename plop pdf mimetype application pdf size 124541 m tadonn es suppl mentaires facultatives ces commentaires ne doivent pas appara ti proprietel valeurl propriete2 valeur2 252ece72d4c0f88782d9fd6b99f43dfd_lock Les fichiers _lock sont l pour servir de ma 112 Chapitre 3 Manuel de r
166. n du param trage c est dire les donn es n cessaires l utilisation de l application Ils sont g n r s g n ralement gr ce la commande pg_dump a t lt SCHEMA gt lt TABLE1 gt t lt SCHEMA gt lt TABLE2 gt lt DATABASE gt Le fichier init_parametrage sql permet d initialiser par exemple la ou les collectivit s de base ainsi que les profils et l utilisateur admin Dans certains applicatifs simple ce fichier peut tre unique et tout le param trage contenu dans ce dernier Le fichier init_parametrage_permissions sql permet d initialiser les permissions de l appli catif Cette initialisation se trouve dans un fichier s par pour appr hender plus facilement le param trage des permissions et ventuellement la mise jour de ce param trage Le fichier init _ parametrage editions sql permet d initialiser les editions de base g n rique de l aplicatif Cette initialisation se trouve dans un fichier s par pour appr hender plus facilement le param trage des ditions et ventuellement la mise jour de ce param trage Le fichier init_parametrage_x sql peut permettre de d couper encore l initialisation pour appr hender plus facilement le param trage et ventuellement la mise jour de ce param trage 3 1 2 1 14 Le fichier init data sql Ce fichier contient l initialisation d un jeu de donn es destination de trois environnements distincts
167. n openMairie car l ob jectif est de faciliter la lisibilit et la maintenance du code ainsi que la prise en main par les collectivit s Bonne lecture Table des mati res 1 openMairie Framework Documentation Version 4 5 2 Table des mati res CHAPITRE 1 Tutoriel Cr er une application 1 1 Tutoriel Cr er une application Ce chapitre vous propose de cr er une application de gestion de courrier pas pas 1 1 1 Cr er la base de donn es Vous devez au pr alable r cup rer le framework Dans le r pertoire www de votre serveur apache svn checkout svn scm adullact net scmrepos svn openmairie openmairie_exemple trunk Il vous est propos de cr er la base de donn es sous PostgreSQL Cr er les tables n cessaires au framework openMairie cd data pgsql sudo su postgres dropdb openexemple createdb openexemple amp amp psql openexemple f install sql Cr er les tables n cessaires notre exemple table courrier courrier int 8 cle primaire dateenvoi date objetcourrier text emetteur int8 cle secondaire service int8 cle secondaire table emetteur emetteur int 8 cle primaire nom varchar 20 prenom varchar 20 table service service int 8 cle primaire libelle varchar 20 La requ te correspondante en PostgreSQL est la suivante Cr ation des s quences CREATE SEQUENCE e
168. n permissions inc php Ce script permet de param trer la g n ration des permissions L objectif ici est de pouvoir indiquer des scripts ne pas examiner et des permissions ajouter celles trouv es automatiquement Voici les param tres disponibles lt php x x Liste des fichiers ne pas prendre en compte Permet de lister les fichiers du r pertoire obj dans lequel le syst me de g n ration des permissions ne doit pas passer Default files to avoid array files_to_avoid array pdf_lettre_rar class php pilotage class php Liste des permissions sp cifiques Permet de lister les permission que le syst me de g n ration des permissions n est pas en mesure de trouver Default permissions array permissions array proces_verbal_ fichier telecharger dossier _instructeur_ modifier _ instructeur 2 gt gen dyn pdf inc php Ce script permet de personnaliser les ditions g n r es On peut par exemple g n rer toutes les ditions au format A3 Voici les variables personnalisables lt php longueurtableau 280 Sorientation L orientation P gt portrait L gt paysage Sformat A4 format A3 A4 A5 police arial margeleft 10 marge gauche margetop 5 marge haut 2 1 Manuel d usage 41 openMairie Framework Documentation Version 4 5
169. n propset svn externals F EXTERNALS txt core svn scm adullact net svnroot openmairie openmairie exemple tags 4 2 0 core spg svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 spg scr svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 scr lib svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 1ib css svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 css Js svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 3s img svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 img pdf svn scm adullact net svnroot openmairie openmairie exemple tags 4 2 0 pdf php svn scm adullact net svnroot openmairie openmairie_exemple tags 4 2 0 php om theme svn scm adullact net svnroot openmairie externals om theme kinosura tags 1 0 Appliquer les propri t s externals svn propset svn externals F EXTERNALS txt svn up svn ci attention le repertoire ne doit pas etre existant copie de travail verouill e 6 1 1 6 Keywords 6 1 1 7 Les clients graphiques Il est recommand de savoir utiliser et d utiliser subversion en ligne de commande mais il existe quelques clients graphiques qui permettent de r aliser certaines op rations d une mani re plus conviviale Meld TortoiseSVN 136 Chapitre 6 Outils openMairie Framework Documentation Version 4 5 6 1 1 8
170. na de tars 31 R DE LA REFUELJGUE JAN _ vae mapquest owa aanse Msata Perera dea 005 Y Patar med Version 1 2 ete Dorta roer den Il est appel depuis la classe m tier suivant l exemple suivant Exemple de openmairie_domainepublic objet odp dans sql pgsql odp form inc le champ adressepostale est implement comme un champ v Schamps array odp as adresse_postale specific dans obj odp class php dans la methode setType le champ adresse_postale est du type httpclick function setType amp form maj parent setType form maJ Sform gt setType adresse_postale httpclick avec la methode setVal valoriser par d faut l acc s au script adresse_postale app 3js script js function setVal form maj validation amp db S SDEBUG null bouton adresse postale Sform gt setVal adresse _ postale adresse_postale f1 f1 libelle_voie value f1 numero_voie value Initialiser une variable globale gale a 0 et qui prend la valeur 1 si la zone geome est au format wkt En effet le point ramen par l API externe est au format geographique lattitude lof il commence par POINT x y et il convient de le mettre dans la projection de la zone class odp extends odp_gen 106 Chapitre 3 Manuel de r f rence vide trique ngitude en wil g ometrique openMairie Framework Documentation Version 4 5 var wkt
171. ne nouvelle table insert into parcelle_greasque parcelle section commune geom select section numero section code depl code com the_geom from parcelle where code com 046 Pour mettre jour le champ surface de parcelle dans openfoncier update parcelle set surface round cast area2d geom as numeric 2 Recup ration des donn es de la DGI Les fichiers textes de la DGI sont dans un format r cup r dans le cadre de l application openCadastre qui recons titue des tables postgresql Les fichiers g m triques au format EDIGEO ne sont pas r cup r s compte tenu de son format non standard et il est pr f r utiliser les formats shape de 1 IGN L application openCadastre permet de r cup rer les donn es texte 3 1 14 Abstraction du layout ergonomie Avertissement Cette rubrique est en cours de r daction Depuis la version openMairie 4 il est utilis l ergonomie de jquery 3 1 14 1 Le composant jquery Les skins jquery peuvent tre rajout s dans le r pertoire om_theme Il est possible de g n rer un nouveau th me directement depuis le site de Jquery UI http 3jqueryui com download pour t l charger un th me standard http 3jqueryui com themeroller pour cr er un th me personnalis Le changement de th me peut se faire dans le fichier EXTERNALS txt voir framework param trage 3 1 14 2 Les feuilles de style Les feuilles de style sont stock es d
172. net scmrepos svn opencimetiere documentation temp trunk svn ssh fraynaud scm adullact net scmrepos svn opencimetiere documentation delet detruire le repertoire temp svn del svn tssh fraynaud scm adullact net scmrepos svn opencimetiere documentation Creation d une nouvelle version Copie en tag de la version svn cp svn tssh fraynaud scm adullact net scmrepos svn openboisson trunk svn ssh fraynaud scm adullact net scmrepos svn openboisson tags 1 0 0beta export dans un repertoire local openmairie_debitboisson_1 0 0beta sans les repertoire svn export svntssh fraynaud scm adullact net scmrepos svn openboisson tags 1 0 0b openmairie_debitboisson_1 0 0beta 6 1 2 Concurrent versions system CVS Site officiel du projet CVS Il est not dans ce chapitre les commandes de bases de cvs titre d indicatif Les d veloppeurs d openMairie souhaitent s orienter sur SVN qui est plus facile dans la gestion des r pertoires notament la suppression et dans la mise en place de composants externes externals 6 1 Outils 139 trunk temp PS svn eta openMairie Framework Documentation Version 4 5 6 1 2 1 forge gt local update cvs up cvs up A depuis la branche principale cvs up r branch_name depuis une branche cvs up r tag_ name depuis un tag cvs up d creer sur le poste local les nouveaux repertoires cvs up C Annulation
173. nt li s la cl primaire Il est v rifier l unicit de la cl si elle n est pas automatique version 4 2 0 Les libell s sont les noms des champs Ce module sert pour le formulaire et le s sous formulaire s Les m thodes qui peuvent tre impl ment s dans obj nom_table class php sont les suivantes verifier regroupe et groupe pour modifier les pr sentations deprecated utiliser setLayout trigger avant ou apr s l enregistrement triggerajouter triggermodifier triggersupprimer triggerajouterapres triggermodifierapres triggersupprimerapres Les m thodes de l objet g n r en gen obj peuvent tre surcharg es totalement ou partiellement Exemple om_profil class php surcharge des m thodes setValFAjout setld verifierAjout et setType car la cl primair st num riqu t non automatique om _utilisateur class php champ pwd pour mot de pass methode partiellement surcharg es parent setvalF setvalF setType setValsousformulare surcharge avec un javascript de mise en majuscule du nom Enfin il est possible de mettre en place d autres type de champs disponible dans openMairie en surchargeant la m thode setType ComboG combo gauche comboD combo droit Localisation geolocalisation en x y http lien httpclick lien Password Mot de passe Pagehtml Textearea pour affichage html Textdisabled Text non mo
174. ociatifs chacun repr sentant un lien Les caracteristiques de ce tableau sont les suivantes tableau rubrik title obligatoire description texte qui s affiche au survol de la rubrique href contenu du lien href class classe css qui s affiche sur la rubrique right droit que l utilisateur doit avoir pour visionner cette rubrique links obligatoire open crit res de pr ouverture de cette rubrique du menu tableau links title obligatoire href obligatoire contenu du lien href class classe css qui s affiche sur l element right droit que l utilisateur doit avoir pour visionner cet element target pour ouvrir le lien dans une nouvelle fenetre open crit res de pr ouverture de la rubrique du menu dans laquelle est ce lien et s lection de ce lien en lien actif L entr e open sert marquer une entr e de menu comme active La rubrique contenant cette entr e est ouverte d s l affichage de la page et l entr e active est mise en vidence L entr e open peut contenir soit une cha ne soit un array comportant plusieurs cha nes Chaque cha ne est cr e selon la syntaxe script phplobj chacune des deux parties tant optionnelle Le caract re s parateur est obligatoire Exemple om_ collectivite s lectionnera l entr e pour toutes les url ayant obj om_collectivite tab phplom_collectivite s lectionnera l entr e pour l affichage du tableau de la
175. om_edition class php scr edition php Les librairies PHP sont php fpdf php tcpdf 3 1 11 Module Import Avertissement Cette rubrique est en cours de r daction 3 1 11 1 Principe Ce module permet l import de donn es au format CSV dans les tables de la base de donn es par une interface utilisateur Exemple de format de fichier importer utilisateur txt 92 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 nom login pwd profil Georges DANDIN Georges 21232f297a57a5a74389 a0e4a801fc3 3 Raymond DAVOS Raymond fe01lce2a7fbac8fafaed7 c982a04e229 3 Albert DUPONT Albert 05c7e24700502a079cdd88012b5a76d3 6 3 1 11 2 Param trage Le script de param trage sql pgsql lt OBJ gt import inc php Dans utilisateur import inc php il est defini le message affich en import Simport Insert utilisateur Message la table cible de l import Stable utilisateur la cl primaire si elle est automatique mis n place d une s quence ce champ est vide sinon id utilisateur Le verrouillage de la base de donn es verrou 1 mise jour de la base 0 pas de mise jour pour une phase de test Le mode d bug SDEBUG 1 affichage des enregistrements l ecran 0 pas d affichage La mise en place d un fichier d erreur Sfic_erreur 1 fichier erreur 0 pas de fichier d erreur La mise en place d un
176. om_sig_map om_etat Table courrier cl N cl automatique courrier longueur enregistrement 65 Champs courrier 11 int dateenvoi 12 date objetcourrier 5 blob emetteur 11 int service 11 int registre 20 string Sous formulaire Cl secondaire emetteur service Le g n rateur a donc d tect 2 cl s secondaires et aucun sous formulaire C est pour cela qu il propose 3 reqmo 1 reqmo global et 2 reqmos suivant la cl secondaire Par d faut seules les options du formulaire sont coch es Si vous le refaites plus tard seules celles frabriqu es par le g n rateur seront coch es Cochez les toutes courrier inc php courrier inc php courrier form inc php courrier form inc php courrier class php courrier class php courrier pdf inc php courrier reqmo inc php courrier_emetteur reqmo inc php courrier_service reqmo inc php courrier import inc php En cliquant sur valider vous avez le message 6 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 Le param trage utilis est le param trage standard Vous pouvez le modifier voir g n rateur param trage L affichage par colone est ok ce qui veut dire que la taille des colones dans le fichier pdf sera complet attention le script ne prend pas le champ blob 1 1 2 2 G n rer les formulaires et dition de l emetteur Nous allons
177. onsulter sont disponibles depuis les tableaux Cr er de nouvelles actions La cr ation d actions pour un tableau particulier se fait depuis le r pertoire sql sgba Les actions doivent se d finir dans les fichier objet inc php de la mani re suivante lt php Stab_actions left modifier array lien gt form php obj ob j amp amp action l amp amp idx id gt amp amp premier premier amp amp advs_id S advs _ id amp amp recherche Lib gt lt span class om icon om icon 16 om icon fix edit 16 title _ rights gt array list gt array obj S obj _modifier operator gt ordre gt 20 gt 78 Chapitre 3 Manuel de r f rence Modifier R openMairie Framework Documentation Version 4 5 3 1 7 1 2 1 D finition de l action La premi re cl de tab_actions permet choisir la position d affichage corner pour les actions en coin left pour les actions de gauche Note Depuis la version 4 3 0 d openMairie il est d sormais possible d afficher plusieurs actions dans le coin du tableau au niveau de l action ajouter La seconde cl de Stab_actions permet de d finir la nouvelle action Cette cl doit tre diff rente de ajouter consulter modifieret supprimer Les cl s lien id et lib s utilise de la m me mani re qu avant 3 1 7 1 2 2 D finition du mode d affichage en sous tableau La cl ajax permet d indiquer si l action
178. ont conserv s dans la table om_widget Chaque utilisateur param tre son tableau de bord le tableau de bord param trable L administrateur choisit les widgets pr sents sur le tableau de bord de chaque profil parmi ceux propos s dans l application Il peut placer les widgets o il le souhaite 3 1 9 2 widget Le widget WIDGET DASHBOARD est un bloc d informations contextualis es accessible depuis le tableau de bord de l utilisateur Il peut tre de type Web ou de type Script la cr ation de widget La saisie des widget se fait dans administration gt om_widget La grille de saisie est la suivante libell du widget qui apparaitra 1 adition du widget dans le tableau de bord lien qui sera impl ment pas de lien texte texte du widget iframe javascript ajax profil profil autoris pour le tableau de bord demo Libreville D connexion Tableau d Option Om widget gt 2 1 7 lt NE om_wtdget Cofecvt Uorevte ete Mes tache non sokiees er Iscritab php obj tachencrsolde SCI DE gt Vars Advice ds gt Sal texte type GET ul Adbitab_y d aha cache fame deta ANNAN servce Profi UTILISATEUR ER openCourrier Version 3 0 1 beta Documentation openMairie org Le tableau de bord peut g rer toutes sortes d informations internes ou externes l application les taches non soldees pour openCourrier les appels la ma
179. openMairie Framework Documentation Version 4 5 openMairie 16 11 2015 Table des mati res 1 1 2 Manuel d usage 2 1 1 Tutoriel Cr er une application 3 Tutoriel Cr er une application otes 5 3 8 4 E ae A RE di 4 ANA 3 LIA Cr erla base de donn es sp 3 ss e RIE AR A NRA 3 14 2 Creer les dormulalres 24000 g eap ss AA i 16 4 1 1 2 1 G n rer les formulaires et dition du courrier 5 1 1 2 2 G n rer les formulaires et dition de l emetteur 7 1 1 2 3 G n rer les formulaires et dition de service 8 1 1 2 4 Int grer les formulaires dans le menu 9 11225 MENU sos ee ie ne Airis Sie ne ne ie e b ia ue 9 1 1 37 Personnaliser son application e sop sn 5 QUE ss 4 dd su ms sdb ses 12 1 1 3 1 Faire un affichage courrier plus convivial 13 1 1 3 2 Rendre obligatoire des champs sers mass 44 nu vu A 14 1 1 3 3 Valoriser un champ par d faut 2 es shoes et patate ms ss 15 1 1 3 4 Mettreen majuscule un champ i 54 Lu sous best ugs es 15 KiS PrneIPe a reten otr AI ENS SERIE Er 15 1 14 Modifier la base et r p n rer gt 2 620 1 E B p m a 15 1 1 4 1 Rajouter un champ registre dans courrier 16 11 42 Rajouter l adresse dans melleur lt oss on a ac na 06 aca 16 1 1 4 3 Am liorer la pr sentation du formulaire emetteur 1
180. ormulaire 74 checkboxstatic m thode formulaire 74 cleSecondaire m thode dbform 73 comboD m thode formulaire 75 comboD2 m thode formulaire 75 comboG m thode formulaire 75 comboG2 m thode formulaire 75 create m thode filestorage 111 create_temporary m thode filestorage 111 D date m thode formulaire 74 date2 m thode formulaire 74 datestatic m thode formulaire 74 dbform classe de base 70 debutBloc m thode formulaire 76 debutFieldset m thode formulaire 76 delete m thode filestorage 111 delete_temporary m thode filestorage 112 E enpied m thode formulaire 76 entete m thode formulaire 76 F finBloc m thode formulaire 76 finFieldset m thode formulaire 76 formulaire classe de base 74 formulaire m thode dbform 70 G geom m thode formulaire 75 get m thode filestorage 111 get_temporary m thode filestorage 112 H hidden m thode formulaire 74 hiddenstatic m thode formulaire 74 hiddenstaticdate m thode formulaire 74 hiddenstaticnum m thode formulaire 74 http m thode formulaire 74 httpclick m thode formulaire 74 init_select m thode dbform 70 L localisation m thode formulaire 75 localisation2 m thode formulaire 75 M modifier m thode dbform 73 P pagehtml m thode formulaire 75 password m thode formulaire
181. ormulaire 76 setvalF m thode dbform 73 setvalF m thode formulaire 77 set ValFAjout m thode dbform 73 setValsousformulaire m thode dbform 70 sousformulaire m thode dbform 70 statiq m thode formulaire 74 supprimer m thode dbform 73 T text m thode formulaire 74 textarea m thode formulaire 74 textareahiddenstatic m thode formulaire 75 textareamulti m thode formulaire 74 textdisabled m thode formulaire 74 textreadonly m thode formulaire 74 triggerajouter m thode dbform 73 triggerajouterapres m thode dbform 73 triggermodifier m thode dbform 73 triggermodifierapres m thode dbform 73 triggersupprimer m thode dbform 73 triggersupprimerapres m thode dbform 73 U update m thode filestorage 111 upload m thode formulaire 75 upload2 m thode formulaire 75 V verifier m thode dbform 73 verifierAjout m thode dbform 73 voir m thode formulaire 75 voir2 m thode formulaire 75 152 Index
182. ory en haut droite de l cran c t du login de l utilisateur permet d acc der au formulaire de cr ation d un d p t Voici les informations saisir Owner s lectionner openmairie pour une meilleure lisibilit du projet tous les d p ts doivent tre cr s dans cette organisation Repository name le nom doit tre logiciel documentation sans accents sans espaces en minuscules par exemple pour le logiciel openElec openelec documentation et pour le logiciel openR sultat openresultat documentation Description pour que le d p t sorte correctement dans les recherches il faut saisir Documentation Lo giciel Sphinx par exemple pour openCimeti re Documentation openCimeti re Sphinx Public ou Private s lectionner Public puisque les projets openMairie sont publics Initialize this repository with a README ne pas cocher la case Puis il suffit de cliquer sur le bouton Create repository 6 1 7 2 Importer la documentation depuis un projet subversion de l adullact Public s concern s Administrateur de projet openMairie Les pr requis sont le projet doit d ja tre cr sur github com tre dans un terminal pour saisir les commandes suivantes les commandes svn svn2git et git doivent tre install es tape 0 Modifier et d finir les variables utilis es dans les commandes suivantes export OLDPRODUCTNAME
183. page simplifi e par exemple col_1 permet de d finir une taille dynamique de 1 12 me de la page col_6 correspond a 6 12 soit 50 de l espace disponible il est possible de cr er et ajouter des classes css aux diff rents div afin d obtenir une mise en page personnalis formulaire setFieldset champ contenu libelle style permet d ouvrir fermer contenu D F un fieldset sur un champ champ avec une l gende libelle et un attribut class style une liste de classes css pour fieldset est disponible collapsible ajoute un bou ton sur la l gende jQuery afin de refermer le fieldset et startClosed idem la diff rence que le fieldset est ferm au chargement de la page exemple d impl mentation de la m thode setLayout sans utiliser les m thodes set Groupe et setRegroupe lt php function setlayout amp form maJ Ouverture d un div sur une colonne de 1 2 6 12 de la largeur du conteneur parent Sform gt setBloc om_collectivite D col_6 Ouverture d un fieldset Sform gt setFieldset om_collectivite D _ om_collectivite collapsible Ouverture d un div les champs compris entre om_collectivite et actif la classe group permet d afficher les champs en ligne Sform gt setBloc om_collectivite D group Fermeture du groupe Sform gt setBloc actif EF Fermeture du fieldset Sform gt setFieldset actif F
184. penmairie URL svn scm adullact net svnroot openmairie openmairie tags lt NOUVELLE_VERSION gt Si tout est ok nous pouvons valider nos modifications puis passer la publication de l application svn ci Ici on fait une copie du trunk vers le dossier tags de l application openmairie_exemple T svn cp svn ssh lt NOM_DU_DEV svn ssh lt NOM DU_DEV OPPEUR gt fscm adullact net openmairie openmairie_exemple trunk OPPEUR gt fscm adullact net openmairie openmairie_exemple tags lt NOUV T ti EA svn utilisation il est propose dans ce chapitre de lister quelques commandes utiles en cas de conflit test es en svn type de fichier A Ajout de nouveaux l ments la version locale M l ments modifi s localement par rapport la version de SVN l ments inconnus de SVN non pr sents dans la version de SVN U pour les l ments modifi s dans SVN par rapport la version locale C pour les l ments diff rents entre les versions locale et SVN et qui posent un conflit r gle D fichier supprim s a verifier revert et diff svn revert nomfichier remet dans le dernier etat du svn soit pas del so svn diff nomdossier ou nomfichier affiche les modifications r r au dernier svn up resolution de conflit 138 Chapitre 6 Outils openMairie Framework Documentation Version 4 5
185. permettra de saisir une date minimale date _de creation _max permettra de saisir une date maximale Ces champs permettent de rechercher les utilisateurs dont la date de cr ations est incluse dans l intervalle saisi bornes comprises Il est possible de ne saisir qu une seule date afin de rechercher les utilisateurs ayant t cr s avant ou apr s une date particuli re 3 1 5 3 2 2 Cr er un champ de recherche avec menu d roulant personnalis Exemple recherche des uti lisateurs administrateurs Dans cet exemple l information se trouve directement dans la table interrog e 66 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 lt php soit user une table contenant une colonne is_admin Sargs array Sargs 0 array true false Sargs 1 array _ Tous _ O0ui _ Non Schamps administrator array colonne gt is_admin table gt user libelle gt _ Administrateur type gt select subtype gt manualselect args gt args 23 Cette configuration permet de cr er un champ HTML de type select avec trois choix Tous valeur Oui valeur true Non valeur false Le tableau args 0 contient les valeurs associ es aux choix Elles seront recherch es telles quelles dans la base de donn es En s lectionnant Oui la requ te SQL de recherche sera construite
186. proc der de la m me mani re avec le bouton emetteur L analyse de la base de donn es est la suivante E analyse Analyse de la base de donn es pgsql gt openexemple openexemple Elements Infos Tables de la base om_lettretype om_profil om_collectivite om_sousetat om_logo om_utilisateur de donn es om_parametre om_dashboard om_sig_map_comp courrier om_droit service om_sig_map_wms om_requete om_sig_wms om_widget om_sig_map om_etat Table emetteur cl N cl automatique emetteur longueur enregistrement 136 Champs emetteur 11 int nom 20 string prenom 20 string adresse 40 string cp 5 string ville 40 string Sous formulaire courrier Cl secondaire Le g n rateur rep re un sous formulaire courrier Effectivement il y a une relation de un plusieurs entre emetteur et courrier un emetteur peut avoir 0 plusieurs courriers En cliquant sur toutes les options puis en validant vous avez le message suivant 1 1 Tutoriel Cr er une application 7 openMairie Framework Documentation Version 4 5 Table emetteur Aucun changement de gen sql pgsql emetteur inc php Aucun changement de sql pgsql femetteur inc php Aucun changement de gen sql pgsql emetteur form inc php Aucun changement de sql pgsql emetteurform inc php Aucun changement de gen obj emetteur class php G n ration de
187. projet sur ce site il faut avoir un utilisateur le bouton Inscription en haut droite de la page d acucueil permet d obtenir un compte utilisateur tr s facilement 6 1 8 1 Importer un nouveau projet sur RTD Public s concern s Administrateur de projet openMairie Depuis le tableau de bord de readthedocs org un clic sur le bouton Importer permet d acc der au formulaire de cr ation d un projet sphinx existant Voici les informations saisir Nom le nom du logiciel sans accents sans espaces en minuscules par exemple openelec ou openresultat Repo l URL de githubcom o est stock e le code de la documentation par exemple https github com openmairie openelec documentation git pour openelec ou https github com openmairie openresultat documentation git pour openresultat Type de d p t Git puisque le d p t est sur github com Description Le nom du logiciel avec accents avec espaces et avec la casse par exemple openElec ou openR sultat Language French puisque la documentation est francophone 6 1 Outils 147 openMairie Framework Documentation Version 4 5 URL Projet http www openmairie org Canonical URL laissons vide pour le moment Single version ne pas cocher la case Etiquettes openmairie Puis il suffit de cliquer sur le bouton Cr er Si la cr ation du projet s est bien pass e une
188. ram trer l adresse de l h te l identifiant et le mot de passe de connexion Il permet aussi de stocker la configuration du stockage de fichier temporaire Ce fichier s inspire des autres fichiers de configuration mail inc php directory inc php Il doit contenir un tableau associatif Sfilestorage array Exemple d un param trage la cl filestorage default doit tre rajout e dans une des valeurs du param trage du fichier database inc php comme l est mail default ou directory default Sfilestorage filestorage default array storage gt filesystem l attribut storage est obligatoire storage_path gt l attribut storage path n est pas obligatoire path gt var www openfoncier data temporary gt array storage gt filesystem l attribut storage est obligatoire path gt tmp le repertoire de stockage Si aucun filestorage n est param tr le filestorage deprecated sera instanci et le filestorage temporaire sera le filesystem Description des m thodes de la classe filestorage La classe filestorage contient des m thodes de gestion des fichiers filestorage create data metadonnees mode from_content Permet de cr er un fichier sur le filestorage data contenu du fichier metadonnees tableau contenant la liste des m tadonn es cle gt valeur mode from_content from_path
189. ration select astext st_union geom as geom from amp DB_PREFIXEparcelle where parcelle ili pa_type_geometrie type de g om trie polygone le script de gestion de pannier est scr sig_pannier php La g om trie modifier couche vectors Le chargement de la couche vectors se fait si dans la table om_sig_map la case maj est activ e La g om trie est r cup r e par le script sig_wkt php appel a un script param trable dans var_sig inc et la carte est centr e sur la g om true Il est possible de positionner manellement la g om trie 102 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 d placer la g om trie enregistrer la g ometrie selectionner la g om trie le programme form_sig php est charg en fenetre et permet de supprimer la g om trie champ geometrique null ou modifier cette g om trie Les fonctions javascript et les controles sont activ es suivant chaque tat Dans dyn form_sig_update inc php il est possible de param trer des post traitements de saisie Dans dyn form_sig_delete inc php il est possible de param trer des post traitements de suppression Les g om tries compl mentaires Il peut y avoir plusieurs g om tries pour un m me objet Elles sont saisies dans om_sig_map_comp titre polygone nom de la nouvelle g om tri ordre d affichage 1 ordre d affichage dans le select actif coch activ la nouvel
190. rds robot 3 1 Manuel de r f rence 115 openMairie Framework Documentation Version 4 5 3 1 16 2 Fonctionnement et Utilisation Pr requis Les tests doivent tre jou s dans un environnement balis et reproductible l identique Pour ce faire il est n ces saire avant chaque lancement de test de d rouler une routine qui permet de mettre en place un environnement de tests Un script permet de d rouler cette routine de mani re automatis e om tests c initenv Ce script permet de supprimer la base de donn es cr er la base de donn es initialiser la base de donn es gr ce au script data pgsql install sql red marrer apache pour prendre les traductions en compte donner les droits apache pour les dossiers dans lequel il peut crire faire un lien symbolique vers le dossier de l applicatif pour que les tests en question dans le dossier var www Tous les tests Lancer tous les tests avec initialisation de l environnement de tests om tests c runall Un seul TestSuite Lancer un TestSuite avec initialisation de l environnement de tests om tests c runone t 000_testsuite_a_executer robot Lancer un TestSuite sans initialisation de l environnement de tests om tests c runone t 000_testsuite_ a _executer robot noinit 3 1 16 3 D veloppement et bonnes pratiques Il est pr vu de consigner ici les bonnes pratique
191. ries PHP utilis es par le framework comme dbpear phpmailer ou fpdf D php F htaccess core Contient les classes de la librairie du framework D core F htaccess css Contient les feuilles de style de base du framework img Contient les images du framework js Contient les javascripts de base du framework D 3s lib Contient les librairies javascripts utilis es par le framework comme openLayers ou jquery D 11567 48 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 pdf Contient les scripts d dition du framework D pdf scr Contient les scripts d affichage du framework spg Contient les sous programmes g n riques du framework 3 1 2 Initialisation de la base de donn es 3 1 2 1 Description du dossier data pgsql Il est n cessaire de positionner l ent te de fichier suivant pour chacun des fichiers sql de ce dossier Description succinte de l utilit du fichier Informations n cessaires la g n ration ou la composition du fichier package lt APPLICATIF gt version SVN Id Description de tous les fichiers initx sql Il s av re n cessaire de mettre dans l ent te des fichiers initx sql la commande ou les instructions qui ont permis de g n rer ou de composer le fichier en ques
192. rm ajouter val amp db NULL DEBUG false Cette m thode permet l insertion de donn es dans la base elle appelle toutes les m thodes de traitement v rification et m thodes sp cifiques ajout form modi fier val array amp db NULL DEBUG false Cette m thode permet la modification de donn es dans la base elle appelle toutes les m thodes de traitement et v rification des donn es retourn es par le formulaire form supprimer val array amp db NULL DEBUG false Cette m thode permet la suppression de donn es dans la base elle appelle toutes les m thodes de traitement et v rification des donn es retourn es par le formulaire Gestion des transactions lors de l appel aux m thodes d actions Afin de verifier les erreurs de base de donn es la m thode isError est appel e si la valeur true lui est pass e en second param tre elle ne stop pas l execution mais retour true ou false Cela dans le but d appeler ces m thodes sur des objets m tier instanci s manuellement dans des contextes qui n utilise pas la classe formulaire Exemple lors de la cr ation d un web service qui instancierait une classe si une erreur de base de donn es se produit le script s arr te et aucun message ne peut tre transmis au client du web service ce qui ne se produit pas si le second param tre est d fini true Il est important d instancier un objet m tier et d appeler les m thode
193. rs un plus pour ajouter un widget pour une colone une croix pour supprimer un widget Le d placement du widget de haut en bas ou de gauche droite se fait par copier glisser avec la souris 86 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 openmairie openForcier N Es lt LA http Aocalhost jopenmairie_foncier trunk scr dashboard pho le 4 2 e Maine Bopenmairie Mle usr share appl By Most Visted MClssseur file J fusifsharefappi y Samples Demos E openMairie opent dero ARLES Mot de panse G D connenen Taisns de bord Y f paor j O da conus a apac l e s petita sl odias Presentation de ipen da Carre doree stre A CAPRICORWE Cette aran awe eos recata Mason sore voa pemet Pompe ware Muse en em tmt an soge ts vre Permitir Le port lo Meme Lune Desp AAA 28 16 28 17 OS esien JOLIE Messen 10100 cn siats OpenMairse openf lt http focalhost opermairie foncierftrunk ser dathbosrd pho edition 1 ONE E a e Mairie Bopenmairie fAle usr share appl By Most Vistede Classeur fle J Jusejsharejappi Samples Demos E openMairie openC D o n osa Oita tutaman Donee gater vi donete Mre Ee A mr O Lone AD pe Cantata permet by Gon Au nl Mercre w 5 28 16 217 Mamie 62 amame Tos Pe
194. rs une m me table trang re les noms des colonnes provenant de ces tables trang res devront tre pr fix s par l alias ad quat Cet alias appara t dans la d finition de la variable Stable dans les fichiers g n r s du r pertoire gen sql 4 1 3 2 3 2 La clause ORDER BY Supprimer les surcharges de la variable tri ORDER BY libelle ce tri est g n r par d faut Le g n rateur cr e maintenant une clause SQL ORDER BY pour chaque mod le Le tri par d faut se fait sur une ventuelle colonne 1ibelle Si elle n existe pas la deuxi me colonne de la table est utilis e sinon la cl primaire Note Dans le cas o la deuxi me colonne d une table est utilis e comme libell si cette colonne est une cl trang re alors le tri se fera sur le libell de la table trang re 126 Chapitre 4 Historique amp Mises niveau openMairie Framework Documentation Version 4 5 4 1 3 2 3 3 Les actions du tableau 4 1 3 2 3 4 Les actions d openMairie Remplacer href 0 par tab_actions corner ajouter Remplacer href 1 par tab_actions left modifier Remplacer href 2 par tab_actions left supprimer Pour surcharger l action ajouter il faut maintenant surcharger tab_actions corner ajouter et non plus href 0 lt php Stab_actions corner ajouter array lien gt form php obj ob j amp amp action 0 id
195. rsion 4 5 Titre Fichier Editer Ins rer Voir Format Tableau Outils Formats B Z U Polices dec Tailles de la E i gt l A A le amp datecourrier p Mots 2 EJ Param tres du titre de l dition Positionnement gauche 130 haut 16 x largeur 0 hauteur 10 Bordure bordure sans 2 1 3 2 1 3 Bloc titre titre diteur riche permettant une mise en page complexe 2 1 3 2 1 4 Param tres du titre de l dition Positionnement titre gauche positionnement du titre par rapport la marge gauche de l dition titre haut positionnement du titre par rapport la marge haute de l dition largeur de titre taille de la largeur du titre hauteur hauteur minimum du titre Bordure bordure Affichage ou non d une bordure Corps Fichier Editer Ins rer Voir Format Tableau Outils v Formats B Z U Polices de c Tailles de la gt E l A M SA mms Nous avons le plaisir de vous envoyer votre login et votre mot de passevotre login login Vous souhaitant bonne receptionVotre administrateur p Mots 21 Parametres des sous etats a se_font helvetica se_couleurtexte 000000 E 2 1 Manuel d usage 25 openMairie Framework Documentation Version 4 5 2 1 3 2 1 5 Bloc corps corps diteur riche permettant une mise en page complexe 2
196. rsonnelles lt a RB R 6 LR E 54 Slds LESTACCOUNCIS g 21 1 He 4 AAA DOME 55 31 39 14 L s acthions globales 5 2 6 a a e R Lr AA 56 3 1 3 2 Le tableau de bord o ccoa b 6 maco oe meses 57 3 1 3 3 Les variables locales et la langue 57 3 1 3 4 Le param trage de l application metier 58 3 130 Le Parametrage des Hbrairi s 222 42 4 Lite guests Ai de 88 Tbe deta au 58 3 1 3 6 Lemode DEBUG lt 244 4 0 Lb Dunes sa Labs 8 2 lens 59 3 1 3 7 La version de votre application 59 3 1 3 8 Les informations generales 2224444 4 0 d mg ge HS Else b 60 343 9 installation automatique s s s 222 84 aus Spb Le p age hs ss 60 3 1 3 10 L s param tr s des COMbOS ss scs s i ii que A a AA nu 60 3 1 3 11 Les param tres ditions o s i 5 5 44 4 e e da deu B OE 60 3 1 3 12 Les parametres Om SiS us ss du dis ae 6 0 dil ime Be de Ve ab R Gas le 60 Afficher les tables paneis 25 48 Bus E A a E SRE ES AE 61 314 1 Les script scr tab php et scr soustab php o 61 3 142 Larequ te SQL d athi h g la s p 8 4 dur su de peak sua E 4874 62 3 43 Lesfonchonnalit s i lt t 22 LES NUE Darren J REA b A ah 62 3144 LecomposantopenMairie s sass see ea Bu sie SR age 8 E A 62 LAr ch rch avances A RA 84 A 63 3 1 5 1 Les diff rents types de recherch sa mg t 90 0054 26 dae a e aa 63 3 1 5 1 1 Recherche Simple iodo o e E 3 d
197. s edition array lien gt pdf pdflettretype php obj om_utilisateursamp idx ig gt 1 Lib gt lt span class om prev icon om icon 16 om icon fix pdf 16 title _ Edition gt _ Edition lt span gt ajax gt false ordre gt 21 p gt 80 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 3 1 8 La gestion des acc s Le framework fournit un gestionnaire d acc s configurable dans les menus administration gt profil administration gt droit administration gt utilisateur Les acc s sont conserv s dans les tables du m me nom 3 1 8 1 Fonctionnalit s Synchronisation des utilisateurs provenant d un annuaire Modification du mot de passe par l utilisateur Mot de passe oubli et r initialisation du mot de passe 3 1 8 2 Les tables La gestion des acc s est g r e avec 3 tables om_profil gestion par d faut de 5 profils administrateur 5 super utilisateur 4 utilisateur 3 utilisateur limit 2 consultation 1 Les profils sont hi rarchiques le profil 5 tant le plus lev il a acc s toutes les actions des profils inf rieurs om_droit chaque profil est affect un ou plusieurs droits om_utilisateur cette table permet de donner un login un mot de passe et un profil chaque utilisateur Diagramme de classe Utilisateur idutilisateur
198. s ajouter modifier ou supprimer pour effectuer un changement sur celui ci car toutes les m thodes de trigger seront appel es M thodes appel es lors de la validation dbform setValFAjout val array M thode de traitement des donn es retourn es par le formulaire utilis lors de l ajout dbform setvalF val array M thode de traitement des donn es retourn es par le formulaire dbform verifier val array amp db NULL DEBUG false db db db db db db db db M thode de v rification des donn es et de retour d erreurs form verifierAjout val array amp db NULL M thode de v rification des donn es et de retour d erreurs utilis lors de l ajout form setId amp db NULL Initialisation de la cl primaire si cl automatique lors de l ajout form cleSecondaire id amp db NULL val array SDEBUG false Cette m thode est appel e lors de la suppression d un objet elle permet de v rifier si l objet supprim n est pas li une autre table pour en emp cher la suppression form triggerajouter id amp db NULL val array DEBUG false Permet d effectuer des actions avant l insertion des donn es dans la base form triggerajouterapres id amp db NULL val array SDEBUG false Permet d effectuer des actions apr s l insertion des donn es dans la base form triggermodifier id amp db NULL val array DE
199. s et les consignes pour le d veloppement des tests Documentation RobotFramework http robotframework org robotframework latest RobotFrameworkUserGuide html Librairies Base Builtin http robotframework org robotframework latest libraries BuiltIn html Base String http robotframework org robotframework latest libraries String html Base Collections http robotframework org robotframework latest libraries Collections html Base OperatingSystem http robotframework org robotframework latest libraries OperatingS ystem html Selenium http rtomac github io robotframework selenium2library doc Selenium2Library html Requests http bulkan github io robotframework requests Selenium2Screenshots https robotframework selenium2screenshots readthedocs org en latest _downloads keywords html 116 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Convention de nommage Un fichier de test par th me fonctionnel une TestCase par fonctionnalit Convention de nommage des fichiers mon_theme_fonctionnel robot des testcase Saisir un nouvel l ment G n ration Pr requis cr er le dossier gen dans tests resources core gen Lancer une g n ration compl te chaque modification de la structure de la base de donn es permet de cr er les 99 ee 39 99 cc mots clefs basiques de chaque table depuis le contex
200. s select avec la table li e 76 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 formulaire setTaille taille du champ formulaire setMax nombre de caract res maximum accept s formulaire setOnchange permet de d finir des actions sur l v nement onchange formulaire setKeyup permet de d finir des actions sur l v nement onkeyup formulaire setOnclick permet de d finir des actions sur l v nement onclick formulaire setvalF permet de traiter les donn es avant insert update dans la base de donn es formulaire setGroupe obsol te depuis 4 3 0 formulaire setRegroupe obsol te depuis 4 3 0 formulaire setBloc champ contenu libelle style permet d ouvrir fermer contenu D F DF une balise div sur un champ champ avec un libell libelle et un attribut class style formulaire setFieldset champ contenu libelle style permet d ouvrir fermer contenu D F DF un fieldset sur un champ champ avec une l gende libelle et un attribut class style 3 1 7 Les actions vers formulaires Les liens vers les formulaires sont principalement dans les tableaux et formulaires de consultation d objets 3 1 7 1 Actions des tableaux La surcharge des actions de tableaux se fait via les scripts sq1 sgbd objet inc php L ajout d actions se pr sente de cette fa on lt php
201. secondaire il est possible de s lectionner la requ te g n rer Les autres champs sont s lectionn s l affichage Les requ tes sont accessibles dans l option du menu gt export Imports Un script d import des donn es est g n r suivant le principe suivant si la cl est automatique g n ration du compteur tous les champs sont import s v rification de l existence de la cl secondaire chaque enregistrement Les tables avec cl s secondaires doivent donc tre import es en dernier Mots clefs Robot Framework Un fichier de ressources de mots clefs est cr pour chaque objet De plus tous ces fichiers sont inclus dans un fichier ressource g n ral Pour plus d informations voir G n ration 2 1 4 8 Param trage g n rateur Le g n rateur fonctionne de mani re autonome sans fichier de param trage Il est tout de m me possible de param trer certains l ments gr ce des fichiers de param trage d pos s dans le r pertoire gen dyn Il n est pas n cessaire de personnaliser toutes les variables du fichier Il est recommand de d clarer uniquement les param tres souhait es Par d faut le g n rateur prend les param tres inclus dans la classe gen gen dyn gen inc php Il permet de d finir des param tres g n raux pouvant tre utilis s partout dans le g n rateur lt php Jx Mode de g n ration pour la gestion des identifiants et des r f ren
202. sen Jimbo Messen 1010m0 mn sats pera 10 54 Documentation openbare org A gt P v Mod le de donn es CREATE TABLE om dashboard om_dashboard integer NOT NULL Identifiant unique om_profil integer NOT NULL Profil auquel on affecte le tableau de ville bloc character varying 10 NOT NULL Bloc de positionnement du widget 3 1 Manuel de r f rence 87 openMairie Framework Documentation Version 4 5 position integer Position du widget dans le bloc om_widget integer NOT NULL Identifiant du widget CONSTRAINT om_dashboard_pkey PRIMARY KEY om_dashboard CONSTRAINT om_dashboard_om_profil_fkey FOREIGN KEY om profil REFERENCES openexemple om_profil om_profil CONSTRAINT om_dashboard_om_widget_fkey FOREIGN KEY om_widget REFERENCES openexemple om_widget om_widget obj om_dashboard class php sql pgsq1 om_dashboard form inc php sql pgsq1 om_dashboard inc php core ob3 om_dashboard class php core sql pgsql om dashboard form inc php core sql pgsql om dashboard inc php gen obj om_ dashboard class php gen sql pgsql om_dashboard form inc php gen sql pgsql om_dashboard inc php 3 1 9 4 Composants Les scripts du framework qui s occupent de la gestion du tableau de bord sont scr dashboard php scr dashboard_composer php spg widgetctl php 3 1 10 Module dition Av
203. sse de base pour les classes sp cialis es La classe filestorage est une classe d abstraction de stockage de fichiers C est cette classe qui est instanci e et utilis e par d autres scripts pour g rer la cr ation r cup ration suppression de fichiers et ce peu importe le stockage utilis Son objectif est d instancier la classe de stockage sp cifique aussi appel e plugin de stockage correspondant au param trage s lectionn Cette classe de stockage sp cifique h rite de la classe filestorage_base qui lui sert de mod le Description du fichier de configuration dyn filestorage inc php Ce fichier de configuration doit permettre le param trage du stockage dans chacune des applications Par exemple il permet dans une installation d openElec de stocker les fichiers en utilisant le connecteur filesystem dans le path var openelec data sur le syst me de fichiers et dans une autre installation d openElec de stocker les fichiers dans alfresco sur un autre serveur 110 Chapitre 3 Manuel de r f rence capable de f openMairie Framework Documentation Version 4 5 Il doit permettre de s lectionner le stockage utiliser ainsi que le param trage sp cifique chacun des connecteurs Par exemple pour le stockage filesystem il doit tre possible de param trer le r pertoire dans lequel vont tre stock s les fichiers pour le stockage alfresco il doit tre possible de pa
204. sses d openMairie et par extension aux enregistrements en base de donn es qui les repr sentent 2 1 4 1 Introduction Le g n rateur permet de construire des applications partir de l analyse d un sch ma d une base de don n es Les informations r cup r es dans le sch ma sont les suivantes la liste des tables le nom le type et les contraintes de chaque colonne Sur cette analyse le g n rateur cr e les mod les de donn es openMairie g re les cl s primaires mono colonne les cl s trang res la multi collectivit selon la pr sence d un champ om_collectivite Le g n rateur contient galement des assistants permettant de cr er facilement des tats associ s des collectivit s Attention la version mysql est abandonn e 2 1 4 2 L interface Le menu generateur est le suivant demo acem sur mysql A 19 Tableau de bord documentation generation objet openmaine mysql x 3 om_collectirte dror X ES om_etat Xi ES om _parametre Assistants openmane mysal FS Import version lt 4 ES creation etat F creation sousetat gt creation ettretype lt D rm openExemple Version 4 0 0 dev Documentation openMairie org En appuyant sur la touche generation on acc de l cran de g n ration qui se d compose en une analyse de la base de donn e en cours et de la table choisie un tat des fi
205. t ignlocal formatdate gt AAAA MM JJ schema gt public prefixe gt Sdb_option_externe array debug gt 2 portability gt DB_ PORTABILITY_ ALL Ml G olocalisation par acc s un API externe variables par defaut cp et ville si non renseign es dans le formulaire pour recherche cp 13200 ville Arles Spays a voir epsg de transformation pt adresse postale dans la base en cours Sepsg EPSG 27563 acces au script adresse postale externe Sadresse_interne 0ui Sgoogle Oui google Sbing 0ui bing Sosm 0ui mapquest le parametre adresse_interne Oui permet de consulter une adresse stiock e dans le r seau interne sur la m me base ou sur une base diff rente voir plus haut Ensuite 3 API peuvent tre initialis s google bing et mapquest Mise en oeuvre dans un formulaire d un bouton de la geolocalisation La g olocalisation se fait sur la base du script 3 1 Manuel de r f rence 105 openMairie Framework Documentation Version 4 5 sig adresse_postale php qui fait appel suivant le param trage a adresse_postale_bing php adresse_postale_google php adresse_postale mapquest php j FI Mtp focalhost openmairie_odp trk scgtormohptodi odpAtricol Ridr 18id7 0ES CHAMP SApremie Ob rechorche 4selecioncol 2 c 8 ae bishere apo marque pages Gemo Vie CARLES Mot de passe Decre Tota
206. t t transf r s dans le fichier gen dyn gen inc php gen dyn form inc php Ce script permet de personnaliser les ditions g n r es On peut par exemple g n rer toutes les ditions au format A3 Voici les variables personnalisables lt php Nombre d enregistrements par page dans les listings Sserie 15 Ic ne utilis e auparavant comme lien vers l aide deprecated ico img ico_application png Taille d affichage du champ text nombre de lignes max 6 Ax Taille d affichage du champ text nombre de colonnes Staille 80 Taille d affichage du champ par d faut dans le cas o nous sommes dans l impossibilit de d terminer la taille du champ Uniquement pour le SGBD PostGreSQL pgsql_ taille defaut 20 Taille d affichage du champ minimum pour ne pas afficher des champs trop petits o la saisie serait impossible Uniquement pour le SGBD PostGreSQL pgsql_taille_minimum 10 Taille d affichage du champ maximum pour ne pas afficher des champs trop grands ou le formulaire d passerait de l cran Uniquement pour le SGBD PostGreSQL pgsql_taille_maximum 30 40 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 Jx x Taille d affichage de la date Uniquement pour le SGBD PostGreSQL Spgsql_longueur_ date 12 gt gen dy
207. t array lt classe surcharge 1 de table gt d finition de la liste des champs afficher dans l affichage du tableau champAffiche dans lt table gt inc php displayed _fields_in tableinc gt array lt champ_1 gt d finition des composantes du titre de la page tablename est la derni re composante du titre et breadcrumb est la liste des premi res composantes Ce sont les chaines traduire qui doivent tre saisies ici Le r sultat serait Sent _ lt libelle_1 gt gt _ lt libelle 2 gt gt _ lt libelle gt breadcrumb_in page title gt array lt libelle 1 gt lt libelle_2 gt tablename_in page title gt lt libelle gt d sactivation des sousformulaires pour que les onglets ne s affichent pas dans le contexte de la table tabs_in form gt false Le O 0 716 J E A A E se tables_to_overload array AL om widget gt array displayed_fields_in_tableinc gt array libelle om profil type Lc breadcrumb_in_page_title gt array administration tableaux de bord tablename_in_page_title gt widgets tabs_in_form gt false v 2 1 Manuel d usage 39 openMairie Framework Documentation Version 4 5 2 gt gen dyn tab inc php Ce fichier n est plus utilis par le g n rateur depuis la version 4 5 les param tres g r s dans ce dernier on
208. t OBJ gt etat inc php sql pgsql lt OBJ gt etat inc sql pgsql lt OBJ gt lettretype inc php ou sql pgsql lt OBJ gt lettretype inc sont les anciens fichiers de param trage des ditions Ils ne peuvent plus tre utilis depuis la version 4 0 du framework Un syst me d import est disponible dans le g n rateur pour transformer ces anciens fichiers de param trage en enregistremment selon le nouveau format de param trage 3 1 Manuel de r f rence 91 openMairie Framework Documentation Version 4 5 La pr visualisation Le bouton Pr visualiser permet pour une lettre type ou un tat d avoir un apercu du document qui sera g n r Les champs de fusion ne seront pas interpr t s 3 1 10 2 Les listings Description de la fonctionnalit Le fichier de param trage sql pgsql lt OBJ gt pdf inc php Un tat PDF peut tre g n r par le g n rateur option Les param tres sont les suivants texte et caract ristique du Titre Ent te de tableau nom de colonne caract ristique du tableau caract ristique des cellules total moyenne nombre requ te SOL 3 1 10 3 Les tiquettes Description de la fonctionnalit Le fichier de param trage sql pgsql lt 0BJ gt pdfetiquette inc php 3 1 10 4 Composants Les scripts du framework qui s occupent de la gestion des ditions sont core fpdf_etat php core fpdf_etiquette php core db_fpdf php core
209. t les scripts obj et requ tes sql g n r s par le g n rateur D gen F htaccess D dyn D inc D obj D sql D pgsql 46 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 locales Contient les fichiers de traduction de l applicatif D locales F htaccess ob3 Contient les objets m tiers surchargeant les objets g n r s D obj F htaccess sql Contient les scripts sql surchargeant les scripts g n r s D sql F htaccess D pgsql tests Contient les jeux de tests unitaires et fonctionnels de l applicatif D tests F htaccess tmp Contient les fichiers temporaires cr s par l applicatif D tmp F htaccess trs Contient les fichiers stock s par l applicatif D trs F htaccess p 1 3 1 Manuel de r f rence 47 openMairie Framework Documentation Version 4 5 3 1 1 2 Les r pertoires du framework Ces r pertoires sont ceux qui sont issus du framework c est dire qu ils ne sont pas dans l applicatif lui m me Par exemple sur un applicatif comme openCimeti re ce sont les r pertoires qui vont tre r cup r s par une pro pri t externals sur le gestionnaire de versions que l on appelle les r pertoires du framework php Contient les librai
210. te ajouter modifier supprimer et saisir Bonnes pratiques viter d utiliser les s lecteurs XPATH les s lecteurs CSS ou par ID sont largement pr f rables 3 1 17 Les scripts specifiques de l application Les m thodes sp cifiques l application sont dans obj utils class php qui h ritent de la class om_application class php d openmairie Vous pouvez surcharger les classes d om_application class php dans utils class php Exemple surcharge de la m thode login pour conserver le service d un utilisateur en variable session dans openCourrier Ces classes contiennent les m thodes utilis es par le framework mais qui peuvent vous aider d velopper les scripts compl mentaires de votre application Les scripts compl mentaires sont mis en r pertoire app et peuvent tre cr er pour faire un traitement remise O d un registre archivage export faire un sous programme sp cifique appell par un formulaire bible php dans openCourrier faire une recherche avec un affichage particulier Les scripts javascripts sont mis dans le fichier app js script js Les images sp cifiques sont stock es dans app img 3 1 17 1 R aliser un script complementaire Il est propos ici de vous montrer comment r aliser ce script compl mentaire Le script commence obligatoirement par un appel la biblioth que utils class php et la creation d un objet f require_once obj
211. tem 112 3 1 15 2 6 Description du connecteur filetransferprotocol 113 3 1 15 2 7 Description du connecteur alfresco 113 R US ON ira o Ei e A A 66 QU e A de 113 3 1 15 3 1 Configuration du widget Upload 113 31419311 Contraintes ga k a Se RE 07 e A td i PAi 113 3 115 3 12 M tadonn es lt 24 4 ss d 0 sar d e e d 114 3 1 153 2 R cup ranondufi hier anime 114 3 1 15 3 3 Scripts permettant de visualiser d acc der au fichier 114 31 153311 spg file php cesa e reae lis al 6 M a 114 3 1 15 33 2 Spevom PID vaio ao due aro An 115 3 1 16 Tests et Int gration CONTINUE n e ce e d e A 115 JOA Pre defe L 1 C a e A A a A A 115 3 116 1 A AN 115 31161411 Installation cesto ras Rte 16 Ay 115 3 1 16 12 S l mumServ r nr ado da we 115 34116121 Tostallatiod 24 48 444424 36 S Gr d6 lt dli E 6 h 115 3 1 16 1 3 Robot Framework 7 14 a e aus nb t e a 115 3 1 16 1 3 1 Installation lt eoe cimil 06 a 115 3 1 16 2 Fonctionnement et Utilisation so pscs a ias ga tie a ss gate ua es 116 3 1 16 2 1 Pr f quis 2 44 L Li Si esse Lea me a 116 3 1 16 2 2 Tous les tests o s ari Mis basse a b AE 8208 baba 116 3 1 16 2 37 Un seul TestSutte 254 ada uu a nus dim s Lente 116 3 1 16 3 D veloppement et bonnes pratiques 116 vi 4 Historique amp Mises niveau 3 1 16 3 1 Documentation RobotFrame
212. teur utilis pour pour v rifier les droits de la liste list OR l utilisateur doit avoir au moins un droit AND l utilisateur doit avoir tous les droits 3 1 7 2 Actions du menu contextuel de la consultation Dans dyn config inc php lt php Parametre de gestion des nouvelles actions Permet de definir si la gestion des actions se fait dans la classe ou non Si on decide d utiliser les nouvelles actions alors il n y pas de retro compatibilit les actions suppl mentaires de portlet initialement d clar es dans sql pgsql inc php ne fonctionneront plus et devront tre initialis es dans les attributs de la classe cibl e Default config activate_class_action true Sconfig activate_class_action true 2e 3 1 Manuel de r f rence 79 openMairie Framework Documentation Version 4 5 D finition des actions dans les attributs de la classe de l objet La configuration se fait dans les attributs des classes obj class php L ajout d une action se pr sente de cette fa on lt php var class actions array 2 gt array portlet gt array libelle gt supprimer class gt delete 16 order gt 20 method gt supprimer button gt supprimer permission_suffix gt supprimer condition gt delete coll condition gt La cl du tableau correspond la valeur maj le p
213. thodes suivantes dans obj courrier class php pour que registre ne soit pas modifiable function setType 8 form maJ parent setType form Sma j form gt setType registre hiddenstatic pour la mise jour de la s quence avant l ajout de l enregistrement function triggerajouter id db val SDEBUG prochain numero de registr fonction DB pear Stemp db gt nextId registre fabrication du numero annee_no_d_ordre Stemp date Y Stemp Sthis gt valF registre temp Si vous souhaitez que registre apparaisse dans l affichage de la table vous devez aussi modifier la variable cham pAffiche de sql pgsql courrier inc de la mani re suivante champAffiche array courrier courrier as r courrier MY to_char courrier dateenvoi 1 DD MM YYYYX as _ dateenvoi concat emetteur nom emetteur prenom as _ emetteur service libelle as _ service registre Votre affichage de la table courrier est modifi 1 1 4 2 Rajouter l adresse dans emetteur Il est propos de rajouter l adresse de l emetteur savoir le libell le code postal et la ville La requ te est la suivante ALTER TABLE emetteur ADD adresse VARCHAR 40 ADD cp VARCHAR 5 ADD ville VARCHAR 40 16 Chapitre 1 Tutoriel Cr er une application openMairie Framework
214. tion 3 1 2 1 1 1 Le fichier init sql Ce fichier contient les instructions de base du framework Il permet de cr er les tables et les s quences du framework celles qui commencent par om_ Il est g n r gr ce la commande pg_dump s O n lt SCHEMA gt T lt SCHEMA gt om_ x lt DATABASE gt Dans les applicatifs ce fichier est sens tre directement copi depuis le framework 3 1 Manuel de r f rence 49 openMairie Framework Documentation Version 4 5 3 1 2 1 1 2 Les fichiers init_metierx sql Ces fichiers contiennent les instructions de base de l applica tif Le fichier init _metier sql permet de modifier si besoin le mod le de donn es du framework et de cr er les tables et les s quences de l applicatif celles qui ne commencent par om_ Il est g n r gr ce la commande pg_dump s O n lt SCHEMA gt t lt SCHEMA gt om_x lt DATABASE gt Dans le framework ce fichier est vide Le fichier init_metier_sig sql permet de modifier le mod le de donn es cr pr c demment pour y ajouter des champs de type geom pour la gestion du SIG Le fichier init_metier_vue sql permet de modifier le mod le de donn es cr pr c demment pour y remplacer une table par une vue vers la table d un autre sch ma ou d une autre base de donn es 3 1 2 1 1 3 Les fichiers init parametragex sql Ces fichiers contiennent l initialisatio
215. tion name f1 gt echo lt fieldset gt BOUTON DE VALIDATION echo t lt div class formControls gt echo lt input type submit value remise a 0 du registre Menbsp gt echo lt div gt echo lt form gt jelse validation 1 T VALORISATION DE valF SvalF array SvalF id 0 REQUETE MISE A JOUR avec autoExecute res2 f gt db gt autoExecute registre_seq valF DB_AUTOQUERY_UPDAT E 120 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Sf gt isDatabaseError res2 AFFICHAGE DU RESULTAT AVEC UN FIELDSET echo lt fieldset class 1 cadre ui corner all ui widget content gt n echo t lt legend class ui corner all ui widget content ui state activel gt echo _ Registre lt legend gt echo lt center gt lt b gt _ remise a 0 du registre reussie lt b gt lt center gt echo lt fieldset gt validation Notes Registre _ texte permet l utilisation de poedit pour la traduction de texte class cadre ui corner all ui widget content suivant css de jquery 3 1 Manuel de r f rence 121 openMairie Framework Documentation Version 4 5 122 Chapitre 3 Manuel de r f rence CHAPITRE 4 Historique amp Mises niveau 4 1 Historique amp
216. tions du logiciel regroup es par rubrique et cat gorie Elle se situe gauche du contenu et est visible uniquement lorsque l utilisateur est authentifi Export Param trage Editions tat Sous tat Lettre Type Administration Par d faut le menu est compos de la mani re suivante application vide par d faut contient l acc s votre application export contient le script edition qui reprend les ditions pdf des tables contient le menu reqmo qui reprend les requ tes 3 1 Manuel de r f rence 53 openMairie Framework Documentation Version 4 5 m moris es traitement vide par d faut cet option contient les scripts de traitements parametrage Cette option contient vos tables de param trag fonctionnel Par d faut il contient le param trage des tats sous tats lettres type administration Cette option contient les fonctions de configuration de 1 administrateur technique Cela comprend notamment le parametrage de la collectivit om_sig et la gestion des droits d acc s La configuration des liens se fait dans le fichier dyn menu inc php Ce fichier de param trage n est pas obligatoire Si il n existe pas aucun lien n est affich Ce fichier de param trage doit contenir la d claration d un tableau de tableaux associatifs dans la variable Smenu Chaque tableau associatif repr sente une rubrique Chaque rubrique contient un tableau de tableaux ass
217. tre en danger votre person nalisation 1 1 4 Modifier la base et reg n rer Le framework openMairie permet de modifier la base et prendre en compte ces modifications en reg n rant les scripts sans mettre en p ril la personnalisation que vous avez effectu e Nous vous proposons de rajouter un champ registre dans la table courrier et de rajouter l adresse dans la table emetteur 1 1 Tutoriel Cr er une application 15 openMairie Framework Documentation Version 4 5 1 1 4 1 Rajouter un champ registre dans courrier Il est propos de rajouter un champ registre dans le courrier dont le but est de stocker le num ro de registre du courrier sous la forme annee_numero_d_ordre Nous allons d abord cr er un champ registre dans la table courrier de la mani re suivante ALTER TABLE courrier ADD registre VARCHAR 20 Vous devez reg n rer votre application courrier dans l option du menu Administration gt G n rateur gt Cour rier et laisser coch es les options par d faut gen obj courrier class php gen sql pgsql courrier inc php gen sql pgsql courrier form inc php Validez l op ration Vous pouvez remarquer si vous allez sur le formulaire d ajout qu il y a un nouveau champ registre Votre person nalisation n est pas affect e Nous voulons que le num ro de registre se mette en ajout de mani re automatique une fois le formulaire valid Il faut donc surcharger les m
218. trer la traduction dans le bloc de texte inf rieur A chaque sauvegarde le fichier est compil en un fichier mo L affichage de l application affiche alors les cha nes traduites la place des libell s originaux Attention sur certaines configurations un red marrage du serveur web peut tre n cessaire pour que les traduc tions soient mises jour 6 1 6 Sphinx Site officiel du projet Sphinx 6 1 Outils 145 openMairie Framework Documentation Version 4 5 6 1 7 Github com Pour pouvoir g rer un projet sur ce site il faut avoir un utilisateur le bouton Sign up de la page d acucueil permet d obtenir un compte utilisateur tr s facilement L objectif d utiliser ce site est donc de faciliter la contribution la documentation gr ce l diteur en ligne et au syst me de Pull Request et de d clencher simplement la reg n ration des documentations gr ce au lien automatique avec readthedocs org 6 1 7 1 Cr er un projet Public s concern s Administrateur de projet openMairie Il s agit ici de cr er un nouveau repository sur github com dans l organisation openmairie Le projet doit s appeler openlogiciel documentation par exemple pour le logiciel openElec openelec documentation et pour le logiciel openR sultat openresultat documentation Ne rien faire d autre dans ce repository Depuis le tableau de bord de github com un clic sur le bouton puis New reposit
219. ualselect where gt insubquery args gt args subquery gt S subquery 2 gt Cette configuration permet de cr er un champ HTML de type select avec trois choix Tous valeur Administrateurs valeur t rue Utilisateurs simples valeur false Le tableau args 0 contient les valeurs associ es aux choix La valeur t rue indique que les identifiants des utilisateurs doivent se trouver dans la sous requ te La valeur false indique qu ils ne doivent pas se trouver dans la sous requ te Contrairement l exemple Cr er un champ de recherche avec menu d roulant personnalis les valeurs ne seront pas recherch es telles quelles dans la base de donn es et ne doivent surtout pas tre modifi es En s lectionnant Administrateurs la requ te SQL de recherche sera construite comme suit WHERE user id IN SELECT user_id FROM admin 3 1 6 Les formulaires Les formulaires openMairie sont une visualisation d un objet d une classe m tier 3 1 6 1 Introduction Les formulaires permettent la consultation l ajout la modification et la suppression d enregistrements des tables de la base de donn es Consultation La consultation d un l ment est construite de la m me fa on qu un formulaire Elle contient une liste d actions contextuelles configurable Les donn es ne sont pas ditables admin Ville d ARLES Mot de passe 4 D connexion Open MAIRIE Tableau de
220. ue passer dans l url pour tab php dyn soustab php variable specifique passer dans l url pour soustab dyn form php variable specifique passer dans l url pour form php dyn sousform php variable specifique passer dans l url pour sous php dyn var inc variable application deprecated pr f rez om _ parame dyn varetatpdf inc variabl tat et sousetat pdf dyn varlettretypepdf inc varaible lettre type dyn varsousform get specific inc php variable sp cifique sousform dyn directory inc php connexions a des annuaires LDAP dyn comboaffichage inc php param trage combo dyn comboparametre inc php parametrage combo dyn comboretour inc php param trage combo README txt fichiers textes HISTORY Ext JICENCE txt TODO txt INSTALL txt app SPECIFIC txt explication sur la partie sp cifique de 1 applicatiof php LES pi 3 1 3 1 Les zones de navigation Quatre zones de navigation diff rentes sont disponibles dans le framework 52 Chapitre 3 Manuel de r f rence openMairie Framework Documentation Version 4 5 Actions personnelles admin LIBREVILLE Mot de passe 4 D connexion Raccourcis Tableau de bord Export Tableau De Bord v Param trage Editions Etat Sous tat Lettre Type gt Administration Menu Actions globales openExemple Version 4 3 0 Documentation openMairie org Le menu Le but de cette zone de navigation est de rassembler les liens vers toutes les fonc
221. ue le syst me est capable de faire 3 1 15 3 Utilisation Les m thodes de la classe d abstraction sont d sormais utilis es dans la classe upload et dans les widgets upload file du formulaire Il est possible de param trer une liste de m tadonn es d un champ upload certains champs de ce formulaire pouvant contenir certaines informations ajouter aux informations du fichier upload il est necessaire de cr er le fichier lors de la validation du formulaire Pour ce faire le fichier upload sera enregistr temporairement sur le filestorage d fini pour les fichiers temporaires puis enregistr sur le filestorage d finitif lors de la validation du formulaire Hors formulaire la m thode create peut tre utlis e de 3 fa ons en lui passant le chemin du fichier dans data et avec le mode d fini from_ path en lui passant le contenu du fichier dans data fonctionnement existant avant modification en lui passant l UUID d un fichier temporaire avec le mode d fini from_temporary Configuration du widget Upload 3 1 15 3 1 1 Contraintes Les contraintes sont rajouter dans la classe m tier de l objet concern dans la m thode setSelect Exemple de configuration de l ajout de contraintes de contr les de la taille maximale et de l extension lors de l upload de fichier 3 1 Manuel de r f rence 113 openMairie Framework Documentation Version 4 5 lt php params
222. ue postgis c est pour l instant une limite de la version 4 2 0 exemple openFoncier carte dossier Il est propos dans ce cas de stocker des polygones dans le pannier et de sauvegarder un multipolygone constitu de ces polygones r cup r s dans le pannier Choisir dans le select polygone L etat est dessinner Il apparait le pannier parcelle S lectionner les parcelles en cliquant dessus elles sont vertes dossier pco1rooz101 pme A M Fek O e m E e r m Valider une fois les parcelles choisies elles deviennent rouge 3 1 Manuel de r f rence 101 openMairie Framework Documentation Version 4 5 3 Z M Bu Y Dessiner 4 ii openMairie openFoncier Mozilla Fire Sa A a yA SE localhost openforcics trunk scr form_sig phpzob A O Enregistrer KJ Cliquer sur le jeu de parcelles de votre choix ce jeu devient vert clair Il peut y avoir un ou plusieurs panniers exemple parcelle batiment par contre la g om trie r cup r e ne concerne qu une seule couche la gestion de pannier se fait dans om_sig_map_wms panier option pannier activ Oui non Exemple dossier openFoncier t pa_nom nom du pannier parcelle pa_layer nom du layer pannier parcelle pa_attribut attribut de la couche r cup rer parcelle pa_encaps caract re d encapsuation la il pa_sql requ te de r cup
223. uleur texte R C2entetetxt 0 couleur texte V C3entetetxt 0 couleur texte B SClborder 159 couleur texte R C2border 160 couleur texte V C3border 167 couleur texte Bl Sbt 1 border lere et derniere ligne du tableau par page gt 0 ou 1 2 gt gen dyn etat inc php Ce fichier n est plus utilis par le g n rateur depuis la version 4 0 et la gestion des ditions en base de donn es gen dyn sousetat inc php Ce fichier n est plus utilis par le g n rateur depuis la version 4 0 et la gestion des ditions en base de donn es 42 Chapitre 2 Manuel d usage openMairie Framework Documentation Version 4 5 2 1 5 Int gration 2 1 6 Pour aller plus loin 2 1 Manuel d usage 43 openMairie Framework Documentation Version 4 5 44 Chapitre 2 Manuel d usage CHAPITRE 3 Manuel de r f rence 3 1 Manuel de r f rence 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 framewor
224. un tableau de tableaux associatifs dans la variable short 1inks Chaque tableau associatif repr sente un lien 3 1 Manuel de r f rence 55 openMairie Framework Documentation Version 4 5 lt php On initialise le tableau conteneur Sshortlinks array On ajoute au tableau conteneur un tableau associatif repr sentant un lien r p ter autant de fois que n cessaire Sshortlinks array title gt _ Link description gt _ Description href gt scr link php target gt _blank class gt action link right gt iink 25 Param tre Requis Description title O Texte description N Texte qui s affiche au survol de l l ment href N Contenu du lien href target N Attribut pour ouvrir le lien dans une nouvelle fen tre class N Classe CSS qui s affiche sur l l ment right N Permission n cessaire l utilisateur pour visualiser l l ment Les actions globales Le but de cette zone de navigation est de repr senter la section propos du logiciel Elle se situe en bas de l cran juste au dessous du contenu de la page et est visible lorsque l utilisateur est authentifi ou non openExemple Version 4 3 0 Documentation openMairie org Par d faut les actions globales sont compos es de trois l ments le nom du logiciel ainsi que son num ro de version un lien vers la documentation du
225. ur le projet lt NOM_DU_DEVELOPPEUR gt 142 Chapitre 6 Outils openMairie Framework Documentation Version 4 5 Etape 1 R cup rer le code du CVS cvs d pserver anonymous scm adullact net cvsroot lt NOM DU_PROJET gt login cvs d pserver anonymous scm adullact net cvsroot lt NOM DU _ PROJET gt export DNOW lt NO Important si un mot de passe est demand un mot de passe vide fera l affaire A cette tape il est recommand de faire une archive du dossier lt NOM_DU_MODULE gt qui vient d tre export pour le sauvegarder Etape 2 Changer le type de d p t En tant qu administrateur aller dans l onglet Sources puis cliquer sur le lien Administration Choisir alors SVN puis cliquer sur le bouton Mettre jour Il faut ensuite attendre le temps d attente est variable entre 30 minutes et plusieurs heures que le d p t subversion soit activ Etape 3 Cr er la structure du d p t Ici nous allons cr er la structure standard d un d p t Subversion trunk tags branches _DU_MODULE gt svn mkdir svn ssh lt NOM DU DEVELOPPEUR gt scm adullact net svnroot lt NOM DU PROJET gt tr nk svn ssh Etape 4 Importer le code sur le nouveau d p t Subversion 6 1 2 9 5 1 Cas1 Si l application doit tre utilis e telle qu elle a t r cup r e sur le CVS alors nous allons l importer
226. ur pour visualiser l l ment 3 1 3 2 Le tableau de bord Le tableau de bord se param tre dans le fichier dyn dashboard inc Ce fichier est appell par le script scr dashboard php Pour avoir son propre tableau de bord il suffit de decommenter la ligne die et on acc de plus au widget Voir chapitre widget et tableau de bord param trable 3 1 3 3 Les variables locales et la langue Les variables locales sont param tr es dans le fichier dyn locales inc php Ce fichier contient le param trage du codage des caracteres ISO 8859 1 ou UTF8 DEPRECATED define CHARSET ISO 8859 1 ou define CHARSET UTF8 Dans la version 4 2 0 il y a 2 param tres pour la base DB_CHARSET pour apache HTTP_CHARSET Ces 2 parametres remplacent CHARSET Note Dans apache il est possible de modifiet l encodage dans etc apache2 apache2 conf commenter AddDefaultCharset ISO 8859 1 relancer ensuite apache etc apache2 init d apache2 reload A partir de la version 3 0 1 1 imcompatibilit utf8 de la bibliotheque fpdf est trait e le dossier ou sont install es les variables du systeme define LOCALE fr_FR Le dossier contenant les locales et les fichiers de traduction define LOCALES_DIRECTORY locales Le domaine de traduction define DOMAIN openmairie Les zones traduire sont
227. uveau projet de traduction m me si le projet comporte d j une traduc tion Saisir le nom du projet et le chemin complet du dossier contenant le projet chemin complet permettant d aller la racine du logiciel openMairie Valider Cela cr e le projet Les fichiers po existants sont automatiquement d tect s Cliquer alors sur le bouton Mettre jour tous les catalogues du projet Un scan de code est alors effectu par POEdit Cela va parcourir tous les fichiers php du dossier afin de d tecter toutes les cha nes encadr es par _ Le scan peut comporter des erreurs en g n ral des accents dans les cha nes traduire des accents dans les commentaires du code des cha nes traduire vides etc Dans ce cas le fichier et la ligne concern e sont indiqu s dans le rapport d erreur Il est recommand de corriger l erreur et recommencer la mise jour Le rapport affiche les cha nes d su tes celles qui ne figurent plus dans le code et les nouvelles cha nes Les cha nes d su tes sont alors comment es dans le fichier po et n apparaissent plus dans l interface de traduction 6 1 5 5 Traduction des cha nes Depuis l cran du projet dans POEdit double cliquer sur le fichier de la langue concern e La liste des cha nes traduire appara t alors Les nouvelles cha nes sont en premier les cha nes modifi es en second et les autres cha nes ensuite Il suffit de cliquer sur une cha ne et en
228. version de la documentation a du tre g n r e celle ci est disponible en cliquant sur le bouton Afficher les docs sur la page du projet nouvellement cr 6 1 8 2 Param trer une nouvelle version d un projet existant Public s concern s Administrateur de projet openMairie Par d faut un projet sur readthedocs org g re uniquement la derni re version de la documentation latest en r cup rant la branche par d faut de la documentation sur github com master Il est possible de g rer plusieurs versions de la documentation pour obtenir des URL du style http omframework readthedocs org fr 4 2 http omframework readthedocs org fr 4 4 http omframework readthedocs org fr latest Chaque version dans readthedocs org correspond une branche dans le d p t du projet sur github com 148 Chapitre 6 Outils CHAPITRE 7 Contributeurs par ordre alphab tique atReal Thierry Benita Romain Beylerian Matthias Broquet Nicolas Haye Nicolas Meucci Florent Michon Virginie Pihour Francois Raynaud Sofien Timezouaght 149 openMairie Framework Documentation Version 4 5 150 Chapitre 7 Contributeurs Index A affichepdf m thode formulaire 74 afficher m thode formulaire 76 afficherChamp m thode formulaire 76 ajouter m thode dbform 73 C checkbox m thode formulaire 74 checkboxnum m thode f
229. work 3 1 16 3 2 Convention de nommage s ice ends ui se LOIS G N TANOM s 45 54e Lens sense se parue les 3 1 16 3 4 Bonnes pratiques sense ra a RA 31 17 Les scripts specitiques de l application ber AAA ga ue gs 3 1 17 1 R aliser un script complementaire 21H72 EXEMPLE r ns ne M es Det Eu en D Gr es 4 11 Historique amp Mises miveae soos eoe a dd 18 E e dirait a Re Rte Eu La version 4 5 4 1 1 4 1 4 5 R gles 4 1 1 1 4 1 1 2 4 1 2 1 4 1 2 2 Les nouveaut s de la version 45 Mettre niveau depuis openMairie 4 4 vers 45 La version 4 4 Mettre niveau depuis openMairie 4 3 vers 44 4 1 2 2 1 tape 1 mettre jour la base de donn es 41 22 1 1 La Structure 5 4 4 4 Do vu e 4 a 6 204 4 1 2 2 2 4 1 2 2 3 4 1 2 2 4 4 1 2 2 5 La version 4 3 4 1 3 1 4 1 3 2 tape 2 mise jour du menu tape 3 v rification des requ tes et logos tape 4 syst me de stockage des fichiers LS erreurs CoNMUES cp mi bo nu da ae das Les nouveaut s de la version 43 Mettre niveau depuis openMairie 4 2 vers 43 4 1 3 2 1 tape 1 mettre jour les surcharges du framework 4 1 3 2 1 1 Classe application esmerado ee 4 1 3 2 1 2 Classe ABF OTM o 5 t
230. x boutons courrier service et emetteur 4 Chapitre 1 Tutoriel Cr er une application openMairie Framework Documentation Version 4 5 EJ G n ration objet openexemple pgsql Ea G n rer tous les objets L courrier 2 amp om_dashboard kd 3 6 emetteur pelle 07 20 K E om requete X JE om sig_map_wms x e om_utilisateur amp om_collectivite LA l om_etat om_parametre a CA om_lettretype K 6 om_profil CA om_sig_map_comp CA om_sig_map s om_sig_wms 4 e om_widget amp om_sousetat E 6 service 3e e Be De pe x ES De Le 1x D D x Avant de commencer l utilisateur apache www data doit avoir les droits d criture dans les repertoires gen sql et obj 1 1 2 1 G n rer les formulaires et dition du courrier En appuyant sur le bouton de courrier vous avez les choix de g n ration Choix des fichiers g n rer Selection Nom Fichier Generer formulaire g courrier inc php gen sql pgsq courrier inc php Le fichier n existe pas ou n est pas accessible g courrier inc php sql pgsq courrier inc php Le fichier n existe pas ou n est pas accessible g courrier form inc php gen sql pgsq courrier form inc php Le fichier n existe pas ou n est pas accessible g courrier form inc php sql pgsql courrier form inc php Le fichier n existe pas ou n

Download Pdf Manuals

image

Related Search

Related Contents

IBM Informix High-Performance Loader User's Guide  Matita Tutorial - Dipartimento di Informatica  - HSR - Institutional Repository    Swingline SelfSeal  Rapport d`activité Projet Nîmes inondations, année 1    Dist2Walls V1.5 - User Guide - - elsA  Manuale di SPAC Start 2013  romÂnĂ/ moldoveneascĂ ҚАЗАҚ ENGLISH DEUTSCH РУССКИЙ к  

Copyright © All rights reserved.
Failed to retrieve file