N-Core

Un cœur fondant aux noisettes

Version 1.0.3 (6e11cee)

Packages

Reports

Indices

Files

Documentation générée le 04 12 2023 à 08h15

Documentation

Packages

Application
SPIP

Constants

_NCORE_COMPLEMENT_SAISIES_CSS = \true: Mode d'utilisation du pipeline type_noisette_styler. Par défaut à `true`, implique que les saisies en retour du pipeline complètent la saisie libre positionnée par défaut.
_NCORE_ENCAPSULATION_AUTO = \true: Indicateur d'encapsulation automatique. Par défaut à `true`, ce qui implique que toute les noisettes non conteneur sont incluses dans une capsule.

Functions

ncore_cache_configurer() : array<string|int, mixed>: Renvoie la configuration spécifique des caches de N-Core.
formulaires_editer_noisette_saisies_dist() : array<string|int, mixed>: Construction des saisies : les saisies du formulaire sont totalement définies en PHP (le fichier HTML est vide).
formulaires_editer_noisette_charger_dist() : array<string|int, mixed>: Chargement des données : la fonction charge les données d'initialisation des saisies définies dans la fonction `formulaires_editer_noisette_saisies_dist()`.
formulaires_editer_noisette_traiter_dist() : array<string|int, mixed>: Exécution du formulaire : les modifications effectuées sur les paramètres de la noisette sont enregistrés dans l'espace de stockage du plugin utilisateur.
conteneur_identifier() : string: Calcule l'identifiant unique pour le conteneur sous forme de chaine.
conteneur_construire() : array<string|int, mixed>: Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `conteneur_identifier`).
conteneur_est_noisette() : bool: Détermine si un conteneur est une noisette ou pas.
conteneur_vider() : bool: Supprime toutes les noisettes d’un conteneur.
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.
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.
ncore_type_noisette_stocker() : bool: Stocke les descriptions des types de noisette en distinguant les types de noisette obsolètes, les types de noisettes modifiés et les types de noisettes nouveaux.
ncore_type_noisette_styler() : array<string|int, mixed>: Renvoie la liste des saisies permettant de compléter le champ "css_saisies" des styles d'une capsule ou d'une noisette conteneur.
ncore_type_noisette_lister_categories() : array<string|int, mixed>: Renvoie la liste des catégories et leur description.
ncore_type_noisette_completer_description() : array<string|int, mixed>: Complète la description d'un type de noisette issue de la lecture de son fichier YAML.
ncore_type_noisette_traiter_typo() : array<string|int, mixed>: Traite les champs textuels de la description brute d'un type de noisette issue de la lecture de l'espace de stockage avec la fonction typo(). Si le plugin utilisateur complète la description du type de noisette avec de tels champs textuels il doit donc les traiter dans son service dédié.
ncore_type_noisette_decrire() : array<string|int, mixed>: Renvoie la description brute d'un type de noisette sans traitement typo ni désérialisation des champs de type tableau sérialisé.
ncore_type_noisette_lister() : array<string|int, mixed>: Renvoie, pour l'ensemble des types de noisette, l'information demandée ou toute la description. Les données sont renvoyées brutes.
ncore_type_noisette_initialiser_ajax() : bool: Renvoie la configuration par défaut de l'ajax à appliquer pour la compilation des noisettes.
ncore_type_noisette_initialiser_inclusion() : bool: Renvoie la configuration par défaut de l'inclusion dynamique à appliquer pour la compilation des noisettes.
ncore_type_noisette_initialiser_dossier() : string: Renvoie la configuration par défaut du dossier relatif où trouver les types de noisettes.
ncore_noisette_stocker() : int|string: Stocke la description d'une nouvelle noisette et calcule son identifiant unique, ou met à jour les paramètres d'affichage d'une noisette existante.
ncore_noisette_changer_conteneur() : array<string|int, mixed>: Transfère une noisette d'un conteneur vers un autre à un rang donné et met à jour la profondeur.
ncore_noisette_completer_description() : array<string|int, mixed>: Complète la description d'une noisette avec des champs spécifiques au plugin utilisateur, si besoin.
ncore_noisette_completer_action() : void: Complète, si besoin, une action sur une noisette après que l'ensemble des traitements aient été effectués avec succès.
ncore_noisette_initialiser_parametrage() : array<string|int, mixed>: Renvoie la liste des champs éditables pour une noisette. On distingue le cas d'une noisette conteneur ou non.
ncore_noisette_traiter_typo() : array<string|int, mixed>: Traite les champs textuels de la description brute d'une noisette issue de la lecture de l'espace de stockage avec la fonction typo(). Si le plugin utilisateur complète la description de la noisette avec de tels champs textuels il doit donc les traiter dans son service dédié.
ncore_noisette_ranger() : bool: Positionne une noisette à un rang différent de celui qu'elle occupe dans le conteneur.
ncore_noisette_destocker() : bool: Retire, de l'espace de stockage, une noisette donnée de son conteneur.
ncore_noisette_lister() : array<string|int, mixed>: Renvoie un champ ou toute la description des noisettes d'un conteneur ou de tous les conteneurs.
ncore_noisette_decrire() : array<string|int, mixed>: Renvoie la description brute d'une noisette sans traitement typo des champs textuels ni désérialisation des champs de type tableau sérialisé.
ncore_noisette_initialiser_encapsulation() : bool: Renvoie la configuration par défaut de l'encapsulation d'une noisette.
ncore_noisette_verifier_identifiant() : int|string: Détermine si l'identifiant d'une noisette est un entier ou une chaine en fonction de son stockage.
ncore_conteneur_verifier() : array<string|int, mixed>: Vérifie la conformité des index du tableau représentant le conteneur et supprime les index inutiles, si besoin.
ncore_conteneur_identifier() : string: Construit un identifiant unique pour le conteneur sous forme de chaine.
ncore_conteneur_construire() : array<string|int, mixed>: Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `ncore_conteneur_identifier`).
ncore_conteneur_est_noisette() : bool: Détermine si un conteneur est une noisette ou pas. Le conteneur a été vérifié au préalable.
ncore_conteneur_destocker() : bool: Retire, de l'espace de stockage, toutes les noisettes d'un conteneur et ce de façon récursive si il existe une imbrication de conteneurs.
ncore_autoriser() : mixed: Fonction appelée par le pipeline.
autoriser_noisette_editer_dist() : bool: Autorisation d'édition d'une noisette déjà ajoutée dans un conteneur.
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.
balise_CONTENEUR_IDENTIFIER_dist() : Champ: Compile la balise `#CONTENEUR_IDENTIFIER` qui calcule l'identifiant unique d'un conteneur au format chaîne de caractères à partir de la description tabulaire du conteneur.
balise_NOISETTE_COMPILER_dist() : Champ: Compile la balise `#NOISETTE_COMPILER` qui génère l'affichage de la noisette passée en argument.
balise_NOISETTE_PREVIEW_dist() : Champ: Compile la balise `#NOISETTE_PREVIEW` qui génère la prévisualisation de la noisette passée en argument en gérant le fait que le type de noisette soit actif et propose bien un fichier de prévisualisation.
calculer_preview_noisette() : string: Calcule la prévisualisation de la noisette passée en argument.
balise_NOISETTE_REPERTORIER_dist() : Champ: Compile la balise `#NOISETTE_REPERTORIER` qui renvoie la liste des noisettes incluses dans un conteneur donné.

_NCORE_COMPLEMENT_SAISIES_CSS

Mode d'utilisation du pipeline type_noisette_styler. Par défaut à `true`, implique que les saisies en retour du pipeline complètent la saisie libre positionnée par défaut.


    public
        mixed
    _NCORE_COMPLEMENT_SAISIES_CSS
    = \true

_NCORE_ENCAPSULATION_AUTO

Indicateur d'encapsulation automatique. Par défaut à `true`, ce qui implique que toute les noisettes non conteneur sont incluses dans une capsule.


    public
        mixed
    _NCORE_ENCAPSULATION_AUTO
    = \true

ncore_cache_configurer()

Renvoie la configuration spécifique des caches de N-Core.


    
                    ncore_cache_configurer(string $plugin) : 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.

Return values

array<string|int, mixed> —

Tableau de la configuration des caches du plugin N-Core.

formulaires_editer_noisette_saisies_dist()

Construction des saisies : les saisies du formulaire sont totalement définies en PHP (le fichier HTML est vide).


    
                    formulaires_editer_noisette_saisies_dist(string $plugin, int|string $id_noisette[, null|string $redirect = '' ][, null|string $stockage = '' ]) : array<string|int, mixed>

Par défaut, N-Core range les saisies dans trois groupes (fieldsets), à savoir, Contenu, Affichage et Avancé qui ne sont affichés que si il contienne au moins une saisie incluse.

Parameters

$plugin : string: Identifiant qui permet de distinguer le module appelant. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
$id_noisette : int|string: Identifiant unique de la noisette.
$redirect : null|string = '': URL de redirection en sortie du formulaire.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau des saisies constitutives du formulaire

formulaires_editer_noisette_charger_dist()

Chargement des données : la fonction charge les données d'initialisation des saisies définies dans la fonction `formulaires_editer_noisette_saisies_dist()`.


    
                    formulaires_editer_noisette_charger_dist(string $plugin, int|string $id_noisette[, null|string $redirect = '' ][, null|string $stockage = '' ]) : array<string|int, mixed>

Parameters

$plugin : string: Identifiant qui permet de distinguer le module appelant. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
$id_noisette : int|string: Identifiant unique de la noisette.
$redirect : null|string = '': URL de redirection en sortie du formulaire.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau des variables initialisées pour les saisies.

formulaires_editer_noisette_traiter_dist()

Exécution du formulaire : les modifications effectuées sur les paramètres de la noisette sont enregistrés dans l'espace de stockage du plugin utilisateur.


    
                    formulaires_editer_noisette_traiter_dist(string $plugin, int|string $id_noisette[, null|string $redirect = '' ][, null|string $stockage = '' ]) : array<string|int, mixed>

Parameters

$plugin : string: Identifiant qui permet de distinguer le module appelant. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
$id_noisette : int|string: Identifiant unique de la noisette.
$redirect : null|string = '': URL de redirection en sortie du formulaire.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau des messages de fin de traitement.

conteneur_identifier()

Calcule l'identifiant unique pour le conteneur sous forme de chaine.


    
                    conteneur_identifier(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : string

Cette fonction est juste un wrapper pour le service ncore_conteneur_identifier(). Elle est utilisée par les balises #NOISETTE_COMPILER et #CONTENEUR_IDENTIFIER.

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 : array<string|int, mixed>: Tableau associatif descriptif du conteneur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

string —

Identifiant du conteneur ou chaine vide en cas d'erreur.

conteneur_construire()

Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `conteneur_identifier`).


    
                    conteneur_construire(string $plugin, string $id_conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>

Cette fonction est juste un wrapper pour le service ncore_conteneur_construire() mais est très utilisée par les plugins utilisateur.

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_conteneur : string: Identifiant unique du conteneur au format chaine.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau représentatif du conteneur ou tableau vide en cas d'erreur.

conteneur_est_noisette()

Détermine si un conteneur est une noisette ou pas.


    
                    conteneur_est_noisette(string $plugin, array<string|int, mixed>|string $conteneur[, 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.
$conteneur : array<string|int, mixed>|string: Identifiant unique du conteneur ou tableau du conteneur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le conteneur est une noisette false sinon.

conteneur_vider()

Supprime toutes les noisettes d’un conteneur.


    
                    conteneur_vider(string $plugin, array<string|int, mixed>|string $conteneur[, null|string $stockage = '' ]) : bool

L'éventuelle imbrication de conteneurs est gérée dans la fonction de service ncore_conteneur_destocker().

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 : array<string|int, mixed>|string: Tableau descriptif du conteneur ou identifiant du conteneur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le vidage s'est bien passé, false sinon.

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é.

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é.

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é.

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é.

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é.

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é.

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_noisette soit rang_noisette (défaut).
$filtres : null|array<string|int, mixed> = []: Tableau associatif [champ] = valeur de 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é.

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).

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 true force le rechargement de tous les types de noisette, sinon le chargement se base sur le md5 des fichiers YAML. Par défaut vaut false.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

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é.

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] = valeur de 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é.

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, inclusions et contextes. 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.

ncore_type_noisette_stocker()

Stocke les descriptions des types de noisette en distinguant les types de noisette obsolètes, les types de noisettes modifiés et les types de noisettes nouveaux.


    
                    ncore_type_noisette_stocker(string $plugin, array<string|int, mixed> $types_noisette, bool $recharger[, null|string $stockage = '' ]) : bool

Chaque description de type de noisette est un tableau associatif dont tous les index possibles - y compris la signature - sont initialisés quelque soit le contenu du fichier YAML.

Le service N-Core stocke les descriptions dans un cache et les signatures dans un autre.

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.
$types_noisette : array<string|int, mixed>: Tableau associatif à 3 entrées fournissant les descriptions des types de noisettes nouveaux, obsolètes et modifiés: a_effacer : liste des identifiants de type de noisette devenus obsolètes. a_changer : liste des descriptions des types de noisette dont le fichier YAML a été modifié. a_ajouter : liste des descriptions des nouveaux types de noisette. Si $recharger est à true, seul l'index nouvelles est fourni dans le tableau $types_noisette.
$recharger : bool: Indique si le chargement en cours est forcé ou pas. Cela permet à la fonction N-Core ou au service concerné d'optimiser le traitement sachant que seules les types de noisette nouveaux sont fournis.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

ncore_type_noisette_styler()

Renvoie la liste des saisies permettant de compléter le champ "css_saisies" des styles d'une capsule ou d'une noisette conteneur.


    
                    ncore_type_noisette_styler(string $plugin, string $type_noisette[, null|string $stockage = '' ]) : array<string|int, mixed>

Le plugin N-Core fournit par défaut une saisie unique de type input.

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é.

Return values

array<string|int, mixed> —

Liste des saisies applicables.

ncore_type_noisette_lister_categories()

Renvoie la liste des catégories et leur description.


    
                    ncore_type_noisette_lister_categories(string $plugin) : array<string|int, mixed>

Le plugin N-Core fournit une liste limitée par défaut.

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.

Return values

array<string|int, mixed> —

Liste des catégories et de leur description au format [id] = tableau de description avec le nom (label), la description et l'icone.

ncore_type_noisette_completer_description()

Complète la description d'un type de noisette issue de la lecture de son fichier YAML.


    
                    ncore_type_noisette_completer_description(string $plugin, array<string|int, mixed> $description[, null|string $stockage = '' ]) : array<string|int, mixed>

Le service appelle un pipeline homonyme permettant de prolonger les compléments au-delà du plugin utilisateur.

Le plugin N-Core ne complète pas les types de 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.
$description : array<string|int, mixed>: Description du type de noisette issue de la lecture du fichier YAML. Suivant le plugin utilisateur elle nécessite d'être compléter avant son stockage.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Description du type de noisette éventuellement complétée par le plugin utilisateur.

ncore_type_noisette_traiter_typo()

Traite les champs textuels de la description brute d'un type de noisette issue de la lecture de l'espace de stockage avec la fonction typo(). Si le plugin utilisateur complète la description du type de noisette avec de tels champs textuels il doit donc les traiter dans son service dédié.


    
                    ncore_type_noisette_traiter_typo(string $plugin, array<string|int, mixed> $description[, null|string $stockage = '' ]) : array<string|int, mixed>

Le plugin N-Core traite toujours les champs nom et `description.

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.
$description : array<string|int, mixed>: Description brute du type de noisette issue de la lecture dans l'espace de stockage du plugin utilisateur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Description du type de noisette dont les champs textuels ont été traités avec la fonction typo().

ncore_type_noisette_decrire()

Renvoie la description brute d'un type de noisette sans traitement typo ni désérialisation des champs de type tableau sérialisé.


    
                    ncore_type_noisette_decrire(string $plugin, string $type_noisette[, null|string $stockage = '' ]) : array<string|int, mixed>

Le service N-Core lit la description du type de noisette concerné dans le cache des descriptions.

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é.

Return values

array<string|int, mixed> —

Tableau de la description du type de noisette. Les champs textuels et les champs de type tableau sérialisé sont retournés en l'état.

ncore_type_noisette_lister()

Renvoie, pour l'ensemble des types de noisette, l'information demandée ou toute la description. Les données sont renvoyées brutes.


    
                    ncore_type_noisette_lister(string $plugin[, null|string $information = '' ][, 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.
$information : null|string = '': Identifiant d'un champ de la description d'un type de noisette y compris le champ signature. Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est un champ invalide la fonction renvoie un tableau vide.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau de la forme [type_noisette] = information ou description complète ou tableau vide.

ncore_type_noisette_initialiser_ajax()

Renvoie la configuration par défaut de l'ajax à appliquer pour la compilation des noisettes.


    
                    ncore_type_noisette_initialiser_ajax(string $plugin) : bool

Cette information est utilisée si la description YAML d'un type noisette ne contient pas de tag ajax ou contient un tag ajax à defaut.

Le service N-Core considère que toute noisette est par défaut insérée en ajax.

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.

Return values

bool —

true si par défaut une noisette est insérée en ajax, false sinon.

ncore_type_noisette_initialiser_inclusion()

Renvoie la configuration par défaut de l'inclusion dynamique à appliquer pour la compilation des noisettes.


    
                    ncore_type_noisette_initialiser_inclusion(string $plugin) : bool

Cette information est utilisée si la description YAML d'un type noisette ne contient pas de tag inclusion ou contient un tag inclusion à defaut.

Le service N-Core considère que toute noisette est par défaut insérée en dynamique.

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.

Return values

bool —

true si par défaut une noisette est insérée en dynamique, false sinon.

ncore_type_noisette_initialiser_dossier()

Renvoie la configuration par défaut du dossier relatif où trouver les types de noisettes.


    
                    ncore_type_noisette_initialiser_dossier(string $plugin) : string

Cette information est utilisée a minima au chargement des types de noisettes disponibles.

Le service N-Core considère que par défaut le dossier relatif des types de noisette est noisettes/.

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.

Return values

string —

Chemin relatif du dossier où chercher les types de noisette.

ncore_noisette_stocker()

Stocke la description d'une nouvelle noisette et calcule son identifiant unique, ou met à jour les paramètres d'affichage d'une noisette existante.


    
                    ncore_noisette_stocker(string $plugin, array<string|int, mixed> $description[, null|string $stockage = '' ]) : int|string

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.
$description : array<string|int, mixed>: Description de la noisette. Soit la description ne contient pas l'id de la noisette et c'est un ajout, soit la description contient l'id et c'est une mise à jour.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

int|string —

Id de la noisette de type entier ou chaine. Le stockage N-Core renvoie lui une chaine construite à partir du plugin et de la fonction uniqid() ou chaine vide en cas d'erreur.

ncore_noisette_changer_conteneur()

Transfère une noisette d'un conteneur vers un autre à un rang donné et met à jour la profondeur.


    
                    ncore_noisette_changer_conteneur(string $plugin, array<string|int, mixed> $description, string $id_conteneur, int $rang, int $profondeur[, null|string $stockage = '' ]) : array<string|int, mixed>

Le rang destination n'est pas vérifié lors du rangement dans le conteneur destination. Il convient à l'appelant de vérifier que le rang est libre.

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.
$description : array<string|int, mixed>: Description de la noisette à changer de conteneur.
$id_conteneur : string: Identifiant unique sous forme de chaine du conteneur destination.
$rang : int: Rang où positionner la noisette dans le conteneur destination. Il faut toujours vérifier au préalable que ce rang est libre.
$profondeur : int: Profondeur de la noisette à sa nouvelle position.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Description de la noisette mise à jour suite au déplacement.

ncore_noisette_completer_description()

Complète la description d'une noisette avec des champs spécifiques au plugin utilisateur, si besoin.


    
                    ncore_noisette_completer_description(string $plugin, array<string|int, mixed> $description, string $action[, null|string $stockage = '' ]) : array<string|int, mixed>

Le service appelle un pipeline homonyme permettant de prolonger les compléments au-delà du plugin utilisateur.

Le plugin N-Core ne complète pas les descriptions de 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.
$description : array<string|int, mixed>: Description standard de la noisette. Suivant le plugin utilisateur elle nécessite d'être compléter avant son stockage.
$action : string: Nom de l'action initiant la demande de complément : ajouter et parametrer.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Description de la noisette éventuellement complétée par le plugin utilisateur.

ncore_noisette_completer_action()

Complète, si besoin, une action sur une noisette après que l'ensemble des traitements aient été effectués avec succès.


    
                    ncore_noisette_completer_action(string $plugin, array<string|int, mixed> $description, string $action[, null|string $stockage = '' ]) : void

Le service appelle un pipeline homonyme permettant de prolonger l'action au-delà du plugin utilisateur.

Le plugin N-Core ne complète pas ses propres actions.

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.
$description : array<string|int, mixed>: Description de la noisette.
$action : string: Nom de l'action initiant la demande de complément.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

ncore_noisette_initialiser_parametrage()

Renvoie la liste des champs éditables pour une noisette. On distingue le cas d'une noisette conteneur ou non.


    
                    ncore_noisette_initialiser_parametrage(string $plugin, string $est_conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>

Le service appelle un pipeline homonyme permettant de prolonger l'action au-delà du plugin utilisateur.

Le plugin N-Core ne complète pas ses propres actions.

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.
$est_conteneur : string: Indicateur de noisette conteneur ou pas (oui/non).
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Liste des paramètres par défaut d'une noisette, complétée par le plugin utilisateur.

ncore_noisette_traiter_typo()

Traite les champs textuels de la description brute d'une noisette issue de la lecture de l'espace de stockage avec la fonction typo(). Si le plugin utilisateur complète la description de la noisette avec de tels champs textuels il doit donc les traiter dans son service dédié.


    
                    ncore_noisette_traiter_typo(string $plugin, array<string|int, mixed> $description[, null|string $stockage = '' ]) : array<string|int, mixed>

Le plugin N-Core n'a aucun champ textuel à traiter dans la description de base d'une 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.
$description : array<string|int, mixed>: Description brute de la noisette issue de la lecture dans l'espace de stockage du plugin utilisateur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Description du type de noisette dont les champs textuels ont été traités avec la fonction typo().

ncore_noisette_ranger()

Positionne une noisette à un rang différent de celui qu'elle occupe dans le conteneur.


    
                    ncore_noisette_ranger(string $plugin, array<string|int, mixed> $description, int $rang_destination[, 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.
$description : array<string|int, mixed>: Description complète de la noisette.
$rang_destination : int: Position à laquelle ranger la noisette au sein du conteneur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

ncore_noisette_destocker()

Retire, de l'espace de stockage, une noisette donnée de son conteneur.


    
                    ncore_noisette_destocker(string $plugin, array<string|int, mixed> $description[, 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.
$description : array<string|int, mixed>: Description complète de la noisette.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

ncore_noisette_lister()

Renvoie un champ ou toute la description des noisettes d'un conteneur ou de tous les conteneurs.


    
                    ncore_noisette_lister(string $plugin[, null|array<string|int, mixed>|string $conteneur = [] ][, null|string $information = '' ][, null|string $cle = 'rang_noisette' ][, 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 noisette. Les données sont renvoyées brutes.

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.
$information : null|string = '': Identifiant d'un champ de la description d'une noisette. Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est un champ invalide la fonction renvoie un tableau vide.
$cle : null|string = 'rang_noisette': Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit id_noisette soit rang_noisette.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Liste des informations demandées indexé par identifiant de noisette ou par rang. Les données sont renvoyées brutes.

ncore_noisette_decrire()

Renvoie la description brute d'une noisette sans traitement typo des champs textuels ni désérialisation des champs de type tableau sérialisé.


    
                    ncore_noisette_decrire(string $plugin, array<string|int, mixed>|int|string $noisette[, 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>|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 (conteneur, rang de noisette).
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau de la description du type de noisette. Les champs textuels et les champs de type tableau sérialisé sont retournés en l'état.

ncore_noisette_initialiser_encapsulation()

Renvoie la configuration par défaut de l'encapsulation d'une noisette.


    
                    ncore_noisette_initialiser_encapsulation(string $plugin) : bool

Cette information est utilisée si le champ encapsulation de la noisette vaut defaut et si le mode d'encapsulation automatique est débrayé.

Le service N-Core encapsule toujours les noisettes.

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.

Return values

bool —

true si par défaut une noisette est encapsulée, false sinon.

ncore_noisette_verifier_identifiant()

Détermine si l'identifiant d'une noisette est un entier ou une chaine en fonction de son stockage.


    
                    ncore_noisette_verifier_identifiant(string $plugin, int|string $id_noisette, null|string $stockage) : int|string

Le service N-Core considère que l'identifiant d'une noisette est une chaine conformément à son stockage par défaut.

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_noisette : int|string: Identifiant de la noisette à vérifier.
$stockage : null|string: Identifiant du service de stockage à utiliser si précisé.

Return values

int|string —

Identifiant de la noisette vérifié.

ncore_conteneur_verifier()

Vérifie la conformité des index du tableau représentant le conteneur et supprime les index inutiles, si besoin.


    
                    ncore_conteneur_verifier(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>

N-Core vérifie que pour les noisettes conteneur les seuls index sont le type et l'id de la noisette. Pour les autres conteneurs, c'est au plugin utilisateur de vérifier le conteneur.

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 : array<string|int, mixed>: Tableau associatif descriptif du conteneur dont les index vont être vérifiés.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau du conteneur dont tous les index sont conformes ou tableau vide si non conforme.

ncore_conteneur_identifier()

Construit un identifiant unique pour le conteneur sous forme de chaine.


    
                    ncore_conteneur_identifier(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : string

N-Core ne fournit d'identifiant que pour les noisettes conteneur. Pour les autres conteneurs, c'est au plugin utilisateur de calculer l'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.
$conteneur : array<string|int, mixed>: Tableau associatif descriptif du conteneur. Les index sont spécifiques à l'utilisation qui en est faite par le plugin utilisateur. Néanmoins, pour une noisette conteneur, le tableau est limité aux index type de noisette et id de noisette.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

string —

Identifiant du conteneur ou chaine vide en cas d'erreur.

ncore_conteneur_construire()

Reconstruit le conteneur sous forme de tableau canonique à partir de son identifiant unique (fonction inverse de `ncore_conteneur_identifier`).


    
                    ncore_conteneur_construire(string $plugin, string $id_conteneur[, null|string $stockage = '' ]) : array<string|int, mixed>

N-Core ne fournit le tableau que pour les noisettes conteneur. Pour les autres conteneurs, c'est au plugin utilisateur de calculer le tableau.

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_conteneur : string: Identifiant unique du conteneur. Si l'id correspond à une noisette conteneur le traitement sera fait par N-Core, sinon par le plugin utilisateur
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

array<string|int, mixed> —

Tableau représentatif du conteneur ou tableau vide en cas d'erreur.

ncore_conteneur_est_noisette()

Détermine si un conteneur est une noisette ou pas. Le conteneur a été vérifié au préalable.


    
                    ncore_conteneur_est_noisette(string $plugin, array<string|int, mixed> $conteneur[, null|string $stockage = '' ]) : bool

Ce service n'est pas surchargeable par un plugin utilisateur car les noisettes conteneur sont gérées entièrement par N-Core. Son prototype ne nécessite pas les arguments plugin et stockage.

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 : array<string|int, mixed>: Identifiant du conteneur sous forme de tableau canonique.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le conteneur est une noisette false sinon.

ncore_conteneur_destocker()

Retire, de l'espace de stockage, toutes les noisettes d'un conteneur et ce de façon récursive si il existe une imbrication de conteneurs.


    
                    ncore_conteneur_destocker(string $plugin, array<string|int, mixed>|string $conteneur[, 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.
$conteneur : array<string|int, mixed>|string: Tableau descriptif du conteneur ou identifiant du conteneur.
$stockage : null|string = '': Identifiant du service de stockage à utiliser si précisé.

Return values

bool —

true si le traitement s'est bien déroulé, false sinon.

ncore_autoriser()

Fonction appelée par le pipeline.


    
                    ncore_autoriser() : mixed

autoriser_noisette_editer_dist()

Autorisation d'édition d'une noisette déjà ajoutée dans un conteneur.


    
                    autoriser_noisette_editer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

que la noisette existe bien.

Parameters

$faire : string

L'action : l'édition (editer)

$type : string

Le type d'objet ou nom de table : une noisette

$id : int

Id de l'objet sur lequel on veut agir : identifiant de la noisette

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin et stockage

Return values

bool —

true si autorisé, false sinon.

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é.

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é.

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.

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é.

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, defaut pour une capsule et conteneur pour 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, css et profondeur. Pour une noisette conteneur cette liste correspond au champ parametres de la noisette, à son type et à sa profondeur.

Return values

string —

Le contenu fourni encapsulé dans un balisage HTML ou tel que fourni en entrée si pas d'encapsulation.

balise_CONTENEUR_IDENTIFIER_dist()

Compile la balise `#CONTENEUR_IDENTIFIER` qui calcule l'identifiant unique d'un conteneur au format chaîne de caractères à partir de la description tabulaire du conteneur.


    
                    balise_CONTENEUR_IDENTIFIER_dist(Champ $p) : Champ

La signature de la balise est : #CONTENEUR_IDENTIFIER{plugin, conteneur[, stockage]}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

balise_NOISETTE_COMPILER_dist()

Compile la balise `#NOISETTE_COMPILER` qui génère l'affichage de la noisette passée en argument.


    
                    balise_NOISETTE_COMPILER_dist(Champ $p) : Champ

La signature de la balise est : #NOISETTE_COMPILER{id_noisette[, stockage]}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

balise_NOISETTE_PREVIEW_dist()

Compile la balise `#NOISETTE_PREVIEW` qui génère la prévisualisation de la noisette passée en argument en gérant le fait que le type de noisette soit actif et propose bien un fichier de prévisualisation.


    
                    balise_NOISETTE_PREVIEW_dist(Champ $p) : Champ

La signature de la balise est : #NOISETTE_PREVIEW{id_noisette, type_noisette_actif, plugins_necessites}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

calculer_preview_noisette()

Calcule la prévisualisation de la noisette passée en argument.


    
                    calculer_preview_noisette(string $plugin, array<string|int, mixed> $noisette, string $type_noisette_actif, string $type_noisette_necessite) : string

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>: Tableau associatif descriptif de la noisette : les deux identifiants et le type de noisette.
$type_noisette_actif : string: Indique si le type de noisette est actif ou pas (au moins un plugin nécessité est désactivé). Prend les valeurs oui ou non.
$type_noisette_necessite : string: Tableau sérialisé des plugins necessités par le type de noisette. Sert uniquement à afficher l'avertissement éventuel sur les plugins inactifs.

Return values

string —

Code HTML de prévisualisation de la noisette.

balise_NOISETTE_REPERTORIER_dist()

Compile la balise `#NOISETTE_REPERTORIER` qui renvoie la liste des noisettes incluses dans un conteneur donné.


    
                    balise_NOISETTE_REPERTORIER_dist(Champ $p) : Champ

La signature de la balise est : #NOISETTE_REPERTORIER{plugin, conteneur[, stockage]}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

Documentation

Table of Contents

Packages

Constants

Functions

Constants

_NCORE_COMPLEMENT_SAISIES_CSS

_NCORE_ENCAPSULATION_AUTO

Functions

ncore_cache_configurer()

Parameters

Return values

formulaires_editer_noisette_saisies_dist()

Parameters

Tags

Return values

formulaires_editer_noisette_charger_dist()

Parameters

Tags

Return values

formulaires_editer_noisette_traiter_dist()

Parameters

Tags

Return values

conteneur_identifier()

Parameters

Tags

Return values

conteneur_construire()

Parameters

Tags

Return values

conteneur_est_noisette()

Parameters

Tags

Return values

conteneur_vider()

Parameters

Tags

Return values

noisette_ajouter()

Parameters

Tags

Return values

noisette_parametrer()

Parameters

Tags

Return values

noisette_supprimer()

Parameters

Tags

Return values

noisette_lire()

Parameters

Tags

Return values

noisette_deplacer()

Parameters

Tags

Return values

noisette_dupliquer()

Parameters

Tags

Return values

noisette_repertorier()

Parameters

Tags

Return values

type_noisette_charger()

Parameters

Tags

Return values

type_noisette_lire()

Parameters

Tags

Return values

type_noisette_repertorier()

Parameters

Tags

Return values