You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

45 lines
1.3 KiB

<?php
/**
* Ce fichier contient l'API N-Core de gestion des conteneurs.
*
* @package SPIP\NCORE\CONTENEUR\API
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
/**
* Supprime toutes les noisettes d’un conteneur.
*
* @api
* @uses ncore_conteneur_destocker()
*
* @param 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.
* @param array|string $conteneur
* Tableau descriptif du conteneur ou identifiant du conteneur.
* @param string $stockage
* 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 bool
*/
function conteneur_vider($plugin, $conteneur, $stockage = '') {
// Initialisation du retour
$retour = false;
// On charge l'API de N-Core.
// Ce sont ces fonctions qui aiguillent ou pas vers une fonction spécifique du service.
include_spip('ncore/ncore');
if ($conteneur) {
$retour = ncore_conteneur_destocker($plugin, $conteneur, $stockage);
}
return $retour;
}