Formulaire (2)
Catégorie : Fiches techniques

Eléments de formulaire (2)

xoopsFormCheckBox addOption
xoopsFormRadio addOptionArray
xoopsFormRadioYN
xoopsFormSelect
xoopsFormDateTime
xoopsFormSelectTimezone
xoopsFormTextDateSelect
xoopsFormSelectUser
xoopsFormSelectGroup
xoopsFormSelectMatchOption
xoopsFormSelectLang
xoopsFormSelectCountry
xoopsFormSelectTheme
>Eléments de formulaire (1)


XoopsFormCheckBox
Création d'une case à  cocher.
Les options seront ajoutées par la méthode addOption

XoopsFormCheckBox(string $caption, string $name, [int $value = null])

$caption

string

Nom du champ

$name

string

Nom de la variable

$value

string

Valeur par défaut

Exemple

// code du script Php
$agree_chk = new XoopsFormCheckBox('', 'agree_disc', 0);
$agree_chk->addOption(1, _US_IAGREE);
$reg_form->addElement($agree_chk);


<!-- Code html généré -->
<input type='checkbox' name='agree_disc' value='1' />J'accepte la mise en garde ci-dessus


XoopsFormRadioYN
Création d'une paire de boutons radio Oui/Non



XoopsFormRadioYN(string $caption, string $name, [int $value = null], [string $yes=_YES], [string $no=_NO])

$caption string Titre du champ
$name string Nom de la variable
$value int Valeur par défaut : 0 pour No, 1 pour Yes
$yes string Chaine de caractêres pour Yes
$no string Chaine de caractêres pour No

Exemple

// code du script Php
$cookie = new XoopsFormRadioYN(_US_USECOOKIE, 'usecookie', 0);

<!-- Code html généré -->
<input type='radio' name='usecookie' value='1' />Oui
<input type='radio' name='usecookie' value='0' checked='checked' />Non

XoopsFormRadio
Création d'un champ avec boutons radio.
Les options seront ajoutées par la méthode addOption ou addOptionArray.

XoopsFormRadio(string $caption, string $name, [string $value = null])

$caption string Titre du champ
$name string Nom de la variable
$value string Valeur par défaut

Exemple

// code du script Php
$gender = new XoopsFormRadio(_MD_SEXE, "gender", 'I');
$options = array('M' =>_MD_MALE, 'F' => _MD_FEMALE, 'I' => _MD_UNKNOW);
$gender->addOptionArray($options);
$form->addElement($gender, true);

<!-- Code html généré -->
<input type='radio' name='gender' value='M' />Homme
<input type='radio' name='gender' value='F' />Femme
<input type='radio' name='gender' value='I' checked='checked' />Indifférent

XoopsFormSelect
Création d'une liste de choix.
Les options seront ajoutées par la méthode addOption ou addOptionArray.

XoopsFormSelect(string $caption, string $name, [mixed $value=null], [int $size=1], [bool $multiple=false])

$caption string Intitulé du champ
$name string nom de la variable
$value mixed Valeur par défaut, ou tableau de valeurs
$size int Nombre de lignes affichées
$multiple bool Choix multiple autorisé

Exemple

// code du script Php
$gender = new XoopsFormSelect(_MD_XFGB_SEXE, "gender", $gender);
$options = array('M' =>_MD_XFGB_MALE, 'F' => _MD_XFGB_FEMALE, 'I' => _MD_UNKNOW );
$gender->addOptionArray($options);
$sign_form->addElement($gender, true);

<!-- Code html généré -->
<select size='1' name='gender' id='gender'>
<option value='M'>Homme </option>
<option value='F'>Femme </option>
<option value='I'>Indifférent</option>
</select>

XoopsFormSelectTimezone
Création d'un champ de sélection de 'Timezone'
Le formulaire retournera une valeur de -12 à  +12



XoopsFormSelectTimezone(string $caption, string $name, [int $value=null], [int $size=1])

$caption string Intitulé du champ
$name string Nom de la variable
$value int Valeur par défaut
$size int Nombre de lignes affichées

XoopsFormTextDateSelect
Création d'un champ de sélection de 'Date': saisie directe dans le champ ou par sélection dans le calendrier javascript.
Le formulaire retournera une date sous la forme yyyy-mm-dd

XoopsFormTextDateSelect(string $caption, string $name, [int $size = 15], [int $value= 0])

$caption

string

Intitulé du champ

$name

string

Nom de la variable

$size

int

Taille du champ

$value

timestamp

Valeur par défaut : null = 01/01/1970


XoopsFormDateTime
Création d'un champ de sélection de 'Date + Heure'.
Le formulaire retournera une date + heure sous la forme de tableau.

XoopsFormDateTime(string $caption, string $name, [int $size = 15], [timestamp $value= 0])

$caption string Intitulé du champ
$name string Nom de la variable
$size int Taille du champ
$value timestamp
Valeur par défaut; si non précisé : time()

XoopsFormSelectGroup
Création d'un champ de sélection 'Groupe d'utilisateurs'.
Le formulaire retournera l'id du groupe (1 webmestres, 2 .) ; un tableau des id si sélection multiple.

XoopsFormSelectGroup(string $caption, string $name, [bool $include_anon=false], [mixed $value=null], [int $size=1], [bool $multiple=false])

$caption string Intitulé du champ
$name string Nom de la variable
$include_anon bool true pour inclure groupe 'anonymes'
$value mixed Valeur par défaut, ou tableau de valeurs
$size int Nombre de lignes affichées
$multiple bool Sélection multiple autorisée

XoopsFormSelectUser
Création d'un champ de sélection 'Utilisateur'.
Le formulaire retournera l'id de l'utilisateur (0 si anonyme).

XoopsFormSelectUser(string $caption, string $name, [bool $include_anon=false], [mixed $value=null], [int $size=1], [bool $multiple=false])

$caption

string

Titre du champ

$name string Nom de la variable
$include_anon bool true pour inclure user 'anonyme' dans la liste
$value mixed Valeur par défaut, ou tableau de valeurs

$size

int

Nombre de lignes affichées

$multiple bool Sélection multiple autorisée

XoopsFormSelectLang
Création d'un champ de sélection 'Langue'.
La liste des langues est créée à  partir des noms des sous-répertoires de language.
Le formulaire retournera une chaine avec la langue sélectionnée ('french', 'english', etc.).


XoopsFormSelectLang(string $caption, string $name, [string $value=null], [int $size=1])


XoopsFormSelectCountry
Création d'un champ de sélection 'Pays'.
La liste des pays est celle de la classe XoopsLists (voir class/xoopslists.php)
Le formulaire retournera une chaine avec le code à  2 caractêres du pays sélectionné ('FR', 'EN', 'US', etc.).

XoopsFormSelectCountry(string $caption, string $name, [string $value=null], [int $size=1])


XoopsFormSelectMatchOption
Création d'un champ de sélection 'Options de recherche'.
Les valeurs proposées sont les valeurs de XOOPS_MATCH_ * définies dans commun.php.
Le formulaire retournera 0 (commençant par), 1 (finisssant par), 2 (correspondant à ) ou 3 (contenant).

XoopsFormSelectMatchOption (string $caption, string $name, [int $value=null], [int $size=1])


XoopsFormSelectTheme
Création d'un champ de sélection 'Thême'.
La liste des thêmes est créée à  partir des noms des sous-répertoires de themes.
Le formulaire retournera une chaine avec le nom du thême ('fiapplegreen', 'phpkaox',.).

XoopsFormSelectTheme(string $caption, string $name, [ string $value=null], [int $size=1])


addOption
Méthode pour les éléments xoopsFormSelect, xoopsFormRadio et xoopsFormCheckBox
Permet d'ajouter les options une par une.

addOption(mixed $value, string $name)

Exemples

// valeurs ajoutées séparément
$formstat = new XoopsFormSelect(_MD_STATUS, "status", $status);
$formstat->addOption("1", _MD_ACTIVE);
$formstat->addOption("0", _MD_INACTIVE);

// valeurs extraites d'un tableau indexé numériquement $arr_option
$monnaie = new XoopsFormSelect('', "monnaie", $monnaie);
for ( $i = 0; $i < $count; $i++ ) {
$monnaie>addOption($arr_option[$i]['descr'],$arr_option[$i]['descr']);
}

// valeurs extraites d'une requête
$sql = "SELECT country_code, country_name FROM ".$db->prefix("country");
$result = $db->query($sql);
while ( $myrow = $db->fetchArray($result) ) {
$this->addOption($myrow['country_code'],$myrow['country_name']);
}

addOptionArray
Méthode pour les éléments xoopsFormSelect et xoopsFormRadio.
Le paramêtre à  transmettre doit être un tableau associatif des paires valeur=>nom

addOptionArray(array $value=>$name)

Exemple

$pays = new XoopsFormSelect('', "country", $country);
$pays>addOption(array("AD" => "Andorra", "AE" => "United Arab Emirates", "AF" => "Afghanistan"));


Version Xoops de référence: 2.06
C. Felix AKA theCat le 27/06/04

<a href="http://creativecommons.org/licenses/by-nc-sa/2.0/fr/" title="Licence, certains droits réservés"><img src="http://www.frxoops.org/images/cdr_bouton.gif" alt="Licence, certains droits réservés" /></a>