Commit 688efd57 authored by François Raynaud's avatar François Raynaud
Browse files

Modif version 1.01

parent d5d6a881
......@@ -6,13 +6,11 @@ La gestion des accès
Le framework fournit un gestionnaire d'accés accessible dans le menu à :
Le framework fournit un gestionnaire d'accés accessible dans le menu à ::
- administration -> profil
- administration -> droit
- administration ->utilisateur
- administration -> profil
- administration -> droit
- administration ->utilisateur
Les accès sont conservés dans des tables.
......
......@@ -22,7 +22,7 @@ Les paramétres sont les suivants pour om_parametre.inc ::
$serie=15; Nombre d'enregistrement par page
$ico="../img/ico_application.png"; Icone affiché
$ico="../img/ico_application.png"; Icone affiché (a voir deprecated)
$ent = _("option")." -> "._("om_parametre"); Titre du tableau
......
......@@ -4,23 +4,19 @@
Les éditions
############
Les éditions sont accessibles dans le menu par :
Les éditions sont accessibles dans le menu par ::
- administration -> etat
- administration -> etat
- administration -> sousetat
- administration -> lettretype
- administration -> sousetat
- administration -> lettretype
Depuis la version 4 d'openMairie, les editions sont conservées dans 3 tables ::
Depuis la version 4 d'openMairie, les editions sont conservées dans 3 tables :
- om_etat : pour les états
- om_sousetat : pour les sous etats
- om_lettretype : pour les lettres types
- om_etat : pour les états
- om_sousetat : pour les sous etats
- om_lettretype : pour les lettres types
......@@ -67,7 +63,7 @@ Les paramètres sont les suivants ::
les sous etats associés et les caractéristiques
Pour le corps, le titre et la requete sql, les zones entre crochets (exemple [nom]) sont les champs selectionnés par la requete.
Pour le corps et le titre, les zones entre crochets (exemple [nom]) sont les champs selectionnés par la requete.
Les variables commençant par "&" sont définies dans dyn/varpdf.inc (exemple &aujourdhui)
et dans la table om_parametre.
......@@ -89,7 +85,7 @@ Les paramétres sont les suivants ::
requete sql
Pour le titre et la requete sql, les zones entre crochets sont les champs selectionnés par la requete.
Pour le titre, les zones entre crochets sont les champs selectionnés par la requete.
Les variables commençant par "&" sont définies dans dyn/varpdf.inc (exemple &aujourdhui)
et dans la table om_parametre
......@@ -114,7 +110,7 @@ Les paramétres sont les suivants ::
la requete SQL
Pour le corps, le titre et la requete sql, les zones entre crochets sont les champs selectionnés par la requete.
Pour le corps et le titre, les zones entre crochets sont les champs selectionnés par la requete.
Les variables commençant par "&" sont définies dans dyn/varlettretypepdf.inc (exemple &aujourdhui)
et dans la table om_parametre
......@@ -136,7 +132,7 @@ Les paramétres sont les suivants ::
tatal, moyenne, nombre
requete sql
Pour le titre et la requete sql, les zones entre crochets sont les champs selectionnés par la requete.
Pour le titre, les zones entre crochets sont les champs selectionnés par la requete.
Les variables commençant par "&" sont définies dans dyn/varpdf.inc (exemple &aujourdhui)
et dans la table om_parametre
......@@ -149,14 +145,14 @@ Les zones entre crochets sont les champs selectionnés par la requete.
La variable &aujourdhui sont définies dans dyn/varetiquettepdf.inc et dans la
table om_parametre
Il y aura une integration depuis l utilisation d'openPersonnalite dans la version openMairie 4.0.1..
Il y aura une integration depuis l utilisation d'openPersonnalite dans une prochaine version openMairie.
=================
L'éditeur WYSIWYG
=================
Un editeur est prevu dans la prochaine version openMairie 4.0.1
Un editeur est prevu dans une prochaine version openMairie.
===============
......@@ -176,7 +172,7 @@ les scripts sont les suivants ::
pdfetiquette.php : etiquette
pdflettretype.php
pdfEtiquette sera repris dans la version 4.0.1 d'openMairie
pdfEtiquette sera repris dans une prochaine version d'openMairie
**specifique openCourrier pour ecriture sur pdf** ::
......@@ -189,7 +185,7 @@ pdfEtiquette sera repris dans la version 4.0.1 d'openMairie
pdf_parser.php
testfpdi.php
Il n est pas prévu d integration dans la prochaine version
Il n est pas prévu d integration dans la prochaine version
==========
composants
......@@ -211,11 +207,23 @@ Les scripts ci dessous sont les classes qui interfacent openmairie avec fpdf ::
*/phpmailer*
la gestion de mail est EN TEST avec openPersonnalite et sera intégré dans openMairie 4.0.1
la gestion de mail est EN TEST avec openPersonnalite et sera intégré à terme
dans openMairie
Les composants javascript sont stockés dans le repertoire **lib/**
*/tinymce*
est l'editeur wisiwig EN TEST sur openRecensement et qui sera intégré dans openmairie 4.0.1)
est l'editeur wisiwig
EN TEST sur openRecensement et qui sera intégré à terme dans openmairie
*/openlayers*
est la librairie pour le SIG
voir chapître sur l'information géographique
*/jquery-ui et jquery-misc*
librairies jquery
......@@ -4,7 +4,7 @@
L'ergonomie
##########
Depuis la version openMairie 4, il est décidé d'utiliser l'ergonomie de jquery.
Depuis la version openMairie 4, il est utilisé l'ergonomie de jquery.
......
......@@ -20,28 +20,53 @@ La classe formulaire.class.php a les méthodes suivantes :
Les méthodes sur les controles du formulaire ::
Hiddenstatic -> Champ non modifiable Valeur récupéré par le formulaire
Hiddenstaticdate -> date non modifiable Valeur récupéré par le formulaire
statiq -> Valeur non modifiable
date -> date modifiable js/calendrier
select -> Controle select
selectdisabled -> Controle select non modifiable
Text -> Controle text
hidden -> Controle non visible avec valeur conservée
password -> Controle password
Textdisabled -> Controle text non modifiable
comboG -> Appel à un programme de correspondance à une table
text : Controle text (format standart)
hidden : Controle non visible avec valeur conservée
password : Controle password
textdisabled : Controle text non modifiable
textreadonly : contrôle text non modifiable
hiddenstatic : Champ non modifiable Valeur récupéré par le formulaire
hiddenstaticnum : champ numerique non modifiable et valeur récupérer
statiq : Valeur affichée et non modifiable
affichepdf : récupére un nom d'objet (un scan pdf)
checkbox : controle case à cocher : cochée = Oui, Non cochée = Non
checkboxnum : cochée = 1 , non cochée = 0
http : lien http avec target = _blank (affichage dans une autre fenêtre)
httpclick : lien avec affichage dans la même fenêtre.
date et date2 : date modifiable avec affichage de calendrier jquery
Hiddenstaticdate date non modifiable Valeur récupéré par le formulaire
textarea : affichage d un textarea
textareamulti : textarea qui récupére plusieurs valeurs d'un select
textareahiddenstatic : affichage non modifiable d'un textarea et recupération de la valeur
pagehtml : affichage d'un textarea et tranforme les retour charriot en <br>
select : Controle select
selectdisabled : Controle select non modifiable
comboG et comboG2-> Appel à un programme de correspondance à une table
Cas ou il y a une grosse table en correspondance
spg/combo
ComboD -> Appel à un programme de correspondance à une table
spg/combo.php
ComboD et comboD2 -> Appel à un programme de correspondance à une table
Cas ou il y a une grosse table en correspondance
spg/combo
Upload -> spg/upload et spg/voir.php
textarea
textarea_html
localisation -> spg/localisation.php
rvb -> spg/rvb.php
spg/combo.php
Upload et upload2 fait appel à spg/upload.php pout télécharger un fichier
voir et voir2 : fait appel à spg/voir.php pour visualiser un fichier
localisation et localisation2 : fait appel à spg/localisation.php
rvb et rvb2 : fait appel à spg/rvb.php pour affichage de la palette couleur
Les contrôle comboG, comboD, date, upload, voir et localisation sont à mettre dans
les formulaires (retour de l'affichage dans le formulaire f1)
Les contrôle comboG2, comboD2, date2, upload2, voir2 et localisation sont à mettre dans
les sous formulaires (retour de l'affichage dans le formulaire f2)
Les méthodes de construction et d affichage ::
......
......@@ -40,19 +40,42 @@ formulaire (longueur, max, nom).
Ce chapître propose de vous décrire les outils de base du framework de la manière suivante :
- le paramétrage général du framework
- la gestion des accès du framework et la multi collectivite
- les méthodes pour construire des formulaires avec le framework
- les outils d'édition du framework
- l'outil de requête paramétrable du framework
- la gestion des accès du framework et la multi collectivite)
- l'ergonomie intégrant jquery
- la gestion de traitement et la construction de programme spécifiques avec les utilitaires
- l'import des données CSV du framework
- l'interface geographique intégrant openlayers avec openCimetiere
- l'envoi de mail intégrant phpmail avec openPersonnalite (en projet)
- le fonctionnement d'artichow dans openResultat (en projet)
- le fonctionnement du nusoap dans openFoncier (enprojet)
- l'utilisation de fpdf pour écrire dans un pdf dans openCourrier (en projet)
- la mise en oeuvre d'un éditeur wysiwyg pour l'édition des états (en projet)
L'utilisation de fpdf pour écrire dans un pdf dans openCourrier est
décrit dans ce chapître bien que non intégré dans le framework
Deux modules du framework intégré dans la version 4.01 sont traités dans un
chapître à part
- l'information géographique
- les widgets et le tableau de bord paraùètrable
Les modules suivants utilisés dans des applications openMairie ne sont pas décrit
dans ce chapître car ils n'ont pas encore intégrés dans le framework openExemple
- l'envoi de mail intégrant phpmail (openPersonnalite)
- le fonctionnement des graphiques avec artichow (openResultat)
- le fonctionnement de webservice avec nusoap (openFoncier 2.xx)
Il est fait mention des projets en cours :
- la mise en oeuvre d'un éditeur wysiwyg pour l'édition des états
- un installateur paramétrable
- un bus de données (dans le cadre de la plateforme http://algebrics.fr)
pour un échange inter application
......
......@@ -34,7 +34,9 @@ Le générateur surcharge la classe dbformdyn.class.php par rapport aux informat
Exemple avec concession d'openCimetiere ::
dbformdyn.class.php <- gen/obj/emplacement.class.php <-/obj/emplacement.class.php <- /obj/concession.class.php
dbformdyn.class.php
<- gen/obj/emplacement.class.php
<-/obj/emplacement.class.php <- /obj/concession.class.php
......@@ -125,6 +127,11 @@ Les méthodes principales sont les suivantes :
setOnchange : Envoi au formulaire les controles javascript à effectuer en cas de changement de données dans le champ
setGroupe : Envoi au formulaire le regroupement de champ par ligne
setRegroupe : Envoi au formulaire un fieldset
setOnkeyup
setOnclick
mail
selectiste
selectlistemulti
* des fonctions de traitement de champ heure et date::
......
......@@ -4,7 +4,7 @@
Paramétrage du framework
########################
Le paramétrage de l application se fait dans le répertoire /dyn.
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.
......@@ -62,7 +62,7 @@ conn[1] est un tableau php qui contient les parametres de connexion suivants ::
Il est possible de définir tout phptype : mysql, pgsql (postgresql), oci8 pour oracle.
Il faut voir la documentation de DB PEAR qui est le module d'abstraction utilisé
dans openMairie (version 4.0.0)
dans openMairie dans sa version actuelle
================
......@@ -175,6 +175,16 @@ Nous proposons cet exemple de code ::
Ce paramétrage va afficher "bienvenue demo" dans la page d'accueil ou
tableau de bord pour l'utilisateur "demo"
Dans lea version 4.01, tbc.inc pointe de base sur le tableau de bord
paramétrable avec des widgets (repertoire /tdb) ::
$description = _("Bienvenue ").$_SESSION["login"]."&nbsp;";
$description.= _("dans votre tableau de bord ").
"<a href='../scr/dashboard.php?edition=1'>"._("parametrable en cliquant ici")."</a>";
$f->displayDescription($description);
include ("../tdb/tdb.php");
Voir chapître : widget et tableau de bord paramétrable
==================================
......@@ -186,7 +196,7 @@ Les variables locales sont paramétrées dans le fichier *dyn/locales.inc.php*
Ce fichier contient :
- le paramétrage du codage des caracteres ::
- le paramétrage du codage des caracteres (ISO-8859-1 ou UTF8) ::
define('CHARSET', 'ISO-8859-1');
......@@ -316,13 +326,16 @@ Le mode debug d'openMairie se paramétre dans *dyn/debug.inc.php*
Ce fichier contient le paramétrage pour le mode debug
d'openMairie (om_debug.inc.php)
Valeur de la variable globale DEBUG
Valeur de la variable globale DEBUG ::
VERBOSE_MODE : mode "bavard"
dans ce mode , il est créé un fielset sous les formulaires qui indiquent
toutes les étapes de réalisation des scripts
DEBUG_MODE : mode debug
Les messages d'erreur sont visibles
PRODUCTION_MODE : mode de production (pas de message)
PRODUCTION_MODE : mode de production (il n y a pas de message)
===============================
La version de votre application
......@@ -369,18 +382,24 @@ INSTALL.txt : installation de l application
L'installation automatique
==========================
La mise en place d une installation automatique est prévue dans la version openMairie 4.0.1
La mise en place d une installation automatique est prévue dans une prochaine version openMairie.
=========================
Les paramétres des combos
=========================
Les paramétres combos sont paramétrés dans les fichiers suivants ::
Les paramétres des combos sont paramétrés dans les fichiers suivants (type de contrôle
de formulaire comboD et comboG (pour formulaire) ou comboD2 et comboG2 (pour sous formulaire) ::
- comboaffichage.inc.php
- 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
enregistrement 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 *chapître framework/formulaire, sous programme générique combo.php*
......
......@@ -46,7 +46,7 @@ Description du parametrage
La requete executée est celle qui est reconstituée avec les zones sasisies par l'utilisateur
Enfin, l utilisateur choisi soit un affichage soit en tableau, soit en csv avec un choix de séparateur.
Enfin, l'utilisateur choisit soit un affichage soit en tableau, soit en csv avec un choix de séparateur.
Il n y a pas d'outil de fabrication de requête à part l'option du générateur
(voir chapître sur le *générateur*)
......
......@@ -151,7 +151,7 @@ Pour afficher un **fieldset**, le code est le suivant ::
echo "</fieldset>
il peut être par défqut *ouvert* ::
il peut être par défaut *ouvert* ::
echo "<fieldset class= ... collapsible\">\n";
......@@ -186,7 +186,7 @@ a 0 dans openCourrier ::
* Cette page permet de remettre a 0 le registre
*
* @package openmairie_exemple
* @version SVN : $Id: xxxx.php 311 2010-12-06 11:43:36Z xxxxx $
* @version SVN : $Id: xxxx.php 311 2010-12-06 11:43:36 xxxxx $
*/
......
......@@ -98,7 +98,8 @@ type pgsql (longueur) type tableinfo si different -> type openMairie ::
Character (-1) Bpchar -> String (Utilisation de la longueur d'affichage)
Character varying (-1) Varchar -> String (Utilisation de la longueur d'affichage)
Text (-1) text -> blob (Utilisation des paramètres de form.inc)
Date (4) Date -> Date (Utilisation des paramètres de form.inc - $pgsql_longueur_date)
Date (4) Date -> Date (Utilisation des paramètres de form.inc -
$pgsql_longueur_date)
......
......@@ -58,7 +58,7 @@ Le formulaire métier auto généré, table.inc, tableform.inc est toujours coch
gen/sql/basededonnees/table.inc
sql/basededonnees/table.form.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 :
......@@ -69,3 +69,5 @@ La génération de ces 3 fichiers ne met pas en péril votre programmation qui e
sql/basededonnees/table.form.inc
basededonnees = mysql ou pgsql
\ No newline at end of file
......@@ -24,9 +24,9 @@ Deux types de formulaire sont générés : type table, type form.
Paramétres de type table :
--------------------------
- gen/sql/base/nom_table.inc
- gen/sql/basededonnees/nom_table.inc
- sql/base/nom_table.inc
- sql/basededonnees/nom_table.inc
Par défaut :
......@@ -51,9 +51,9 @@ $ico = icône par defaut
Paramétres de type Form :
-------------------------
gen/sql/base/nom_table.form.inc
gen/sql/basededonnees/nom_table.form.inc
sql/base/nom_table.form.inc
sql/basededonnees/nom_table.form.inc
Dans le fichier paramètres : form.inc
......@@ -105,80 +105,52 @@ 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
Les méthodes qui peuvent être implémentés dans obj/nom_table.class.php sont les suivantes ::
- verifier
- verifier
- regroupe et groupe pour modifier les présentations
- 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 :
Exemple ::
om_profil.class.php :
surcharge des méthodes
setValFAjout setId,
verifierAjout
et setType car la clé primaire est numérique et non automatique
om_utilisateur.class.php :
champ pwd pour mot de passe methode partiellement surchargées (parent::setvalF($val);) 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
Enfin, il est possible de mettre en place d'autres type de champs disponible dans openMairie ::
- ComboG combo gauche
- comboD combo droit
- 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 modifiable)
- 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)
- Rvb (choisir une couleur rvn avec la Palette de couleur) ...
voir framework/formulaire
......@@ -220,7 +192,7 @@ 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é secondaire (il est possible de sélectionner la requête à générer
- une requête avec un champ select pour chaque clé secondaire (il est possible de sélectionner la requête à générer)
- Les autres champs sont sélectionnés à l'affichage
......
......@@ -20,7 +20,7 @@ Form.inc
Voici les paramètres pour la génération de formulaire ::
$serie = 15; nombre d'enregistrement par page'
$ico ="../img/ico_application.png"; icone DEPRECATED ?
$ico ="../img/ico_application.png"; icone DEPRECATED
$max=6; nb de ligne blob
$taille=80; taille du blob
$pgsql_taille_defaut = 20; taille du champ par defaut si retour pg_field_prtlen =0
......
......@@ -9,11 +9,11 @@ Présentation
**L'objectif est de construire une application sur la base de l'analyse des informations du SGBD**
Les informations récupérées dans le SGBD sont les suivantes
Les informations récupérées dans le SGBD sont les suivantes ::
la liste des tables de la base de données
la liste des tables de la base de données
les tables : nom, type , et longueur de chaque champs
les tables : nom, type , et longueur de chaque champs
Le générateur construit sur cette base le modèle de données sur les principes suivants: ::
......@@ -24,17 +24,9 @@ Le générateur construit sur cette base le modèle de données sur les principe
si la clé est numérique, elle est automatique.
avec la multicollectivité, la création d'un champ « om_collectivite » met en place les accès multicollectivités d'openMairie 4
avec la multicollectivité, la création d'un champ « om_collectivite »
met en place les accès multicollectivités d'openMairie 4
La version 4.00 ne reprend pas (par rapport a la version 3): ::
l'état reprenant l'enregistrement et les sous états rattachés à l'état principal par la ou les clés secondaires
la documentation avec un lien sur les pages des tables reliées par la clé secondaire et l'option dans la documentation globale
l'option dans le menu et le tableau de bord
la prise en compte dans la recherche globale
**Les assistants vont faciliter la mise en oeuvre des états**
......
......@@ -30,7 +30,10 @@ Le chapître consacré au "générateur" décrit dans le détail le fonctionneme
de cet outil et de ses assistants.
Le chapître consacré a l' "information geographique" décrit dans le détail le
fonctionnement SIG interne d'openMairie.
fonctionnement SIG interne d'openMairie. (version 4.01)
Le chapître sur les widgets décrit le tableau de bord paramétrable et individualisé
par utilisateur (version 4.01)
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
......
......@@ -4,3 +4,6 @@
Meld
####
exemple d utilisation ::