Browse Source

On isole les fonctions conteneur dans un fichier à part.

Quelques pétouilles de PHPDoc.
Mise à jour du guide de conception.
svn/root/tags/v0.10.0
eric@smellup.net 5 years ago
parent
commit
d2b0281955
  1. BIN
      Guide N - Le plugin N-Core.pdf
  2. 44
      inc/ncore_conteneur.php
  3. 35
      inc/ncore_noisette.php
  4. 1
      inc/ncore_type_noisette.php
  5. 2
      ncore/ncore.php

BIN
Guide N - Le plugin N-Core.pdf

Binary file not shown.

44
inc/ncore_conteneur.php

@ -0,0 +1,44 @@
<?php
/**
* Ce fichier contient l'API N-Core de gestion des conteneurs.
*
* @package SPIP\NCORE\API\CONTENEUR
*/
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 $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;
}

35
inc/ncore_noisette.php

@ -383,38 +383,3 @@ function noisette_deplacer($plugin, $noisette, $rang_destination, $stockage = ''
return $retour;
}
/**
* Supprime toutes les noisettes d’un conteneur.
*
* @api
* @uses ncore_noisette_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 $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 noisette_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;
}

1
inc/ncore_type_noisette.php

@ -96,6 +96,7 @@ function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = fa
include_spip('inc/yaml');
$description = yaml_charger_inclusions(yaml_decode_file($_chemin));
// TODO : ne faudrait-il pas "valider" le fichier YAML ici ou alors lors du stockage ?
// Traitements des champs pouvant être soit une chaine soit un tableau
if (!empty($description['necessite']) and is_string($description['necessite'])) {
$description['necessite'] = array($description['necessite']);

2
ncore/ncore.php

@ -389,7 +389,7 @@ function ncore_noisette_completer($plugin, $description, $stockage = '') {
/**
* Positionne une noisette à un rang différent que celui qu'elle occupe dans le conteneur.
* Positionne une noisette à un rang différent de celui qu'elle occupe dans le conteneur.
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*

Loading…
Cancel
Save