Ce Widget permet de créer simplement et rapidement des bulles d'aides de types “Tooltips”. Celles-ci s'afficheront en survol des éléments auxquels vous les avez liées ( lien, image etc…). Une seule instance de Pxxo_Widgets_Tooltips est suffisante pour créer n bulles d'aide dans un widget.
Ce widget ne prend pas de paramètre particulier.
Exemple :
Pour créer des bulles d'aides il faut instancier un Pxxo_Widget_Tooltips :
require_once 'Pxxo/Widgets/Tooltips.php'; $o = new Pxxo_Widgets_Tooltips;
Puis ensuite, ajouter les bulles d'aide :
$o->add('id_element_1','texte <i>riche</i>','texte alternatif'); $o->add('id_element_2','exple<br/>...','exple','nom_d_une_classe_CSS');
Et enfin ajouter l'objet au widget courant :
$this->putWidget('TOOLTIPS',$o);
Exemple d'utilisation en ligne :
Vous avez pu le constater ci-dessus, la méthode clef de ce widget est la méthode “add”.
Voici le descriptif de chacun des paramètres de cette méthode.
| Nom | Type | Valeur | Description |
|---|---|---|---|
| id | String | - | Paramètre obligatoire - valeur de l'attribut ID de l'élément auquel la bulle d'aide sera liée. Rappel : celui-ci doit être unique dans une page web. ATTENTION : l'ID est positionné sur l'élément le plus interne. Par exemple, si une image se trouve dans un lien l'ID à utiliser pour lier, la bulle d'aide doit être positionné sur l'image et non le lien qui l'englobe car des événements parasites empêcheraient l'affichage correcte de la bulle d'aide. |
| data | String | - | Paramètre obligatoire - contenu de l'info-bulle (celui peut contenir du html et par exemple des images etc …). |
| alt | String | - | Paramètre obligatoire - texte alternatif (il ne s'affiche qu'en cas de soucis liés, par exemple au nom respect à la non conformité de la page) |
| cssClassName | String | - | Paramètre facultatif - nom de la class CSS à utiliser pour personnaliser l'apparence de la bulle d'aide si celle-ci ne vous convient pas. CONSEIL : si vous souhaitez relooker toutes les bulles d'aide de votre application, préférer la “façon de faire officielle” prévue par les widgets, en redéfinissant la feuille de style CSS de Pxxo_Widgets_Tooltips. En effet, l'utilisation de l'attribut cssClassName doit rester anecdotique. |
La méthode “add” renvoie la constante FALSE en cas d'erreur ; par exemple, en cas de paramètre(s) obligatoire(s) non renseignés ou vide. Dans le cas contraire, elle renvoie le nombre total de bulles d'aide qui ont été ajoutées. En cas de réussite, ce nombre est strictement supérieur à 0.