Pxxo_Widget_MenuTabs

Pxxo_Widget_MenuTabs

Ce widget permet de créer et de gérer un système d'onglet. Ce widget n'est pas à confondre avec Pxxo_Widgets_Menu_Tabs dont le nom est très proche mais dont la structure et le fonctionnement divergent. De plus, il possède également des fonctionnalités supplémentaires par rapport à Pxxo_Widgets_Menu_Tabs :

alignement du système d'onglet à gauche ou à droite
désactivation d'un ou plusieurs onglets
il garde en mémoire quel onglet a été précédemment sélectionné.
aspect graphique compatible : IE6, IE7, Firefox, Mozilla, Konqueror, Opera et peut être d'autres…

Paramètres

Nom	Type	Description
id	String	Paramètre facultatif (mais conseillé). Chaîne de caractères qui identifiera de façon unique le système d'onglet. Ce paramètre est très utile quand plusieurs systèmes d'onglets sont présents sur la même page (et dans certains cas alambiqués).
type	String	Paramètre facultatif. Constante qui permet d'indiquer l'alignement du système d'onglet (cf. listes des constantes ci-dessous). Par défaut, l'alignement se fait à gauche

Différents types d'alignement supportés et leurs constantes associées :

Pxxo_Widgets_MenuTabs::LEFT() : alignement à gauche (utilisé par défaut).
Pxxo_Widgets_MenuTabs::RIGHT() : alignement à droite.

Utilisation

Voici un exemple de mise en œuvre. Exemples d'utilisation en ligne

require_once 'Pxxo/Widgets/MenuTabs.php';
 
$params  =  array(                
                'type'  =>  Pxxo_Widgets_MenuTabs::RIGHT(),
                'id' =>  'exple1'
            );
$obj1 = new Pxxo_Widgets_MenuTabs($params);
 
$obj1->add( array('lib'=>'test1') );
$obj1->add( array('lib'=>'test2') );
$obj1->add( array('lib'=>'test3','enabled'=>false) );
$obj1->add( array('lib'=>'test4') );
 
$obj1->main();
$obj1->dump();

Méthodes

boolean add( $item )

Il s'agit de la méthode clef du widget qui permet de construire et personnaliser le système d'onglet.

Nom	Type	Description
item	Array	Paramètre obligatoire. Tableau indexé contenant toutes les données nécessaires à la création de l'onglet. Ci-dessous est décrit ce que le tableau peut et doit comporter

$item = array ( 
   'lib'      => 'Exple de libellé', /* OBLIGATOIRE */
   'icon'     => '/img/monicone16x16.gif', /* FACULTATIF */
   'link'     => '/test/mapage.php?exple=1', /* FACULTATIF */ 
   'selected' => false, /* ou true ; FACULTATIF */
   'enabled'  => false /* ou true ; FACULTATIF */
);

void setSelected( $n )

Sélectionner un item. Cette méthode est prioritaire pour déterminer quel onglet est sélectionné ou non par rapport à la valeur de la propriété “selected” lors de l'ajout de l'item. Attention, cette méthode est à utiliser avant le “putWidget” sinon elle n'aura aucun effet.

Nom	Type	Description
n	Integer	Paramètre obligatoire. Numéro de l'onglet à selectionner. Valeur comprise entre 0 et n-1 (où n est le nombre d'onglet)

int getSelected( )

Renvoie le numéro de l'onglet sélectionné (valeur comprise entre 0 et n-1) ; si aucun onglet est sélectionné renvoie la valeur -1.

Cette méthode ne prend pas de paramètre.

int getLastSelected( )

Renvoie le numéro de l'onglet précédemment sélectionné (valeur comprise entre 0 et n-1) ; si aucun onglet est sélectionné renvoie la valeur -1. “Précédemment” n'est pas à prendre dans le sens précédemment dans le code source de la page actuelle, mais au sens précédemment au cours de la navigation dans le site. Voici un exemple pour mieux comprendre : Si un internaute a déjà utilisé le système d'onglet d'une page A pour accéder au contenu d'un des onglets puis qu'il est parti dans une autre section du site (dans laquelle il n'y a pas forcément d'onglet) et qu'il revient sur la page A, alors la méthode getLastSelected() renverra le numéro de l'onglet qu'il a précédemment choisi.

Cette méthode ne prend pas de paramètre.

ATTENTION, afin de prévenir d'un éventuel bug comportemental de cette fonctionnalité, il est préférable de fournir un “id” au constructeur de Pxxo_Widgets_MenuTabs.

void setEnabled( $n , $enabled )

Active ou désactive un onglet. Un onglet désactivé sera affiché mais sera grisé. De plus un clic sur celui-ci n'aura pas d'effet. Attention, cette méthode est à utiliser avant le “putWidget” sinon elle n'aura aucun effet.

Nom	Type	Description
n	Integer	Paramètre obligatoire. Numéro de l'onglet à sélectionner. Valeur comprise entre 0 et n-1 (où n est le nombre d'onglet)
enabled	boolean	Paramètre facultatif. Booléen qui indique si on active (true) ou désactive (false) l'onglet

boolean getEnabled( $n )

Teste si un onglet est actif ou pas (à ne pas confondre avec “sélectionné”).

Nom	Type	Description
n	Integer	Paramètre obligatoire. Numéro de l'onglet à sélectionner. Valeur comprise entre 0 et n-1 (où n est le nombre d'onglet)

Renvoie false si il n'est pas actif ou true dans la cas contraire.