SERVICE
Table of Contents
Functions
- 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.
Functions
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'indexnouvellesest 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é.
Tags
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é.
Tags
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.
Tags
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é.
Tags
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é.
Tags
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é.
Tags
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é.
Tags
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.
Tags
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.
Tags
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.
Tags
Return values
string —Chemin relatif du dossier où chercher les types de noisette.