Documentation du code de SPIP et de ses plugins

Cache Factory

UI

Table of Contents

Functions

formulaires_cache_vider_charger()  : array<string, mixed>
Chargement des données : le formulaire affiche la liste des caches administrables issus de l'utilisation du service et propose le vidage de tout ou partie des fichiers.
formulaires_cache_vider_verifier()  : array<string, mixed>
Vérification des saisies : il est obligatoire de choisir un cache à supprimer.
formulaires_cache_vider_traiter()  : array<string, mixed>
Exécution du formulaire : la liste des caches sélectionnés est récupérée et fournie à l'API cache pour suppression.

Functions

formulaires_cache_vider_charger()

Chargement des données : le formulaire affiche la liste des caches administrables issus de l'utilisation du service et propose le vidage de tout ou partie des fichiers.

formulaires_cache_vider_charger(string $plugin[, null|array<string|int, mixed> $options = [] ]) : array<string, mixed>
Parameters
$plugin : string

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.

$options : null|array<string|int, mixed> = []

Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre. Le tableau est passé à la fonction de service de chargement du formulaire uniquement.

Tags
uses
configuration_cache_lire()
uses
cache_repertorier()
uses
ezcache_chercher_service()
Return values
array<string, mixed>

Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un champ de saisie, celle-ci sont systématiquement remises à zéro. Le tableau comprend à minima l'index suivant:

  • _caches : (affichage) liste des descriptions des caches du plugin rangés par groupes

formulaires_cache_vider_verifier()

Vérification des saisies : il est obligatoire de choisir un cache à supprimer.

formulaires_cache_vider_verifier(string $plugin[, null|array<string|int, mixed> $options = [] ]) : array<string, mixed>
Parameters
$plugin : string

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.

$options : null|array<string|int, mixed> = []

Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre. Le tableau est passé à la fonction de service de chargement du formulaire uniquement.

Return values
array<string, mixed>

Tableau des erreurs qui se limite à la non sélection d'au moins un cache.

formulaires_cache_vider_traiter()

Exécution du formulaire : la liste des caches sélectionnés est récupérée et fournie à l'API cache pour suppression.

formulaires_cache_vider_traiter(string $plugin[, null|array<string|int, mixed> $options = [] ]) : array<string, mixed>
Parameters
$plugin : string

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.

$options : null|array<string|int, mixed> = []

Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre. Le tableau est passé à la fonction de service de chargement du formulaire uniquement.

Tags
uses
cache_vider()
uses
cache_vider()
Return values
array<string, mixed>

Tableau retourné par le formulaire contenant toujours un message de bonne exécution. L'indicateur editable est toujours à vrai.


        
On this page

Search results