Changeset 113948 in spip-zone


Ignore:
Timestamp:
Feb 17, 2019, 9:26:14 AM (7 months ago)
Author:
eric@…
Message:

Ajout d'un second argument $options optionnel pour le formulaire générique de vidage.
Cet argument est un tableau qui est spécifique au plugin appelant.
Il ne sert qu'à influer sur le chargement du formulaire si besoin (filtre par exemple).
Cet argument n'est pas utilisé par la page générique de vidage.

Location:
_plugins_/cache/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/cache/trunk/cache/cache.php

    r113926 r113948  
    265265 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    266266 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     267 * @param array  $options
     268 *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     269 *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     270 *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
    267271 * @param array  $configuration
    268272 *        Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
     
    271275 *         Description du cache complétée par un ensemble de données propres au plugin.
    272276 */
    273 function cache_cache_vider_charger($plugin, $configuration) {
     277function cache_cache_vider_charger($plugin, $options, $configuration) {
    274278
    275279        // Stocker le préfixe et le nom du plugin de façon systématique.
     
    281285        if ($charger = cache_chercher_service($plugin, 'cache_vider_charger')) {
    282286                // On passe le plugin appelant à la fonction car cela permet ainsi de mutualiser les services de stockage.
    283                 $valeurs_plugin = $charger($plugin, $configuration);
     287                $valeurs_plugin = $charger($plugin, $options, $configuration);
    284288                if ($valeurs_plugin) {
    285289                        $valeurs = array_merge($valeurs, $valeurs_plugin);
  • _plugins_/cache/trunk/formulaires/cache_vider.php

    r113926 r113948  
    11<?php
    22/**
    3  * Gestion du formulaire de vidage des caches d'un plugin donné utilisant Cache Factory.
     3 * Gestion du formulaire générique de vidage des caches d'un plugin donné utilisant Cache Factory.
    44 *
    55 * @package    SPIP\CACHE\API
     
    1313 *
    1414 * @uses cache_obtenir_configuration()
    15  * @uses cache_cache_configurer()
    1615 * @uses cache_cache_vider_charger()
     16 *
     17 * @param string $plugin
     18 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     19 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     20 * @param array  $options
     21 *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     22 *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     23 *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
    1724 *
    1825 * @return array
    1926 *              Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un
    20  *              champ de saisie, celle-ci sont systématiquement remises à zéro.
     27 *              champ de saisie, celle-ci sont systématiquement remises à zéro. Le tableau comprend à minima l'index suivant:
    2128 *              - `_caches`     : (affichage) liste des descriptions des caches rangés par service
    2229 */
    23 function formulaires_cache_vider_charger($plugin) {
     30function formulaires_cache_vider_charger($plugin, $options = array()) {
    2431
    2532        // Lecture de la configuration des caches du plugin.
     
    3037        // soit celui spécifique au plugin si il existe.
    3138        include_spip('cache/cache');
    32         $valeurs = cache_cache_vider_charger($plugin, $configuration);
     39        $valeurs = cache_cache_vider_charger($plugin, $options, $configuration);
    3340
    3441        return $valeurs;
     
    3946 * Vérification des saisies : il est indispensable de choisir un cache à supprimer.
    4047 *
     48 * @param string $plugin
     49 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     50 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     51 * @param array  $options
     52 *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     53 *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     54 *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
     55 *
    4156 * @return array
    4257 *              Tableau des erreurs qui se limite à la non sélection d'au moins un cache.
    4358 */
    44 function formulaires_cache_vider_verifier($plugin) {
     59function formulaires_cache_vider_verifier($plugin, $options = array()) {
    4560
    4661        $erreurs = array();
     
    6075 * @uses cache_vider()
    6176 *
     77 * @param string $plugin
     78 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     79 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     80 * @param array  $options
     81 *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     82 *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     83 *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
     84 *
    6285 * @return array
    6386 *        Tableau retourné par le formulaire contenant toujours un message de bonne exécution. L'indicateur
    6487 *        editable est toujours à vrai.
    6588 */
    66 function formulaires_cache_vider_traiter($plugin) {
     89function formulaires_cache_vider_traiter($plugin, $options = array()) {
    6790
    6891        $retour = array();
  • _plugins_/cache/trunk/paquet.xml

    r113942 r113948  
    22        prefix="cache"
    33        categorie="outil"
    4         version="0.2.3"
     4        version="0.2.4"
    55        etat="test"
    66        compatibilite="[3.0.0;3.2.*]"
Note: See TracChangeset for help on using the changeset viewer.