Documentation du code de SPIP et de ses plugins

Rainette

rainette.php

Ce fichier contient les fonctions de service nécessitées par le plugin Cache Factory.

Table of Contents

Functions

rainette_cache_configurer()  : array<string|int, mixed>
Renvoie la configuration spécifique des caches de Rainette.
rainette_meteo_cache_formulaire_charger()  : array<string|int, mixed>
Effectue le chargement du formulaire de vidage des caches de type `meteo` du plugin.

Functions

rainette_cache_configurer()

Renvoie la configuration spécifique des caches de Rainette.

rainette_cache_configurer(string $plugin) : array<string|int, 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.

Return values
array<string|int, mixed>

Tableau de la configuration des types de cache du plugin.

rainette_meteo_cache_formulaire_charger()

Effectue le chargement du formulaire de vidage des caches de type `meteo` du plugin.

rainette_meteo_cache_formulaire_charger(string $plugin, array<string|int, mixed> $valeurs, array<string|int, mixed> $options, array<string|int, mixed> $configuration) : array<string|int, mixed>

L'intérêt est de permette le rangement des caches par service.

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.

$valeurs : array<string|int, mixed>

Tableau des valeurs du formulaire à compléter

$options : 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.

$configuration : array<string|int, mixed>

Configuration complète des caches du type meteo du plugin utilisateur lue à partir de la meta de stockage.

Tags
uses
rainette_lister_services()
uses
cache_repertorier()
Return values
array<string|int, mixed>

Tableau des caches de type meteo.


        
On this page

Search results