Au sujet des catégories

L'arborescence est stockée dans ce que l'on appelle des "catégories" (ou rubriques).

A travers l'API de Bloginus, dans vos thèmes comme dans vos plugins, vous avez accès à deux choses sur les catégories : les listes de catégories et les informations d'une catégorie.

Les catégories

Les catégories ont toutes un identifiant unique composé de soulignés, de lettres et de chiffres. Cet identifiant est à utiliser dans les fonctions de l'API et peut aussi vous servir à traiter des choses un peu particulières en affichage, mais nous y reviendrons dans un autre article.

La catégorie racine de l'arborescence est la seule dont l'ID est fixé par Bloginus. Son identifiant est "_". Vous pouvez le tester en dur dans vos programmes si vous le désirez.

La fonction category_get_infos($id) retourne un tableau des propriétés de la catégorie ayant $id comme identifiant. Ces propriétés sont :

• $categorie["id"] => contient l'identifiant de la catégorie, à utiliser dans l'API de Bloginus.
• $categorie["label"] => contient le titre de la catégorie. Ce n'est que du texte, sans mise en forme HTML possible.
• $categorie["text"] => contient le texte associé à la catégorie. Ce champ contient du code HTML pour la mise en forme du texte saisi dans le module "c" du backoffice.
• $categorie["published"] => booléen indiquant si la catégorie est publique ou ne doit pas être affichée sur le site.
• $categorie["seo"] => indique si la page de la catégorie doit être indexée par les moteurs de recherche. Ce champ peut prendre trois valeurs :
  • true => la page est indexable
  • false => la page n'est pas indexable
  • "" => la valeur booléenne de config_getvar("seo_c") doit être appliquée à cette catégorie (true pour indexable, false pour non indexable)
• $categorie["timestamp"] => contient le timestamp Unix de la dernière modification de la catégorie par le backoffice du module "c".

N'utilisez ces informations qu'en lecture dans vos thèmes. Pour les plugins, c'est une autre histoire.

Les listes de catégories

Les listes de catégories sont récupérables en appelant la fonction category_get_liste($id) qui retournera la liste des sous-catégories de la catégorie $id.

Cette liste est un tableau des catégories trouvées. Les éléments de ce tableau sont eux aussi des tableaux ayant les propriétés suivantes:

• $liste[$i]["id"] => identifiant de la catégorie de rang $i dans la liste $liste
• $liste[$i]["published"] => indique si la catégorie de rang $i dans la liste $liste est publique ou privée. C'est un booléen. S'il est false, la page de la catégorie ne doit pas être affichée sur le site, vous ne devez donc pas l'afficher dans vos pages.
• $liste[$i]["timestamp"] => timestamp (date/heure au format Unix) de dernière modification de la catégorie de rang $i dans la liste $liste

Les fonctions de l'API liées aux catégories

Bloginus fourni une API pour accéder aux différents éléments de la base de données. Il vous suffit de les appeler dans vos thèmes pour les afficher ou les retraiter à l'écran.

A ce jour, 3 fonctions concernant les catégories peuvent être utilisées dans les thèmes :

• category_url($id) => retourne l'adresse internet permettant d'afficher la page liée à la catégorie $id
• category_get_infos($id) => retourne le tableau des propriétés de la catégorie $id
• category_get_liste($id) => retourne la liste des sous-catégories de la catégorie $id

Même si vous trouvez d'autres fonctions dans les sources de Bloginus, ne les utilisez pas : elle peuvent être changées à tout moment alors que celles indiquées ci-dessus seront maintenues en l'état pour les versions futures du logiciel.