Référence de la classe formulaire

Graphe d'héritage de formulaire:

Graphe de collaboration de formulaire:

Fonctions membres publiques
	__construct ()
	__construct ()
	champs_obligatoires ($bCalc=false)
	charge_data ($bLibelles=true)
	charge_data ()
	charger ()
	charger ()
	traiter ()
	verifier ()
	verifier ()

Attributs publics
	$VarCal
const	DBG = false
const	DBG_CHARGER = false

Fonctions membres protégées
	afficher_result ()
	calculer ()
	get_champs_libelles ()
	get_environnement ()
	get_result_table ($tContent, $tEntetes=false)
	getGraph ($sLibVar, $LibCal, $tAbs, $tRes)

Attributs protégés
	$bFVC = true
	$champs
	$champs_fvc
	$data
	$nb_col
	$nbPas = 15
	$oLog
	$result
	$saisies
	$sVarCal =''

Fonctions membres privées
	champs_obligatoires ($bCalc=false)
	get_champs ()
	get_champs ()
	get_champs_fvc ()
	get_champs_fvc ()

Attributs privés
	$bNoCache = true

Description détaillée

Définition à la ligne 8 du fichier formulaire.abstract.class.php.

Documentation des constructeurs et destructeur

__construct() [1/2]

formulaire::__construct

(

)

Définition à la ligne 59 du fichier formulaire.abstract.class.php.

Références get_champs(), et get_champs_fvc().

Voici le graphe d'appel pour cette fonction :

__construct() [2/2]

formulaire::__construct

(

)

Définition à la ligne 30 du fichier formulaire.class.php.

Références get_champs(), et get_champs_fvc().

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

afficher_result()

formulaire::afficher_result ( )

protected

Définition à la ligne 357 du fichier formulaire.abstract.class.php.

Références $data, format_nombre(), get_champs_libelles(), get_result_table(), et getGraph().

Référencé par traiter().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

calculer()

formulaire::calculer ( )

abstractprotected

Référencé par traiter().

Voici le graphe des appelants de cette fonction :

champs_obligatoires() [1/2]

formulaire::champs_obligatoires

(

$bCalc = false

)

Définition à la ligne 62 du fichier formulaire.class.php.

Références $champs, et $champs_fvc.

champs_obligatoires() [2/2]

formulaire::champs_obligatoires (   $bCalc = false )

private

Définition à la ligne 103 du fichier formulaire.abstract.class.php.

Références $champs, et $champs_fvc.

Référencé par charge_data().

Voici le graphe des appelants de cette fonction :

charge_data() [1/2]

formulaire::charge_data

(

$bLibelles = true

)

Charge les données d'un formulaire avec choix des variables fixées, qui varient et à calculer.

Paramètres

$bLibelles

Remplit la clé tlib avec les libellés traduits des variables

Renvoie

un tableau avec les clés suivantes:

• Couples clés/valeur des champs du formulaire
• iPrec : nombre de décimales pour la précision des calculs
• tLib: tableau avec couples clés/valeurs des libellés traduits des champs du formulaire
• sLang : la langue en cours
• CacheFileName : Le nom du fichier de cache
• min, max, pas : resp. le min, le max et le pas de variation de la variable qui varie
• i : pointeur vers la variable qui varie
• ValCal : Nom de la variable à calculer
• ValVar : Nom de la variable qui varie

Auteur

David Dorchies

Date

Juillet 2012

Définition à la ligne 149 du fichier formulaire.class.php.

Références $data, et champs_obligatoires().

Voici le graphe d'appel pour cette fonction :

charge_data() [2/2]

formulaire::charge_data

(

)

Définition à la ligne 200 du fichier formulaire.abstract.class.php.

Références $data, et champs_obligatoires().

Référencé par verifier().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

charger() [1/2]

formulaire::charger

(

)

Définition à la ligne 102 du fichier formulaire.class.php.

Références $champs_fvc, $nb_col, $saisies, $sVarCal, et get_environnement().

Voici le graphe d'appel pour cette fonction :

charger() [2/2]

formulaire::charger

(

)

Définition à la ligne 144 du fichier formulaire.abstract.class.php.

Références $champs_fvc, $nb_col, $nbPas, $saisies, et $sVarCal.

get_champs() [1/2]

formulaire::get_champs ( )

private

Définition à la ligne 51 du fichier formulaire.class.php.

Références $champs.

get_champs() [2/2]

formulaire::get_champs ( )

private

Définition à la ligne 88 du fichier formulaire.abstract.class.php.

Références $champs.

Référencé par __construct().

Voici le graphe des appelants de cette fonction :

get_champs_fvc() [1/2]

formulaire::get_champs_fvc ( )

private

Définition à la ligne 38 du fichier formulaire.class.php.

Références $champs.

get_champs_fvc() [2/2]

formulaire::get_champs_fvc ( )

private

Définition à la ligne 72 du fichier formulaire.abstract.class.php.

Références $champs.

Référencé par __construct().

Voici le graphe des appelants de cette fonction :

get_champs_libelles()

formulaire::get_champs_libelles ( )

protected

Définition à la ligne 340 du fichier formulaire.abstract.class.php.

Référencé par afficher_result().

Voici le graphe des appelants de cette fonction :

get_environnement()

formulaire::get_environnement ( )

abstractprotected

Référencé par charger().

Voici le graphe des appelants de cette fonction :

get_result_table()

formulaire::get_result_table (   $tContent,   $tEntetes = false  )

protected

Définition à la ligne 452 du fichier formulaire.abstract.class.php.

Référencé par form_calcul_section\afficher_result(), et afficher_result().

Voici le graphe des appelants de cette fonction :

getGraph()

formulaire::getGraph (   $sLibVar,   $LibCal,   $tAbs,   $tRes  )

protected

Affichage du graphique de la variable calculée.

Paramètres

$sLibVar	Libellé de la variable variée
$sLibCal	Libellé de la variable calculée
$tAbs	Vecteur des abscisses
$tRes	Vecteur des valeurs calculées

Définition à la ligne 431 du fichier formulaire.abstract.class.php.

Référencé par form_courbe_remous\afficher_result(), et afficher_result().

Voici le graphe des appelants de cette fonction :

traiter()

formulaire::traiter

(

)

Définition à la ligne 317 du fichier formulaire.abstract.class.php.

Références afficher_result(), calculer(), et ReadCacheFile().

Voici le graphe d'appel pour cette fonction :

verifier() [1/2]

formulaire::verifier

(

)

Vérification des données transmises et génération des messages d'erreur pour le formulaire.

Note

Il faut l'utiliser après un appel à charge_data

Définition à la ligne 217 du fichier formulaire.class.php.

verifier() [2/2]

formulaire::verifier

(

)

Définition à la ligne 263 du fichier formulaire.abstract.class.php.

Références charge_data().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

$bFVC

formulaire::$bFVC = true

protected

Formulaire FVC (boutons fixe, varie, calcul)

Définition à la ligne 48 du fichier formulaire.abstract.class.php.

$bNoCache

formulaire::$bNoCache = true

private

Utilisation du cache pour ne pas refaire les calculs (true pour débugage)

Définition à la ligne 44 du fichier formulaire.abstract.class.php.

$champs

formulaire::$champs

protected

Liste des codes de champs du formulaire.

Définition à la ligne 32 du fichier formulaire.abstract.class.php.

Référencé par champs_obligatoires(), get_champs(), et get_champs_fvc().

$champs_fvc

formulaire::$champs_fvc

protected

Liste des codes de champs du formulaire avec bouton radio.

Définition à la ligne 31 du fichier formulaire.abstract.class.php.

Référencé par champs_obligatoires(), et charger().

$data

formulaire::$data

protected

Données du formulaire.

Définition à la ligne 33 du fichier formulaire.abstract.class.php.

Référencé par afficher_result(), et charge_data().

$nb_col

formulaire::$nb_col

protected

Nombre de colonnes du tableau du formulaire (2,4 ou 5)

Définition à la ligne 36 du fichier formulaire.abstract.class.php.

Référencé par charger().

$nbPas

formulaire::$nbPas = 15

protected

Nombre de pas de variation par défaut.

Définition à la ligne 47 du fichier formulaire.abstract.class.php.

Référencé par charger().

$oLog

formulaire::$oLog

protected

Journal de calcul.

Définition à la ligne 43 du fichier formulaire.abstract.class.php.

Référencé par form_courbe_remous\calculer().

$result

formulaire::$result

protected

Résultats du calcul - tableau associatif contenant :

• 'abs' => Vecteur de la donnée qui varie (abscisse)
• 'res' => Vecteur du résultat du calcul (ordonnée)
• 'flag' => Vecteur du flags d'écoulement pour les ouvrages (facultatif)
• Plus d'autres qui peuvent être définies et utilisées par la méthode 'afficher' des classes filles

Définition à la ligne 42 du fichier formulaire.abstract.class.php.

$saisies

formulaire::$saisies

protected

Debuggage de la methode charger.

Structure du formulaire qui contient un tableau avec les regroupements de champs (fieldset).

Dans un fieldset, on a :

• 0 : identifiant utilisé sur l'élément id (qui sera suivi de "_fs')
• 1 : tableau contenant la description des champs, pour chaque champ, on a une clé correspondant au code du champ (name) et un tableau avec :
  • 0 : code de langue du libellé du champ
  • 1 : valeur par défaut du champ ou chaîne commençant par "form_" donnant le nom du squelette à charger dans le répertoire "hyd_inc" du plugin
  • 3 : Codes de contrôle qui signifient :
    • o : Champ obligatoire (une valeur différente de "" est exigée)
    • p : Valeur strictement positive exigée
    • n : Valeur nulle acceptée (à associer systématiquement avec p)
    • s : chaîne de caractère acceptée (Une valeur numérique est exigée sinon)
• 2 : Type de fieldset :
  • fix : Valeur fixe uniquement (pas de boutons radios)
  • var : Valeur fixe ou valeur variable
  • cal : var + valeur à calculer

Définition à la ligne 30 du fichier formulaire.abstract.class.php.

Référencé par charger().

$sVarCal

formulaire::$sVarCal =''

protected

Nom du champ à calculer par défaut.

Champ à calculer par défaut.

Définition à la ligne 34 du fichier formulaire.abstract.class.php.

Référencé par charger().

$VarCal

formulaire::$VarCal

Pointeur vers la variable de section qui sera calculée.

Définition à la ligne 35 du fichier formulaire.abstract.class.php.

DBG

const formulaire::DBG = false

Définition à la ligne 10 du fichier formulaire.abstract.class.php.

DBG_CHARGER

const formulaire::DBG_CHARGER = false

Debuggage de la classe et des classes filles.

Définition à la ligne 11 du fichier formulaire.abstract.class.php.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• formulaire.abstract.class.php
• formulaire.class.php