API
Table of Contents
Functions
- type_noisette_charger() : bool
- Charge ou recharge les descriptions des types de noisette à partir des fichiers YAML.
- type_noisette_lire() : array<string|int, mixed>|string
- Retourne, pour un type de noisette donné, la description complète ou seulement un champ précis.
- type_noisette_repertorier() : array<string|int, mixed>
- Renvoie une liste de descriptions de types de noisette éventuellement filtrée sur certains champs fournis en argument.
- type_noisette_decacher() : bool
- Supprime tout ou partie des caches liés à la compilation uniquement.
- type_noisette_repertorier_categories() : array<string|int, mixed>
- Renvoie la liste des catégories de type de noisette et leur description.
Functions
type_noisette_charger()
Charge ou recharge les descriptions des types de noisette à partir des fichiers YAML.
type_noisette_charger(string $plugin[, null|bool $recharger = false ][, null|string $stockage = '' ]) : bool
La fonction optimise le chargement en effectuant uniquement les traitements nécessaires en fonction des modifications, ajouts et suppressions des types de noisette identifiés en comparant les md5 des fichiers YAML.
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $recharger : null|bool = false
-
Si
trueforce le rechargement de tous les types de noisette, sinon le chargement se base sur le md5 des fichiers YAML. Par défaut vautfalse. - $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
bool —false si une erreur s'est produite, true sinon.
type_noisette_lire()
Retourne, pour un type de noisette donné, la description complète ou seulement un champ précis.
type_noisette_lire(string $plugin, string $type_noisette[, null|string $information = '' ][, null|bool $traiter_typo = false ][, null|string $stockage = '' ]) : array<string|int, mixed>|string
Les champs textuels peuvent subir une traitement typo si demandé.
Parameters
- $plugin : string
-
Le service permet de distinguer l'appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $type_noisette : string
-
Identifiant du type de noisette.
- $information : null|string = ''
-
Information spécifique à retourner ou vide pour retourner toute la description.
- $traiter_typo : null|bool = false
-
Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées en utilisant la fonction typo. Par défaut l'indicateur vaut
false. Les champs sérialisés sont eux toujours désérialisés. - $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
array<string|int, mixed>|string —La description complète ou champ précis demandé pour un type de noisette donné. Les champs de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être traités avec la fonction typo().
type_noisette_repertorier()
Renvoie une liste de descriptions de types de noisette éventuellement filtrée sur certains champs fournis en argument.
type_noisette_repertorier(string $plugin[, null|array<string|int, mixed> $filtres = [] ][, null|string $stockage = '' ]) : array<string|int, mixed>
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $filtres : null|array<string|int, mixed> = []
-
Tableau associatif
[champ] = valeurde critères de filtres sur les descriptions de types de noisette. Le seul opérateur possible est l'égalité. - $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
array<string|int, mixed> —Tableau des descriptions des types de noisette trouvés indexé par le type de noisette.
type_noisette_decacher()
Supprime tout ou partie des caches liés à la compilation uniquement.
type_noisette_decacher(string $plugin[, array<string|int, mixed>|string $fonctions = [] ]) : bool
Ces caches sont entièrement gérés par N-Core sans appel à des services surchargeables.
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $fonctions : array<string|int, mixed>|string = []
-
Identifiants des fonctions permettant de nommer le cache : les valeurs possibles sont
ajax,inclusionsetcontextes. Il est possible de fournir un tableau vide pour supprimer tous les caches ou juste une fonction sous forme de chaine.
Return values
bool —false si une erreur de fonction s'est produite, true sinon.
type_noisette_repertorier_categories()
Renvoie la liste des catégories de type de noisette et leur description.
type_noisette_repertorier_categories(string $plugin[, null|string $id_categorie = '' ]) : array<string|int, mixed>
Il est possible de demander toutes les catégories ou juste une seule désignée par son identifiant.
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- $id_categorie : null|string = ''
-
Identifiant de la catégorie ou chaine vide pour toutes les catégories.
Return values
array<string|int, mixed> —Liste des descriptions de catégorie.