Référence de la classe Form

Classe representant un formulaire. La classe gère la génération du formulaire. Plus de détails...

Graphe d'héritage de Form:

Fonctions membres publiques
	__construct ($u_id='', $u_boutons=7, $u_classe='cssform')
	Constructeur qui permet d'initialiser les données.
	setBtn ($u_boutons)
	Cette méthode permet d'indiquer quels boutons seront ajoutés en fin de formulaire indique si présence boutons en fin de formulaire.
	setTxtBtn ($chaine)
	Cette méthode permet de personnaliser le texte (la valeur) du bouton 'Perso'.
	setAction ($chaine)
	Cette méthode permet de mettre à jour l'attribut action de la balise 'form'.
	getAction ()
	Cette méthode permet d'obtenir l'attribut action de la balise 'form'.
	addScript ($objet, $evenement, $fonction)
	Cette méthode permet d'ajouter un JS exécuté sur un évenement particulier.
	addVerif ()
	Cette méthode permet d'ajouter une vérification qui sera réalisée sur màj des champs (par l'utilisateur) ou avant soumission du formulaire.
	verifForm ($premiereFois='silence')
	Méthode appelée pour vérifier si les champs sont renseignés correctement.
	render ()
	Cette méthode renvoie une chaine de caractères contenant le formulaire généré

---

Description détaillée

Classe representant un formulaire. La classe gère la génération du formulaire.

Définition à la ligne 534 du fichier clVerifForm.php.

---

Documentation des constructeurs et destructeur

__construct	(	$	u_id = '',
		$	u_boutons = 7,
		$	u_classe = 'cssform'
	)

Constructeur qui permet d'initialiser les données.

Paramètres:

$u_id	contient l'id du formulaire (cf. setId)
$u_classe	contient une chaine de caractères (liste de styles CSS) (cf. setClasse)
$u_boutons	indique si on ajoute (ou non) des boutons en fin de formulaire (cf. setBtn)

Définition à la ligne 573 du fichier clVerifForm.php.

---

Documentation des fonctions membres

addScript	(	$	objet,
		$	evenement,
		$	fonction
	)

Cette méthode permet d'ajouter un JS exécuté sur un évenement particulier.

Paramètres:

$objet	Un des champs contenu dans ce conteneur. Aucune vérification ne sera effectuée !
$evenement	Chaine de caractères (ex. 'change', 'click', 'blur', ...)
$fonction	Code du JS à exécuter sur l'événement concerné

Attention:

Cette fonction, n'a pas été adaptée aux objets de type 'Boutons' $objet->getId() retourne tous les 'id' séparés par des espaces (cf. 'getId')

A faire:

Il aurait été plus 'élégant' d'implémenter cette méthode au niveau des champs plutôt qu'au niveau du formulaire ! (11/11/2011)

Définition à la ligne 634 du fichier clVerifForm.php.

addVerif

(

)

Cette méthode permet d'ajouter une vérification qui sera réalisée sur màj des champs (par l'utilisateur) ou avant soumission du formulaire.

Pour plus d'info, consulter les différents exemples : http://synanceia.free.fr/phpjsvform

Définition à la ligne 646 du fichier clVerifForm.php.

setAction

(

$

chaine

)

Cette méthode permet de mettre à jour l'attribut action de la balise 'form'.

Paramètres:

$chaine

Valeur de l'attribut

Renvoie:

L'instance appelant la méthode ($this)

Définition à la ligne 611 du fichier clVerifForm.php.

setBtn

(

$

u_boutons

)

Cette méthode permet d'indiquer quels boutons seront ajoutés en fin de formulaire indique si présence boutons en fin de formulaire.

• 0 = pas de bouton ;
• 1 = bouton "Valider" uniquement
• 2 = bouton "Effacer" ; 3 = les 2 boutons
• 4 = bouton "Réinitialiser" ; 7 = les 3 boutons (valeur par défaut)
• 8 = bouton "Perso" (* Ajout du 29/07/2011 *)

Définition à la ligne 589 du fichier clVerifForm.php.

setTxtBtn

(

$

chaine

)

Cette méthode permet de personnaliser le texte (la valeur) du bouton 'Perso'.

Date:

29/07/2011

Paramètres:

$chaine

Texte à afficher sur le bouton

Renvoie:

L'instance appelant la méthode ($this)

Définition à la ligne 600 du fichier clVerifForm.php.

verifForm

(

$

premiereFois = 'silence'

)

Méthode appelée pour vérifier si les champs sont renseignés correctement.

Avertissement:

Cette méthode doit être appelée avant d'afficher le formulaire.

Paramètres:

$premiereFois

Paramètre facultatif permettant de préciser comment cette méthode doit s'éxécuter si le formulaire est chargé pour la première fois (ou s'il est réinitialisé) 'non' : la méthode n'est éxécutée que si le formulaire a été soumis par l'utilisateur 'silence' : par défaut, les champs sont mis à jour sans qu'aucune information soit ajoutée sur le formulaire Autres cas : si des champs sont mis à jour, alors des informations seront ajoutées au début du formulaire.

A faire:

Le cas des boutons (ensemble de...) n'a pas été traité, à faire ?

Définition à la ligne 687 du fichier clVerifForm.php.

Voici le graphe d'appel pour cette fonction :

---

La documentation de cette classe a été générée à partir du fichier suivant :

• phpJSvForm/form/clVerifForm.php