izForm
[ class tree: izForm ] [ index: izForm ] [ all elements ]

Class: IzForm

Source Location: /izform.class.php

Class Overview


classe IzForm


Variables

Methods



Class Details

[line 54]
classe IzForm



[ Top ]


Class Variables

$elements = array()

[line 70]

Tableau contenant les éléments du formulaire



Tags:

access:  private

Type:   array


[ Top ]

$elementsHtml =

[line 62]

Chaîne de caractère contenant la sortie html du formulaire



Tags:

access:  private

Type:   string


[ Top ]

$fieldSetElements = array()

[line 86]

Tableau de 2 valeurs contenant les indices qui permettront de positionner un élément fieldset



Tags:

access:  private

Type:   array


[ Top ]

$labelMode =  'wrapp'

[line 120]

Défini la manière dont est affiché le label

Par défaut, vaut 'wrapp' : le label englobe l'élément de formulaire Autre valeur possible : 'nowrapp' : le label est refermé avant l'élément de formulaire



Type:   string


[ Top ]

$optGroupElements = array()

[line 94]

Tableau de 2 valeurs contenant les indices qui permettront de positionner un élément optgroup dans une liste déroulante



Tags:

access:  private

Type:   array


[ Top ]

$selectElements = array()

[line 78]

Tableau contenant les éléments à charger dans une liste déroulante



Tags:

access:  private

Type:   array


[ Top ]

$submittedData = array()

[line 102]

Tableau qui est la copie du tableau superglobal correspond à la méthode employée pour soumettre le formulaire



Tags:

access:  public

Type:   array


[ Top ]

$verifData = array()

[line 110]

Tableau des valeurs à contrôler une fois le formulaire soumis



Tags:

access:  private

Type:   array


[ Top ]



Class Methods


constructor IzForm [line 138]

IzForm IzForm( [string $method = 'post'], [string $action = ''], [string $id = 'form1'], [int $enctype = 1])

Constructeur de la classe

Défini le script cible du formulaire, la méthode par laquelle il est soumis et quel est le type d'encryption de celui-ci Le constructeur enregistre la balise d'ouverture du formulaire, copie dans la variable de classe $submittedData le bon tableau superglobal en fonction de la méthode employée pour envoyer le formulaire




Tags:

access:  public


Parameters:

string   $method   methode par laquelle est soumis le formulaire. Peut prendre les valeurs 'post' ou 'get' ('post' par defaut)
string   $action   script cible du formulaire. Si $action n'est pas spécifiée elle prend pour valeur le script même qui contient le formulaire
string   $id   identifiant du formulaire. Prend 'form1' par défaut
int   $enctype   type d'encryption du formulaire (0: multipart/form-data, 1: application/x-www-form-urlencoded)

[ Top ]

method addCheckBox [line 272]

void addCheckBox( string $name, string $label, string $value, [boolen $check = 0], [string $id = ''], [string $before = ''], [string $after = ''], [string $elem_attributes = ''], [string $lbl_attributes = ''])

Ajoute un element de type input type="checkbox" au formulaire



Tags:

access:  public


Parameters:

string   $name   nom de l'élément checkbox
string   $label   label de l'élément checkbox : texte place après l'élement pour l'identifier
string   $value   valeur de l'élément checkbox
boolen   $check   valeur par défaut de l'état de la case à cocher (0 = non cochée, 1 = cochée)
string   $id   identifiant de l'élément checkbox. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant l'élément checkbox. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant l'élément checkbox. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label de l'élément checkbox pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés à l'élément checkbox pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addDataInSelect [line 569]

void addDataInSelect( string $value, string $label)

Ajoute un élément '<option></option> dans une liste déroulante Charge la paire valeur/label dans la liste deroulante

addDataInSelect précharge en fait les données qui seront dans la liste déroulante Il faut donc précharger toutes les valaurs que l'on souhaite pour la liste avant d'ajouter celle-ci avec la méthode addSelect()




Tags:

access:  public


Parameters:

string   $value   valeur de l'attribut 'value' de la balise 'option'
string   $label   texte visible de l'element option de la liste deroulante

[ Top ]

method addDataToVerif [line 1156]

void addDataToVerif( string $name, string $dataType, [string $option = ''])

Ajoute une valeur soumise à la liste de celles à vérifier

Permet de définir les variables à tester parmis celles présentent dans le formulaire en précisant le type de vérification




Tags:

access:  public


Parameters:

string   $name   nom de l'élément à vérifier
string   $dataType   type de vérification à effectuer sur cet élément. Voir la méthode verifyData() pour la liste des types
string   $option   options possibles à passer pour le type de vérification à effectuer

[ Top ]

method addFieldSet [line 751]

void addFieldSet( [string $legend = ''], [string $elem_attributes = ''])

Ajoute un fieldset après avoir défini ses bornes avec la méthode setFieldSetLimiters()



Tags:

access:  public


Parameters:

string   $legend   légende associée au fieldset
string   $elem_attributes   attributs pouvant être ajoutés au fieldset pour les css (class, id ou style inline) ou du javascript

[ Top ]

method addFile [line 446]

void addFile( string $name, [string $label = ''], [string $id = ''], [string $before = ''], [string $after = ''], [string $lbl_attributes = ''], [string $elem_attributes = ''])

Ajoute un element de type input type="file" au formulaire



Tags:

access:  public


Parameters:

string   $name   nom du bouton parcourir pour joindre un fichier
string   $label   label du bouton parcourir : texte place devant le bouton pour l'identifier
string   $id   identifiant du bouton parcourir. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant le bouton parcourir. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant le bouton parcourir. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label du bouton parcourir pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés au bouton parcourir pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addHidden [line 482]

void addHidden( string $name, string $value)

Ajoute un element de type input type="hidden" au formulaire



Tags:

access:  public


Parameters:

string   $name   nom du champ caché
string   $value   valeur du champ caché

[ Top ]

method addMsgAtTop [line 1128]

void addMsgAtTop( string $msg, [$container $container = 'p'], [$elem_attributes $elem_attributes = ''])

Ajoute un message en début du formulaire dans un paragraphe

Peut être utilisé pour des messages d'erreur par exemple




Tags:

access:  public


Parameters:

string   $msg   message à afficher
$container   $container   balise contenant le message. Peut prendre les valeurs 'p' pour un paragraphe ou 'd' pour une div. Vaut 'p' par défaut
$elem_attributes   $elem_attributes   attributs pouvant être ajoutés à la balise du message pour les css (class, id ou style inline) ou du javascript

[ Top ]

method addOptGroup [line 628]

void addOptGroup( string $label)

Ajoute la balise '<optgroup>' après avoir défini ses bornes



Tags:

access:  public


Parameters:

string   $label   label de la balise <optgroup>

[ Top ]

method addParagraph [line 545]

void addParagraph( string $value, [string $elem_attributes = ''])

Ajoute un paragraphe de texte dans le formulaire



Tags:

access:  public


Parameters:

string   $value   texte du paragraphe
string   $elem_attributes   attributs pouvant être ajoutés au paragraphe pour les css (class, id, style inline)

[ Top ]

method addPassword [line 226]

void addPassword( string $name, [string $label = ''], [string $value = ''], [int $size = ''], [int $maxlength = ''], [string $id = ''], [string $before = ''], [string $after = ''], [string $elem_attributes = ''], [string $lbl_attributes = ''])

Ajoute un element de type input type="password" au formulaire



Tags:

access:  public


Parameters:

string   $name   nom du champs password
string   $label   label du champs password: texte place devant le champ pour l'identifier
string   $value   valeur du champs password
int   $size   taille du champs password
int   $maxlength   taille maximale du champs password
string   $id   identifiant du champs password. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant le champs password. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant le champs password. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label du champs password pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés au champs password pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addRadio [line 317]

void addRadio( string $name, string $label, string $value, [boolen $check = 0], [string $id = ''], [string $before = ''], [string $after = ''], [string $elem_attributes = ''], [string $lbl_attributes = ''])

Ajoute un element de type input type="radio" au formulaire



Tags:

access:  public


Parameters:

string   $name   nom de l'élément radio
string   $label   label de l'élément radio : texte place après l'élement pour l'identifier
string   $value   valeur de l'élément radio
boolen   $check   valeur par défaut de l'état du bouton radio (0 = non coché, 1 = coché)
string   $id   identifiant de l'élément radio. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant l'élément radio. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant l'élément radio. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label de l'élément radio pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés à l'élément radio pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addReset [line 404]

void addReset( string $value, [string $name = ''], [string $label = ''], [string $id = ''], [string $before = ''], [string $after = ''], [string $lbl_attributes = ''], [string $elem_attributes = ''])

Ajoute un element de type input type="reset" au formulaire



Tags:

access:  public


Parameters:

string   $value   valeur du bouton reset (texte affiché sur le bouton)
string   $name   nom du bouton reset
string   $label   label du bouton reset : texte place devant le bouton pour l'identifier
string   $id   identifiant du bouton reset. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant le bouton reset. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant le bouton reset. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label du bouton reset pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés au bouton reset pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addSelect [line 666]

void addSelect( string $name, [string $label = ''], [string $selected = ''], [string $id = ''], [int $size = '1'], [mixed $multiple = '0'], [string $before = ''], [string $after = ''], [string $lbl_attributes = ''], [string $elem_attributes = ''])

Ajoute une liste deroulante au formulaire

Vous devez tout d'abord charger les elements constituants la liste avec les méthodes addDataInSelect(), setOptGroupLimiters() et addOptGroup() Une fois la liste ajoutée, le tableau des éléments qui ont été préchargés est vidé




Tags:

access:  public


Parameters:

string   $name   nom de la liste déroulante
string   $label   label de la liste deroulante: texte placé devant pour l'identifier
string   $selected   indique l'élément de la liste déroulante séléctionné par defaut. Correspond à l'attribut 'value' de la balsie '<option>'
string   $id   identifiant unique de la liste déroulante
int   $size   nombre de lignes visibles de la liste déroulante. Vaut 1 par defaut
string   $before   élement ouvrant encadrant laliste déroulante. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant la liste déroulante. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label de la liste déroulante pour les css (class, id ou style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés à la liste déroulante pour les css (class, id ou style inline) ou du javascript

[ Top ]

method addSubmit [line 361]

void addSubmit( string $value, [string $name = ''], [string $label = ''], [string $id = ''], [string $before = ''], [string $after = ''], [string $lbl_attributes = ''], [string $elem_attributes = ''])

Ajoute un element de type input type="submit" au formulaire



Tags:

access:  public


Parameters:

string   $value   valeur du bouton submit (texte affiché sur le bouton)
string   $name   nom du bouton submit
string   $label   label du bouton submit : texte place devant le bouton pour l'identifier
string   $id   identifiant du bouton submit. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant le bouton submit. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant le bouton submit. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label du bouton submit pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés au bouton submit pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addText [line 179]

void addText( string $name, [string $label = ''], [string $value = ''], [int $size = ''], [int $maxlength = ''], [string $id = ''], [string $before = ''], [string $after = ''], [string $elem_attributes = ''], [string $lbl_attributes = ''])

Ajoute un element de type input type="text" au formulaire



Tags:

access:  public


Parameters:

string   $name   nom du champs texte
string   $label   label du champs texte: texte placé devant le champ pour l'identifier
string   $value   valeur du champs texte
int   $size   taille du champs texte
int   $maxlength   taille maximale du champs texte
string   $id   identifiant du champs texte. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant le champs texte. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant le champs texte. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label du champs texte pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés au champs texte pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method addTextArea [line 506]

void addTextArea( string $name, int $rows, int $cols, [string $label = ''], [string $value = ''], [string $id = ''], [string $before = ''], [string $after = ''], [string $lbl_attributes = ''], [string $elem_attributes = ''])

Ajoute un element de type textarea au formulaire



Tags:

access:  public


Parameters:

string   $name   nom de la zone de texte
int   $rows   nombre de lignes de la zone de texte
int   $cols   nombre de colonnes de la zone de texte
string   $label   label de la zone de texte : texte place devant cette zone pour l'identifier
string   $value   valeur de la zone de texte
string   $id   identifiant unique de la zone de texte. Si n'est pas affecté, prend la valeur de $name
string   $before   élement ouvrant encadrant la zone de texte. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $after   élement fermant encadrant la zone de texte. Peut prendre 3 valeurs : P (paragraphe), D (div) ou B (espace). Vaut P par défaut
string   $lbl_attributes   attributs pouvant être ajoutés au label de la zone de texte pour les css (class, id, style inline) ou du javascript
string   $elem_attributes   attributs pouvant être ajoutés à la zone de texte pour les css (class, id, style inline) ou du javascript ou autre

[ Top ]

method displayForm [line 793]

void displayForm( )

Affiche le formulaire

Cette méthode ajoute le dernier élément au formulaire (balise de fermeture de celui-ci) puis va faire générer la sortie html pour chaque élément avant de l'afficher




Tags:

access:  public


[ Top ]

method isSubmitted [line 1100]

boolen isSubmitted( )

Spécifie si le formulaire a été envoyé ou non



Tags:

return:  renvoi vrai si le formulaire a été soumis, falsse sinon
access:  public


[ Top ]

method isValidData [line 1174]

boolean isValidData( )

Vérifie les variables spécifiées par la méthode addDataToVerif()



Tags:

return:  Renvoi vrai si les données sont valides, faux sinon
access:  public


[ Top ]

method manageSubmittedData [line 1114]

void manageSubmittedData( )

Effectue un traitement sur les valeurs soumises du formulaire



Tags:

access:  private


[ Top ]

method resetDataInSelect [line 705]

void resetDataInSelect( )

Vide la liste des éléments à charger dans une liste déroulante



Tags:

access:  private


[ Top ]

method setElement [line 782]

void setElement( array $res)

Ajoute un élément de formulaire dans le tableau elements[] qui les contient tous



Tags:

access:  private


Parameters:

array   $res   tableau contenant les paramètres d'un élément de formulaire à ajouter

[ Top ]

method setElementHtml [line 812]

void setElementHtml( array $res)

Génère la sortie html pour les éléments de formulaire

Stock la sortie html dans la chaine elementsHtml




Tags:

access:  private


Parameters:

array   $res   tableau contenant les paramètres d'un élement de formulaire

[ Top ]

method setFieldSetLimiters [line 718]

void setFieldSetLimiters( string $start, string $end)

Défini les limites pour mettre un élément fieldset dans le formulaire

Cette méthode défini les bornes parmi les éléments du formulaire




Tags:

access:  public


Parameters:

string   $start   élement de début. Correspond à l'attribut $name du premier élément qui sera dans l'optgroup
string   $end   élement de fin. Correspond à l'attribut $name du dernier élément qui sera dans l'optgroup

[ Top ]

method setLabelMode [line 1225]

void setLabelMode( string $mode)

Modifie le type de mise en page du label avec l'élément de formulaire auquel il est associé



Tags:

access:  public


Parameters:

string   $mode   type d'affichage : 'wrapp' ou 'nowrapp'

[ Top ]

method setOptGroupLimiters [line 596]

void setOptGroupLimiters( string $start, string $end)

Défini les limites pour mettre des éléments '<option>' d'une liste déroulante dans une balsie '<optgroup>'

Cette méthode défini les bornes parmi les éléments déjà préchargés par la méthode addDataInSelect()




Tags:

access:  public


Parameters:

string   $start   élement de début. Correspond à l'attribut $value du premier élément qui sera dans l'optgroup
string   $end   élement de fin. Correspond à l'attribut $value du dernier élément qui sera dans l'optgroup

[ Top ]

method setSelectElement [line 583]

void setSelectElement( array $res)

Ajoute un élément dans le tableau selectElement[], tableau de préchargement des éléments pour une lsite déroulante



Tags:

access:  private


Parameters:

array   $res   tableau associatif contenu la valeur et le label de la balise '<option>' à rajouter à la liste déroulante

[ Top ]


Documentation generated on Wed, 29 Dec 2004 14:09:28 +0100 by phpDocumentor 1.3.0RC3