API
Table of Contents
Functions
- type_noisette_ajaxifier() : bool
- Détermine si le type de noisette spécifié doit être inclus en AJAX ou pas. Cette fonction gère un cache des indicateurs ajax.
- type_noisette_dynamiser() : bool
- Détermine si la noisette spécifiée doit être incluse dynamiquement ou pas. Cette fonction gère un cache des indicateurs d'inclusion dynamique.
- type_noisette_localiser() : string
- Renvoie le dossier relatif des types de noisette pour le plugin appelant ou la localisation du type de noisette demandé.
- noisette_contextualiser() : array<string|int, mixed>
- Renvoie le contexte de la noisette sous la forme d'un tableau éventuellement vide. Cette fonction gère un cache des contextes non valorisés des types de noisette disponibles.
- noisette_encapsuler() : string
- Encapsule, si demandé, le contenu compilé d'une ou d'un ensemble de noisettes dans un balisage HTML plus ou moins complexe appelé une capsule.
Functions
type_noisette_ajaxifier()
Détermine si le type de noisette spécifié doit être inclus en AJAX ou pas. Cette fonction gère un cache des indicateurs ajax.
type_noisette_ajaxifier(string $plugin, string $type_noisette[, 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.
- $type_noisette : string
-
Identifiant du type de noisette.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
bool —true si la noisette doit être ajaxée, false sinon.
type_noisette_dynamiser()
Détermine si la noisette spécifiée doit être incluse dynamiquement ou pas. Cette fonction gère un cache des indicateurs d'inclusion dynamique.
type_noisette_dynamiser(string $plugin, string $type_noisette[, 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.
- $type_noisette : string
-
Identifiant du type de noisette.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
bool —true si le type de noisette doit être inclus dynamiquement, false sinon.
type_noisette_localiser()
Renvoie le dossier relatif des types de noisette pour le plugin appelant ou la localisation du type de noisette demandé.
type_noisette_localiser(string $plugin[, null|string $type_noisette = '' ]) : string
Cette fonction gère le cas particulier de la noisette conteneur fournie par N-Core qui est elle toujours dans le dossier par défaut de N-Core.
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 : null|string = ''
-
Identifiant du type de noisette ou chaine vide si on ne veut que le dossier.
Tags
Return values
string —Chemin relatif du dossier où chercher les types de noisette ou du type de noisette demandé.
noisette_contextualiser()
Renvoie le contexte de la noisette sous la forme d'un tableau éventuellement vide. Cette fonction gère un cache des contextes non valorisés des types de noisette disponibles.
noisette_contextualiser(string $plugin, array<string|int, mixed> $noisette, string $type_noisette, int $profondeur, array<string|int, mixed> $environnement[, 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.
- $noisette : array<string|int, mixed>
-
Identifiants de la noisette qui prend la forme d'un tableau avec pour index id_noisette, id conteneur et rang_noisette, ce qui permet d'utiliser l'un ou l'autre des identifiants de la noisette.
- $type_noisette : string
-
Identifiant du type de noisette.
- $profondeur : int
-
Profondeur de la noisette. Est inclus systématiquement dans le contexte sous le nom de variable
profondeur_noisette. - $environnement : array<string|int, mixed>
-
Tableau de l'environnement reçu par la noisette.
- $stockage : null|string = ''
-
Identifiant du service de stockage à utiliser si précisé.
Tags
Return values
array<string|int, mixed> —Le tableau éventuellement vide des éléments de contexte de la noisette.
noisette_encapsuler()
Encapsule, si demandé, le contenu compilé d'une ou d'un ensemble de noisettes dans un balisage HTML plus ou moins complexe appelé une capsule.
noisette_encapsuler(string $plugin, string $contenu, string $encapsulation, array<string|int, mixed> $parametres) : string
Une noisette conteneur est considérée comme une capsule et donc traitée en tant que tel.
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.
- $contenu : string
-
Contenu compilé à encapsuler.
- $encapsulation : string
-
Indicateur d'encapsulation du contenu par un capsule ou par une noisette conteneur. Prend les valeurs
oui,non,defautpour une capsule etconteneurpour une noisette conteneur. Ne sert que si le mode d'encapsulation automatique est débrayé. - $parametres : array<string|int, mixed>
-
Liste des paramètres de l'encapsulation. Pour une capsule, les index sont limités à
type_noisette,id_noisette,cssetprofondeur. Pour une noisette conteneur cette liste correspond au champparametresde la noisette, à son type et à sa profondeur.
Tags
Return values
string —Le contenu fourni encapsulé dans un balisage HTML ou tel que fourni en entrée si pas d'encapsulation.