API Documentation
\
Helper

\AcidForm

Outil AcidForm, Gestionnaire de formulaire

Summary

Methods
Properties
Constants
__construct()
setFormId()
setFormClass()
setFormParams()
getParams()
hidden()
text()
password()
checkbox()
radio()
textarea()
select()
file()
button()
submit()
image()
hourHI()
dateYMD()
tableStart()
tableStop()
setFileTranfer()
addBodyAttributes()
addFreeText()
addHidden()
addText()
addPassword()
addCheckbox()
addRadio()
addTextarea()
addSelect()
addFile()
addButton()
addSubmit()
addImage()
getComponent()
html()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
addComponent()
$_html
$_method
$_action
$_id
$_classname
$_file_transfer
$_form_params
$_components
N/A

Properties

$_html

$_html : float

Type

float — version html

$_method

$_method : string

Type

string — méthode du formulaire (post, get)

$_action

$_action : string

Type

string — url d'action du formulaire

$_id

$_id : string

Type

string — id du formulaire

$_classname

$_classname : string

Type

string — class du formulaire

$_file_transfer

$_file_transfer : boolean

Type

boolean — true si le formulaire gère les fichiers

$_form_params

$_form_params : array

Type

array — attributs du formulaire

$_components

$_components : array

Form components

Type

array — éléments du formulaire

Methods

__construct()

__construct(string  $method, string  $action, float  $version = null)

Constructeur AcidForm

Parameters

string $method

Type de formulaire. (Get/Post)
string $action

Cible du formulaire.
float $version

version html.

setFormId()

setFormId(string  $id)

Définit l'identifiant DOM du formulaire.

Parameters

string $id

setFormClass()

setFormClass(string  $classname)

Définit la classe CSS du formulaire.

Parameters

string $classname

setFormParams()

setFormParams(array  $params)

Assigne des attributs au formulaire Si un attribut est déjà défini, écrase l'ancienne valeur.

Parameters

array $params

Liste des attributs. ([paramètres]=>[valeurs])

getParams()

getParams(array  $params) : string

Retourne les paramètres du tableau en entrée sous forme d'une chaîne de caractères au format "Attribut HTML".

Parameters

array $params

Liste des paramètres.

Returns

string

hidden()

hidden(string  $name, string  $value, array  $params = array()) : string

Retourne une entrée formulaire de type hidden.

Parameters

string $name

Nom.
string $value

Valeur.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : arrray()

Returns

string

text()

text(string  $name, string  $value, string  $size = null, string  $maxlength = null, array  $params = array()) : string

Retourne une entrée formulaire de type text.

Parameters

string $name

Nom.
string $value

Valeur.
string $size

Taille du champ. - Défaut : NULL
string $maxlength

Nombre de caractères maximum. - Défaut : NULL
array $params

Liste des paramètes. ([paramètres]=>[valeurs]) - Défaut : array()

Returns

string

password()

password(string  $name, string  $value, string  $size = null, string  $maxlength = null, array  $params = array()) : string

Retourne une entrée formulaire de type password.

Parameters

string $name

Nom.
string $value

Valeur.
string $size

Taille du champ. - Défaut : NULL
string $maxlength

Nombre de caractères maximum. - Défaut : NULL
array $params

Liste des paramètes. ([paramètres]=>[valeurs]) - Défaut : array()

Returns

string

checkbox()

checkbox(string  $name, string  $value, boolean  $checked, string  $label = null, array  $params = array()) : string

Retourne une entrée de type checkbox.

Parameters

string $name

Nom.
string $value

Valeur.
boolean $checked

True si selectionné, false sinon.
string $label

intitulé de la checkbox
array $params
  • Défaut : array()

Returns

string

radio()

radio(string  $name, string  $value, array  $elts, array  $params = array()) : string

Retourne une entrée formulaire de type radio.

Parameters

string $name

Nom.
string $value

Valeur selectionnée.
array $elts

Liste des éléments du radio. ([noms]=>[valeurs])
array $params
  • Défaut : array()

Returns

string

textarea()

textarea(string  $name, string  $value, integer  $cols = 80, integer  $rows = 5, array  $params = array()) : string

Retourne une entrée formulaire de type textarea.

Parameters

string $name

Nom.
string $value

Valeur.
integer $cols

Largeur. - Défaut : 80
integer $rows

Hauteur. - Défaut : 5
array $params
  • Défaut : array()

Returns

string

select()

select(string  $name, string  $value, array  $elts, array  $params = array(), integer  $size, boolean  $multiple = false) : string

Retourne une entrée formulaire de type select.

Parameters

string $name

Nom.
string $value

Valeur.
array $elts

Liste des options du select.
array $params

Liste des paramètres. - Défaut : array()
integer $size

Taille de la liste. Si 0, on prend le nombre d'élément. - Défaut : 0
boolean $multiple

Si true, on autorise la selection multiple. - Défaut : false

Returns

string

file()

file(string  $name, array  $params = array()) : string

Retourne une entrée formulaire de type file.

Parameters

string $name

Nom.
array $params

Liste des paramètres. - Défaut : array()

Returns

string

button()

button(string  $name, string  $value, array  $params = array()) : string

Retourne une entrée formulaire de type button.

Parameters

string $name

Nom.
string $value

Valeur.
array $params

Liste des paramètres. - Défaut : array()

Returns

string

submit()

submit(string  $value, string  $params = array()) : string

Retourne une entrée formulaire de type submit.

Parameters

string $value

Valeur.
string $params

Liste des paramètres. - Défaut : array()

Returns

string

image()

image(string  $src, string  $value, string  $params = array()) : string

Retourne une entrée formulaire de type image.

Parameters

string $src

url de l'image.
string $value

Valeur.
string $params

Liste des paramètres. - Défaut : array()

Returns

string

hourHI()

hourHI(string  $key, string  $atime = '00:00', integer  $step = 1) : string

Retourne un couple d'entrées select, permettant de renseigner une heure.

Parameters

string $key

Prefixe pour les noms. ([$key]_h, [$key]_i)
string $atime

Heure selectionnée. - Défaut : 00:00
integer $step

Pas pour l'incrémentation des minutes. - Défaut : 1

Returns

string

dateYMD()

dateYMD(string  $key, string  $adate = '0000-00-00',   $min_year = null,   $max_year = null) : string

Retourne un triplet d'entrées select, permettant de renseigner une date.

Parameters

string $key

Prefixe pour les noms. ([$key]_d, [$key]_m,[$key]_y)
string $adate

Date selectionnée. - Défaut : 0000-00-00
$min_year
$max_year

Returns

string

tableStart()

tableStart(array  $params = array())

Ajoute l'ouverture d'un tableau au formulaire.

Parameters

array $params

Liste des paramètres. ([paramètres]=>[valeurs])

tableStop()

tableStop()

Ajoute la fermeture d'un tableau au formulaire.

setFileTranfer()

setFileTranfer(boolean  $val)

Définit si le formulaire est multipart

Parameters

boolean $val

addBodyAttributes()

addBodyAttributes(string  $name, array  $attr = array())

Ajoute des attributs HTML à la ligne contenant

Parameters

string $name

identifiant du champs
array $attr

les attributs

addFreeText()

addFreeText(string  $label, string  $text, array  $params = array(), array  $body_attrs = array(), string  $name = null)

Ajoute du texte libre au formaulire.

Parameters

string $label

Etiquette.
string $text

Texte.
array $params

Liste des paramètres. ([paramètres]=>[valeurs])
array $body_attrs

attributs du cadre
string $name

identifiant

addHidden()

addHidden(string  $label, string  $name, string  $value, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée hidden au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addText()

addText(string  $label, string  $name, string  $value, string  $size = null, string  $maxlength = null, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée texte au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur.
string $size

Taille du champ. - Défaut : NULL
string $maxlength

Nombre de caractères maximum. - Défaut : NULL
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addPassword()

addPassword(string  $label, string  $name, string  $value, string  $size = null, string  $maxlength = null, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée password au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur.
string $size

Taille du champ. - Défaut : NULL
string $maxlength

Nombre de caractères maximum. - Défaut : NULL
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addCheckbox()

addCheckbox(string  $label, string  $name, string  $value, string  $text, boolean  $checked = false, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée checkbox au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur selectionnée.
string $text

Texte Associé.
boolean $checked

True si selectionné. Défaut : false
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addRadio()

addRadio(string  $label, string  $name, string  $value, array  $elts, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée radio au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur selectionnée.
array $elts

Liste des éléments. ([noms]=>[valeurs])
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addTextarea()

addTextarea(string  $label, string  $name, string  $value, integer  $cols, integer  $rows, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée textarea au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur.
integer $cols

Largeur.
integer $rows

Hauteur.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addSelect()

addSelect(string  $label, string  $name, string  $value, array  $elts, integer  $size, boolean  $multiple = false, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée select au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur selectionnée.
array $elts

Liste des options. ([initulés]=>[valeurs])
integer $size

Taille de la liste. Si 0, on prend le nombre d'élément. - Défaut : 0
boolean $multiple

Si true, on autorise la selection multiple. - Défaut : false
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addFile()

addFile(string  $label, string  $name, integer  $max_file_size, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée file au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
integer $max_file_size

Taille maximum du fichier.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addButton()

addButton(string  $label, string  $name, string  $value, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée button au formulaire.

Parameters

string $label

Etiquette.
string $name

Nom.
string $value

Valeur.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addSubmit()

addSubmit(string  $label, string  $value, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée submit au formulaire.

Parameters

string $label

Etiquette.
string $value

Valeur.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

addImage()

addImage(string  $label, string  $src, string  $value, array  $params = array(), string  $start = '', string  $stop = '', array  $body_attrs = array())

Ajoute une entrée submit au formulaire.

Parameters

string $label

Etiquette.
string $src

url de l'image.
string $value

Valeur.
array $params

Liste des paramètres. ([paramètres]=>[valeurs]) - Défaut : array()
string $start

Préfixe. - Défaut : Chaîne vide
string $stop

Suffixe. - Défaut : Chaîne vide
array $body_attrs

attributs du cadre

getComponent()

getComponent(string  $name, string  $out = 'html') : string

Retourne un composant du formulaire une fois mis en forme.

Parameters

string $name

Nom du composant.
string $out

Format désiré. - Défaut : 'html'

Returns

string

html()

html() : string

Retourne le formulaire sous forme d'une chaîne de caractères formatée en HTML.

Returns

string

addComponent()

addComponent(string  $type, string  $name, string  $label, string  $html, string  $start, string  $stop, array  $body_attrs = array())

Ajoute une entrée au formulaire.

Parameters

string $type

Type.
string $name

Nom.
string $label

Etiquette.
string $html

Milieu.
string $start

Préfixe.
string $stop

Suffixe.
array $body_attrs

attributs du cadre