fr   gb


Arbor
Le script Arbor > En savoir plus > Interface de la classe Arbor

Interface de la classe Arbor

Si vous ne maîtrisez qu'imparfaitement les concepts de classe, d'instance, d'attributs et de méthode, fuyez cette page et contentez-vous d'utiliser Arbor avec les conseils donnés dans les sections "Installation" et "Mode d'emploi", dans le cas contraire cette page sera peut-être la plus utile.

Il est également possible de générer une documentation automatique de l'interface de la classe Arbor en utilisant un outil logiciel dédié (phpDocumentor), le code de celle-ci étant muni de "Docblocks".

Voir : http://phpdoc.org

up1. Instanciation

new Arbor ($datasource [, $mini [, $relpath [, $dtd ]]] )

up1.1. Arguments obligatoires :

(o) $datasource (string)

Valeur : Fichier de menu (chemin relatif) | répertoire (chemin relatif) préfixé par '%' et optionnellement suffixé par '*' suivi d'une extension de fichier : %<chemin>*<extension> | 'chk'

* Si $datasource est un chemin de fichier, l'objet est instancié comme une arborescence basée sur les données du fichier.

* Si $datasource est un chemin de répertoire (en excluant le préfixe %) du serveur, l'objet est instancié comme un explorateur de fichiers utilisant le répertoire indiqué comme racine. Si une extension est présente, l'explorateur affichera les seuls fichiers porteurs de cette extension.

* Si $datasource a la valeur chaîne 'chk', l'instanciation est mimimaliste, l'objet ne contient aucune arborescence. Cette modalité permet de lire les attributs par défaut d'un objet Arbor (numéro de version par exemple).

up1.2. Arguments facultatifs :

(o) $mini

(boolean)

Valeur par défaut : False

Option de minimalisation du menu.

(o) $relpath

(string)

Valeur par défaut : ''

Chemin relatif à ajouter éventuellement aux liens de l'arborescence.

(o) $dtd

(string)

Valeurs : 'xhtml' | 'html'

Valeur par défaut : 'xhtml'

DTD suivi par l'Html généré, XHTML 1.0 strict / 1.1 ou HTML 4.01 strict (défaut : 'xhtml')

_____________

Voir aussi : Créer un objet Arbor

up2. Attributs

up2.1. ->version

(string)

Numéro de version du script.

up2.2. ->i_clic

(integer)

Valeur par défaut : -1

Index de la sélection. Correspond à l'index du clic dans l'arborescence qui a appelé la page courante (valeur = -1 si hors contexte)

Les index de l'arborescence sont numérotés de 0 à (nombre_de_lignes –1) dans l'ordre de succession verticale des lignes, arborescence entièrement déployée, sans tenir compte de l'indentation de l'arborescence ni de la visibilité ou non des lignes.

up2.3. ->urlcompact

(boolean)

Valeur par défaut : True

Option de compactage du masque de développement de l'arborescence transmis par l'url.

Modification sans effet en mode "Explorateur de fichiers".

up2.4. ->zdv

(string)

Valeur par défaut : '1'

Masque de développement de l'arborescence courante : une suite de digits binaires 0/1.

up2.5. ->zc

(string)

Valeur par défaut : '1'

Masque de développement compacté de l'arborescence courante, chaîne alphanumérique.

Si urlcompact === False, zc est égal à zdv.

up2.6. ->icpath

(string)

Valeur par défaut : 'mnu/'

Répertoire de stockage des icônes utilisées par le script.

up->retic

(boolean)

Valeur par défaut : False

Option d'affichage du réseau de lignes joignant les éléments.

up2.7. ->tree

(string)

Valeur par défaut : 'p' (icônes plus/moins)

Préfixe des fichiers des icônes dites de treillis.

Pas d'icône si valeur = ''.

up2.8. ->symb

(string)

Valeur par défaut : 'd' (icônes dossiers)

Préfixe des fichiers des icônes dites symboliques.

Pas d'icône si valeur = "".

up2.9. ->decal

(integer)

Valeur par défaut : 12

Nombre de pixels de l'unité de décalage de l'indentation.

Si retic === True decal vaut 16 pixels quelle que soit la valeur qui lui est affectée.

up2.10. . ->hilight

(string)

Valeur par défaut : '#C3CDFD'

Couleur du surlignage de la ligne cliquée, en syntaxe html.

Pas de surlignage si valeur == ''.

up2.11. . ->typstyl

(string)

Valeurs : 'auto' | 'manuel' | (nom de classe CSS) | (aucun)

'auto' : application hiérarchisée automatique par le script.

'manuel' : styles déterminés dans le fichier de menu.

(classe) : la classe indiqué est affectée à toutes les lignes

(aucun) : le style par défaut 'z' est appliqué à toutes les lignes.

Valeur par défaut : 'auto'

Modalité d'application des styles CSS dans une arborescence.

Voir aussi : Paramètres d'affichage

up2.12. . ->idx_path

(array d'integers)

Valeur par défaut : array vide.

Tableau des index du chemin de la sélection dans l'ordre de remontée vers la racine.

idx_path[0] est donc l'index de la sélection et est égal à i_clic si la sélection existe (sinon i-clic = -1 et idx_path est un array vide.

up3. Méthodes

up3.1. ->write(string param)

Valeurs du paramètre : 'a' | 'nav1' | 'nav2' | 'path' | 'infra' | 'plan' | 'lnk:xxx' | 'prev' | 'next'

'a' : (valeur par défaut) menu arborescent ou explorateur de fichiers

'nav1' : fil d'Ariane en ligne de navigation.

'nav2' : fil d'Ariane en arbre de navigation.

'path' : chemin de la sélection.

'infra' : menu de pages subordonnées.

'plan' : plan de site.

'lnk:maPage.php' : balise <a ... > de lien dynamique pilotant les menus

'prev' : lien dynamique vers la page précédente dans la hiérarchie.

'next' : lien dynamique vers la page suivante dans la hiérarchie.

_____________

Voir aussi : Ce que peut faire Arbor

up3.2. ->getpath()

Retourne une chaîne représentant le chemin de la sélection avec les éléments du chemin séparés par '/'.

* En mode "Fichier de menu" : les éléments sont les libellés des menus.

* En mode "Explorateur de fichiers" : les éléments sont le fichier/répertoire sélectionné et les noms de ses répertoires parents.

Le premier élément du chemin est toujours './'. En mode "Explorateur de fichier" ce point référence le répertoire racine de l'explorateur (celui passé en paramètre lors de l'instanciation), en mode "Fichier de menu" il référence l'endroit contenant l'arborescence dans la logique du site (getpath() ne sert pas à grand chose dans ce mode).

Arbor ne traduit pas en clair le nom du répertoire racine de l'explorateur car il est souvent préférable de le masquer à l'utilisateur.

up3.3. ->geturlpara()

Retourne la chaîne des paramètres à joindre aux url des liens rédigés manuellement pour conserver à l'arborescence son masque d'ouverture et sa sélection.

up3.4. ->showinfo()

Affiche un journal d'exécution de l'instance. Ce journal n'est effectivement créé et affiché que si l'url appelant la page contient le paramètre "arborinfo" (sans valeur associée).

 

Principes de fonctionnement <> Code du script

 

 

Arbor Home

 

Home Accueil

Contact Chercher

Contact Contact

Site Plan Plan du site

Page top Haut de page

Valid XHTML 1.0 Strict