Changeset 110839 in spip-zone

Timestamp:

Jun 24, 2018, 2:51:43 PM (3 years ago)

Author:

eric@…

Message:

Mise au point de la fonction d'API noisette_parametrer() qui clot le sujet.
Update du guide de conception.

Location:

_plugins_/n-core/trunk

Files:

• Guide N - Le plugin N-Core.pdf (modified) (previous)
• inc/ncore_noisette.php (modified) (1 diff)
• paquet.xml (modified) (1 diff)
• public/noisette_preview.php (modified) (1 diff)

_plugins_/n-core/trunk/inc/ncore_noisette.php

@@ -126 +126 @@
 
 /**
+ * Met à jour les paramètres éditables d'une noisette donnée.
+ * La fonction contrôle la liste des champs modifiables.
+ *
+ * @api
+ * @uses ncore_noisette_decrire()
+ * @uses ncore_noisette_stocker()
+ *
+ * @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 mixed  $noisette
+ *        Identifiant de la noisette qui peut prendre soit la forme d'un entier ou d'une chaine unique, soit la forme
+ *        d'un couple (id conteneur, rang).
+ * @param array  $modifications
+ *        Tableau des couples (champ, valeur) à mettre à jour pour la noisette spécifiée.
+ *        La fonction contrôle la liste des champs éditables en filtrant les champs standard comme `parametres`,
+ *        `balise`, `css` et éventuellement ceux spécifiquement définis par le plugin utilisateur dans
+ *        l'argument $editables_specifiques.
+ * @param array  $editables_specifiques
+ *        Liste de champs éditables spécifiques au plugin utilisateur ou tableau vide sinon.
+ * @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_parametrer($plugin, $noisette, $modifications, $editables_specifiques = array(), $stockage = '') {
+
+        // Initialisation du retour
+        $retour = false;
+
+        // On charge les services de N-Core.
+        // Ce sont ces fonctions qui aiguillent ou pas vers un service spécifique du plugin.
+        include_spip('ncore/ncore');
+
+        // L'identifiant d'une noisette peut être fourni de deux façons :
+        // - par une valeur unique, celle créée lors de l'ajout et qui peut-être un entier (id d'une table SPIP) ou
+        //   une chaine unique par exemple générée par uniqid().
+        // - ou par un tableau à deux entrées fournissant le conteneur et le rang dans le conteneur
+        //   (qui est unique pour un conteneur donné).
+        if (!empty($noisette) and (is_string($noisette) or is_numeric($noisette) or is_array($noisette))) {
+                // On récupère la description complète de la noisette avant de modifier les champs éditables spécifiés.
+                $description = ncore_noisette_decrire($plugin, $noisette, $stockage);
+
+                // On contrôle les champs éditables et on met à jour la description de la noisette.
+                $parametres = array_merge(array('parametres', 'balise', 'css'), $editables_specifiques);
+                $modifications = array_intersect_key($modifications, array_flip($parametres));
+                $description = array_merge($description, $modifications);
+
+                // La description est prête à être stockée en remplacement de l'existante.
+                if ($id_noisette = ncore_noisette_stocker($plugin, $description, $stockage)) {
+                        $retour = true;
+                }
+        }
+
+        return $retour;
+}
+
+/**
  * Supprime une noisette donnée du conteneur auquel elle est associée et, si cette noisette est un conteneur,
  * le vide de ses noisettes au préalable.

_plugins_/n-core/trunk/paquet.xml

@@ -2 +2 @@
         prefix="ncore"
         categorie="outil"
-        version="0.4.2"
+        version="0.4.3"
         etat="dev"
         compatibilite="[3.2.0;3.2.*]"

_plugins_/n-core/trunk/public/noisette_preview.php

@@ -8 +8 @@
  * Compile la balise `#NOISETTE_PREVIEW` qui génère la prévisualisation de la noisette passée en argument
  * en gérant le fait que la type de noisette soit actif et propose bien un fichier de prévisualisation.
- * La signature de la balise est : `#NOISETTE_PREVIEW{id_noisette, type_noisette_actif}`.
+ * La signature de la balise est : `#NOISETTE_PREVIEW{id_noisette, type_noisette_actif, plugins_necessites}`.
  *
  * @package SPIP\NCORE\NOISETTE\BALISE