Documentation du code de SPIP et de ses plugins

SVP Typologie

svptype_mot.php

Ce fichier contient l'API de gestion des mots-clés propre à SVP Typologie.

Table of Contents

Functions

mot_est_racine()  : bool
Vérifie que le mot identifié par son id est un mot racine d'une typologie arborescente.
groupe_est_typologie_plugin()  : bool
Vérifie que le groupe identifié par son id matérialise bien une typologie de plugin.
mot_lire_groupe()  : int
Renvoie l'id du groupe d'un mot-clé.
mot_lire_identifiant()  : string
Renvoie le champ `identifiant` d'un mot-clé si celui-ci est un type de plugin.
mot_lire_enfants()  : array<string|int, mixed>
Renvoie les id des enfants d'un mot-clé.

Functions

mot_est_racine()

Vérifie que le mot identifié par son id est un mot racine d'une typologie arborescente.

mot_est_racine(int $id_mot) : bool
Parameters
$id_mot : int

Id du mot-clé.

Return values
bool

True si le mot est une racine d'une typologie arborescente, false sinon.

groupe_est_typologie_plugin()

Vérifie que le groupe identifié par son id matérialise bien une typologie de plugin.

groupe_est_typologie_plugin(int $id_groupe) : bool
Parameters
$id_groupe : int

Id du groupe de mots concerné.

Return values
bool

True si le groupe est celui d'une typologie, false sinon.

mot_lire_groupe()

Renvoie l'id du groupe d'un mot-clé.

mot_lire_groupe(int $id_mot) : int
Parameters
$id_mot : int

Id du mot-clé.

Return values
int

Id du groupe d'appartenance du mot-clé ou 0 sinon.

mot_lire_identifiant()

Renvoie le champ `identifiant` d'un mot-clé si celui-ci est un type de plugin.

mot_lire_identifiant(int $id_mot) : string

Si le mot-clé n'est pas un type de plugin l'identifiant est vide.

Parameters
$id_mot : int

Id du mot-clé.

Return values
string

Champ identifiant du mot-clé si celui-ci est un type de plugin ou chaine vide sinon.

mot_lire_enfants()

Renvoie les id des enfants d'un mot-clé.

mot_lire_enfants(int $id_mot) : array<string|int, mixed>
Parameters
$id_mot : int

Id du mot-clé.

Return values
array<string|int, mixed>

Tableau des id des enfants d'un mot-clé ou tableau vide sinon.


        
On this page

Search results