ncore_noisette.php
Ce fichier contient l'API N-Core de gestion des noisettes, c'est-à-dire les instances paramétrées de types de noisette affectées à un conteneur.
Table of Contents
Functions
- noisette_ajouter() : bool|int|string
- Ajoute dans un conteneur, à un rang donné ou en dernier rang, une noisette d'un type donné.
- noisette_parametrer() : bool
- Met à jour les paramètres éditables d'une noisette donnée.
- noisette_supprimer() : bool
- Supprime une noisette donnée du conteneur auquel elle est associée et, si cette noisette est un conteneur, le vide de ses noisettes au préalable.
- noisette_lire() : array<string|int, mixed>|int|string
- Retourne, pour une noisette donnée, la description complète ou seulement un champ précis.
- noisette_deplacer() : bool
- Déplace une noisette donnée au sein d’un même conteneur ou dans un autre conteneur.
- noisette_dupliquer() : bool
- Duplique une noisette donnée dans un conteneur destination et, si cette noisette est un conteneur, duplique aussi les noisettes contenues de façon récursive.
- noisette_repertorier() : array<string|int, mixed>
- Renvoie une liste de descriptions de noisettes appartenant à un conteneur donné ou pas et éventuellement filtrée sur certains champs.
Functions
noisette_ajouter()
Ajoute dans un conteneur, à un rang donné ou en dernier rang, une noisette d'un type donné.
noisette_ajouter(string $plugin, string $type_noisette, array<string|int, mixed>|string $conteneur[, null|int $rang = 0 ][, null|string $stockage = '' ]) : bool|int|string
La fonction met à jour les rangs des autres noisettes si nécessaire.
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.
- $type_noisette : string
-
Identifiant du type de noisette à ajouter au squelette.
- $conteneur : array<string|int, mixed>|string
-
Identifiant du conteneur accueillant la noisette qui prend soit la forme d'un tableau soit celui d'un id.
- $rang : null|int = 0
-
Rang dans le conteneur où insérer la noisette. Si l'argument n'est pas fourni ou est égal à 0 on insère la noisette en fin de conteneur.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin fournissant le service de stockage souhaité.
Tags
Return values
bool|int|string —Retourne l'identifiant de la nouvelle instance de noisette créée ou false en cas d'erreur.
noisette_parametrer()
Met à jour les paramètres éditables d'une noisette donnée.
noisette_parametrer(string $plugin, array<string|int, mixed>|int|string $noisette, array<string|int, mixed> $modifications[, null|string $stockage = '' ]) : bool
La fonction contrôle la liste des champs modifiables.
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.
- $noisette : array<string|int, mixed>|int|string
-
Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (id conteneur, rang).
- $modifications : array<string|int, mixed>
-
Tableau des couples (champ, valeur) à mettre à jour pour la noisette spécifiée. La fonction contrôle la liste des champs éditables en filtrant les champs standard et éventuellement ceux spécifiquement définis par le plugin utilisateur.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin fournissant le service de stockage souhaité.
Tags
Return values
bool —true si la modification s'est bien passée, false sinon.
noisette_supprimer()
Supprime une noisette donnée du conteneur auquel elle est associée et, si cette noisette est un conteneur, le vide de ses noisettes au préalable.
noisette_supprimer(string $plugin, array<string|int, mixed>|int|string $noisette[, null|string $stockage = '' ]) : bool
La fonction met à jour les rangs des autres noisettes si nécessaire.
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.
- $noisette : array<string|int, mixed>|int|string
-
Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (id conteneur, rang).
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin fournissant le service de stockage souhaité.
Tags
Return values
bool —true si la suppression s'est bien passée, false sinon.
noisette_lire()
Retourne, pour une noisette donnée, la description complète ou seulement un champ précis.
noisette_lire(string $plugin, array<string|int, mixed>|int|string $noisette[, null|string $information = '' ][, null|bool $traiter_typo = false ][, null|string $stockage = '' ]) : array<string|int, mixed>|int|string
Les champs textuels peuvent subir un traitement typo si demandé.
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.
- $noisette : array<string|int, mixed>|int|string
-
Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (id conteneur, rang).
- $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. Pour l'instant il n'y a pas de champ textuel directement associé à une noisette. - $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin fournissant le service de stockage souhaité.
Tags
Return values
array<string|int, mixed>|int|string —La description complète ou champ précis demandé pour une noisette donnée. 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().
noisette_deplacer()
Déplace une noisette donnée au sein d’un même conteneur ou dans un autre conteneur.
noisette_deplacer(string $plugin, array<string|int, mixed>|int|string $noisette, array<string|int, mixed>|string $conteneur_destination, int $rang_destination[, null|string $stockage = '' ]) : bool
La fonction met à jour les rangs des autres noisettes si nécessaire.
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.
- $noisette : array<string|int, mixed>|int|string
-
Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (id conteneur, rang).
- $conteneur_destination : array<string|int, mixed>|string
-
Identifiant du conteneur destination qui prend soit la forme d'un tableau soit celui d'un id.
- $rang_destination : int
-
Entier représentant le rang où repositionner la noisette dans le squelette contextualisé.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
bool —Renvoie false si la noisette n'est pas déplacée à cause d'une erreur de traitement ou parce que le
rang destination est identique au rang origine, sinon true.
noisette_dupliquer()
Duplique une noisette donnée dans un conteneur destination et, si cette noisette est un conteneur, duplique aussi les noisettes contenues de façon récursive.
noisette_dupliquer(string $plugin, array<string|int, mixed>|int|string $noisette, array<string|int, mixed>|string $conteneur[, null|int $rang = 0 ][, null|array<string|int, mixed> $parametrage = null ][, null|string $stockage = '' ]) : bool
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.
- $noisette : array<string|int, mixed>|int|string
-
Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme d'un couple (id conteneur, rang).
- $conteneur : array<string|int, mixed>|string
-
Identifiant du conteneur destination qui prend soit la forme d'un tableau soit celui d'un id.
- $rang : null|int = 0
-
Rang dans le conteneur destination où insérer la noisette dupliquée. Si l'argument n'est pas fourni ou est égal à 0 on insère la noisette en fin de conteneur.
- $parametrage : null|array<string|int, mixed> = null
-
Tableau indiquant les champs éditables de la noisette source à copier dans la noisette dupliquée. Si null, indique de copier tous les champs éditables, si tableau vide, aucun
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin fournissant le service de stockage souhaité.
Tags
Return values
bool —true si la duplication s'est bien passée, false sinon.
noisette_repertorier()
Renvoie une liste de descriptions de noisettes appartenant à un conteneur donné ou pas et éventuellement filtrée sur certains champs.
noisette_repertorier(string $plugin[, null|array<string|int, mixed>|string $conteneur = [] ][, null|string $cle = 'rang_noisette' ][, null|array<string|int, mixed> $filtres = [] ][, null|string $stockage = '' ]) : array<string|int, mixed>
Le tableau retourné est indexé soit par identifiant de noisette soit par identifiant du conteneur et rang de la noisette.
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.
- $conteneur : null|array<string|int, mixed>|string = []
-
Tableau descriptif du conteneur ou identifiant du conteneur ou vide si on souhaite adresser tous les conteneurs.
- $cle : null|string = 'rang_noisette'
-
Champ de la description d'une noisette servant d'index du tableau. On utilisera soit
id_noisettesoitrang_noisette(défaut). - $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 noisettes du conteneur indexé par le champ fourni en argument (par défaut le rang).