N-Core

ncore.php

Ce fichier contient les fonctions de service N-Core pour les types de noisettes, les conteneurs et les noisettes.

Chaque fonction, soit aiguille, si elle existe, vers une fonction "homonyme" propre au plugin appelant ou à un autre service de stockage, soit déroule sa propre implémentation. Ainsi, les plugins externes peuvent, si elle leur convient, utiliser l'implémentation proposée par N-Core en codant un minimum de fonctions.

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.

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.
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_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_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.php

Table of Contents

Constants

Functions

Constants

_NCORE_COMPLEMENT_SAISIES_CSS

Functions

ncore_type_noisette_stocker()

Parameters

Tags

Return values

ncore_type_noisette_styler()

Parameters

Tags

Return values

ncore_type_noisette_lister_categories()

Parameters

Tags

Return values

ncore_type_noisette_completer_description()

Parameters

Tags

Return values

ncore_type_noisette_traiter_typo()

Parameters

Tags

Return values

ncore_type_noisette_decrire()

Parameters

Tags

Return values

ncore_type_noisette_lister()

Parameters

Tags

Return values

ncore_type_noisette_initialiser_ajax()

Parameters

Tags

Return values

ncore_type_noisette_initialiser_inclusion()

Parameters

Tags

Return values

ncore_type_noisette_initialiser_dossier()

Parameters

Tags

Return values

ncore_noisette_stocker()

Parameters

Tags

Return values

ncore_noisette_changer_conteneur()

Parameters

Tags

Return values

ncore_noisette_completer_description()

Parameters

Tags

Return values

ncore_noisette_completer_action()

Parameters

Tags

ncore_noisette_initialiser_parametrage()

Parameters

Tags

Return values

ncore_noisette_traiter_typo()

Parameters

Tags

Return values

ncore_noisette_ranger()

Parameters

Tags

Return values

ncore_noisette_destocker()

Parameters

Tags

Return values

ncore_noisette_lister()

Parameters