ezrest.php
Ce fichier contient les fonctions de service nécessitées par le plugin Cache Factory.
Table of Contents
Functions
- ezrest_cache_configurer() : array<string, mixed>
- Renvoie la configuration spécifique des caches gérés par REST Factory si les fonctions de collection des données sont directement codés en PHP.
- ezrest_reponse_cache_formulaire_charger() : array<string, mixed>
- Effectue le chargement du formulaire de vidage des caches de type `reponse` pour le plugin REST Factory.
- ezrest_index_cache_formulaire_charger() : array<string, mixed>
- Effectue le chargement du formulaire de vidage des caches de type `index` pour le plugin REST Factory.
Functions
ezrest_cache_configurer()
Renvoie la configuration spécifique des caches gérés par REST Factory si les fonctions de collection des données sont directement codés en PHP.
ezrest_cache_configurer(string $plugin) : array<string, mixed>
Dans le cas où les données JSON sont créées via des squelettes SPIP, le cache est déjà géré par SPIP.
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, mixed> —Tableau de la configuration brute du plugin Taxonomie.
ezrest_reponse_cache_formulaire_charger()
Effectue le chargement du formulaire de vidage des caches de type `reponse` pour le plugin REST Factory.
ezrest_reponse_cache_formulaire_charger(string $plugin, array<string, mixed> $valeurs, array<string|int, mixed> $options, array<string, mixed> $configuration) : array<string, mixed>
L'intérêt est de permette le rangement des caches par type de requête.
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, 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, mixed>
-
Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
Tags
Return values
array<string, mixed> —Tableau des valeurs du formulaire complété par la structure propre au type de cache.
ezrest_index_cache_formulaire_charger()
Effectue le chargement du formulaire de vidage des caches de type `index` pour le plugin REST Factory.
ezrest_index_cache_formulaire_charger(string $plugin, array<string, mixed> $valeurs, array<string|int, mixed> $options, array<string, mixed> $configuration) : array<string, mixed>
L'index est unique et comme sa suppression peut être sensible, le formulaire affiche un avertissement.
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, 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, mixed>
-
Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
Tags
Return values
array<string, mixed> —Tableau des valeurs du formulaire complété par la structure propre au type de cache.