Fichier inc/ncore_conteneur.php

Ce fichier contient l'API N-Core de gestion des conteneurs.

Toutes ces fonctions sont aussi exposées en tant que filtres.

Source

Liste des fonctions

APIs

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

array conteneur_construire( string $plugin , string $id_conteneur , string $stockage = '' )

Paramètres

  1. string $plugin

    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.

  2. string $id_conteneur

    Identifiant unique du conteneur au format chaine.

  3. string $stockage = ''

    Identifiant du service de stockage à utiliser si précisé.

Retour

  • array

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

API

Package

Filtre

  • conteneur_construire
boolean conteneur_est_noisette( string $plugin , string | array $conteneur , string $stockage = '' )

Paramètres

  1. string $plugin

    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.

  2. string | array $conteneur

    Identifiant unique du conteneur ou tableau du conteneur.

  3. string $stockage = ''

    Identifiant du service de stockage à utiliser si précisé.

Retour

  • boolean

    true si le conteneur est une noisette false sinon.

API

Package

Filtre

  • conteneur_est_noisette

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

string conteneur_identifier( string $plugin , array $conteneur , string $stockage = '' )

Paramètres

  1. string $plugin

    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.

  2. array $conteneur

    Tableau associatif descriptif du conteneur.

  3. string $stockage = ''

    Identifiant du service de stockage à utiliser si précisé.

Retour

  • string

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

API

Package

Filtre

  • conteneur_identifier

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

boolean conteneur_vider( string $plugin , array | string $conteneur , string $stockage = '' )

Paramètres

  1. string $plugin

    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.

  2. array | string $conteneur

    Tableau descriptif du conteneur ou identifiant du conteneur.

  3. string $stockage = ''

    Identifiant du service de stockage à utiliser si précisé.

Retour

  • boolean

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

API

Package

Filtre

  • conteneur_vider