Outils de rendu HTML
Pour gérer l'affichage d'éléments HTML dans votre plugin, vous bénéficiez de divers outils qui vont permettre de générer automatiquement des portions complètes de code. Cela offre à l'utilisateur une continuité de l'interface entre PLUME CMS et ses plugins. En outre l'avantage est d'alléger le code source tout en gagnant en lisibilité, et par la même occasion, d'en faciliter la maintenance.
Ces outils concernent l'affichage de sous-menu, de messages d'erreur et de succès, ainsi que la gestion d'éléments de formulaires. Dans ce dernier cas, ils ne produisent pas directement de sortie à l'écran et doivent donc être pour cela invoqués avec echo() ou print().
Affichage de sous-menu
$px_submenu->addItem($title,$url,$img,$active,$show=true,$accesskey='')
Paramètres
- $title (chaîne) : Intitulé du lien.
- $url (chaîne) : Adresse du lien.
- $img (chaîne) : Adresse de l'icône associée
- $active (booléen) : Statut CSS de la ligne contenante
- $show (booléen) : Statut de l'affichage du lien
- $accesskey (chaîne) : Définition de la touche d'accessibilité
Affiche un lien dans la zone de sous-menu de l'interface du manageur.
Les liens sont générés sous la forme d'une liste non ordonnée.
Il est possible de distinguer l'élément actif via CSS en déclarant $active TRUE, ce qui affectera la classe CSS "active" à la ligne (<li>) contenante.
Affichage de message d'erreur
$m->setError($msg,$no=0)
Paramètres
- $msg (chaîne) : Message d'erreur à afficher.
- $no (entier) : Non appliqué. Pour utilisation future.
Affiche un message d'erreur.
Affichage de message de succès
(URL du plugin)?[paramètres du plugin]&msg=$msg
- $msg (chaîne) : Message de succès à afficher.
Affiche un message de succès.
Le message à afficher étant transmis via l'URL, Il est important de l'encoder avec urlencode() auparavant.
Elements de formulaires
php_f_combobox($name,$arryData,$default='',$tabindex='',$class='',$id='', $extra='')
Paramètres
- $name (chaîne) : Nom du
<select>. - $arryData (tableau) : Tableau des valeurs de(s)
<option>. - $default (chaîne) : Valeur de préselection de
<option>. - $tabindex (entier) : Position du
<select>dans l'ordre de tabulation. - $class (chaîne) : Classe affectée au
<select>. - $id (chaîne) : Identification du
<select> - $extra (chaîne) : Attribut(s) à ajouter en fin du
<select>
Génère une boîte de selection HTML.
Les valeurs de la liste de sélection sont extraites du tableau $arryData et attribuées à <option> , les clefs seront affichées dans la liste.
php_f_textField($id,$size,$max,$default='',$tabindex='',$html='')
Paramètres
- $id (chaîne) : Identification de
<input />. - $size (entier) : Taille de
<input />. - $max (entier) : Nombre maximal de caractères autorisé pour le champ.
- $default (chaîne) : Valeur par défaut de
<input />. - $tabindex (entier) : Position de
<input />dans l'ordre de tabulation. - $html (chaîne) : Attribut(s) à ajouter en fin du
<input />
Génère un champ de saisie utilisateur XHTML (<input type="text".../>).
Il est possible de rejouter des élements supplémentaires en fin de balise <input /> à l'aide de $html.
php_f_textArea($id,$cols,$rows,$default='',$tabindex='',$html='')
- $id (chaîne) : Identification de
<textarea>. - $cols (entier) : Nombre de colonnes de la zone.
- $rows (entier) : Nombre de lignes de la zone.
- $default (chaîne) : Valeur par défaut de
<textarea>. - $tabindex (entier) : Position de
<textarea>dans l'ordre de tabulation. - $html (chaîne) : Attribut(s) à ajouter en fin du
<textarea>.
Génère une zone de texte (<textarea...></textarea>).
function php_f_checkbox($id, $value, $checked=false,$tabindex='',$html='')
- $id (chaîne) : Identification de
<input />. - $value (chaîne) : Valeur de
<input />. - $checked (booléen) : Statut de sélection de la case à cocher, false par défaut.
- $tabindex (entier) : Position de
<input />dans l'ordre de tabulation. - $html (chaîne) : Attribut(s) à ajouter en fin du
<input />
Génère une case à cocher XHTML (<input type="checkbox".../>)..
php_f_hidden($id,$value)
- $id (chaîne) : Identification de
<input />. - $value (chaîne) : Valeur du champ
Génère un champ caché XHTML (<input type="hidden".../>).
L'attribut name aura la même valeur que celle donnée à $id.
php_f_button($type='submit',$value='ok',$id='',$tabindex='')
- $type (chaîne) : Type de
<input />, submit par défaut. - $value (chaîne) : Valeur de
<input />, ok par défaut. - $id (chaîne) : Identification de
<input />. - $tabindex (entier) : Position de
<input />dans l'ordre de tabulation.
Génère un bouton de soumission XHTML (<input type="submit".../>).
L'attribut name aura la même valeur que celle donnée à $id.
Pages
- Introduction
- Structure d'un plugin
- Localisation du plugin
- Outils de rendu HTML
- Variables accessibles
Partagez vos idées sur cet article.
