¶ Le Treeview
Comme la GenClass, le Treeview est un concept central de Gabox permettant de catégoriser les données, et bien plus.
¶ Utilité / Cas d'utilisation
Le treeview peut gérer tous les types de catégorisation et tous les menus du site.
Comme toute entité de données de Gabox, il s'agit d'un collector correspondant à la table gen_treeview, et il est accessible via le tableau collector de la GenClass ou du Displayer.
La table gen_treeview est arborescente (champ id_parent) et permet donc d'organiser plusieurs types de données :
- Menus avec sous-niveaux
- Catégorisation utilisée dans d'autres collectors, par exemple :
- pour des produits : ligne, gamme, sous-gamme, etc...
- pour un blog : thématiques, tags, etc...
A vous de bien organiser la structure du projet pour que cette dernière soit évolutive et maintenable.
¶ Données principales du treeview
En dehors de la clé primaire, les champs importants du treeview sont les suivants :
- lib : le libellé de l'élément
- url : url de l'élément (remplie ou auto-générée dans le backoffice si laissé vide)
- meta_title / meta_description : si renseigné, Gabox remplit automatiquement une variable meta dans le Displayer, ce qui permet de l'utiliser dans le template du header.
- id_parent : l'identifiant de l'élément parent
- controller : fichier PHP correspondant au controller à exécuter si l'URL correspond à celle de l'élément (
Workflow d'affichage) - hook : étiquette textuelle / référence pour pouvoir appeler cet élément simplement dans vos développement (remplie ou auto-générée dans le backoffice si laissé vide)
Exemple : si vous souhaitez récupérer les enfants d'un menu, vous pouvez indiquer 'main-menu' puis faire un$this->collector['treeview']->getChildren('main-menu') - fullurl : url complète de l'élément (concaténation des urls des parents et de l'url de l'élément)
¶ Précision sur le controller de l'élément
Partons du principe qu'un treeview a été défini avec le champ controller défini à listing_elements.php. Ce controller peut afficher tous les éléments classés dans le même treeview sous forme de liste paginée.
Si nous cliquons sur un élément de cette liste, quel controller sera appelé ? Gabox regarde alors le treeview lié à l'élément, récupère son controller, puis retire listing_ afin d'obtenir le controller de l'élément. Cela signifie qu'il suffit de créer un controller elements.php qui sera en charge de traiter l'affichage de la page de l'élément.
¶ Quelques méthodes de la classe
¶ LinkByHook
string hook : nom du hook du treeview à rechercher
string url : url complète du treeview
Permet de récupérer l'URL d'un élément du treeview à partir de son hook
¶ getChildren
- string hook : nom du hook du treeview parent à rechercher
- int max_level = 0 : nombre de niveau maximum à récupérer
- string order = 'order by gen_treeview.int_order asc' : SQL du order by pour chaque requête
- param = array() : critères supplémentaires que devront respecter les enfants
- id_loc = ''
- id_loc_master = ''
- flat = false : si flat est true, les éléments du tableau de retour ne seront pas classés de manière arborescente
array $path : tableau des enfants du hook rechercher en fonction des critères précisés dans les paramètres.
Permet de récupérer l'arborescence des enfants en fonction du hook du parent