SPIP Code

Documentation du code de SPIP et de ses plugins

Cache Factory

ezcache_cache.php

Ce fichier contient les fonctions d'API du plugin Cache Factory.

Table of Contents

Functions

cache_ecrire()  : bool
Ecrit un contenu donné dans un cache spécifié par son identifiant relatif ou par son chemin complet.
cache_lire()  : array<string|int, mixed>|bool|string
Lit le cache spécifié par son identifiant relatif ou son chemin complet et renvoie le contenu sous forme de tableau ou de chaine suivant l’attribut de sérialisation.
cache_est_valide()  : string
Teste l'existence d'un cache sur le disque spécifié par son identifiant relatif ou par son chemin complet et, si il existe, teste si la date d'expiration du fichier n'est pas dépassée. Si le fichier existe et n'est pas périmé, la fonction renvoie le chemin complet, sinon elle renvoie une chaine vide.
cache_nommer()  : string
Renvoie le chemin complet du cache sans tester son existence.
cache_supprimer()  : bool
Supprime le cache spécifié par son identifiant relatif ou par son chemin complet.
cache_repertorier()  : array<string|int, mixed>
Retourne la description des caches d'un plugin utilisateur filtrée sur un ensemble de critères. La description de base fournie par Cache Factory contient les éléments de l’identifiant relatif mais peut-être remplacée ou complétée par le plugin appelant au travers de services propres.
cache_vider()  : bool
Supprime, pour un plugin donné, les caches désignés par leur chemin complet.
configuration_cache_recharger()  : void
Recharge les configurations standard des types de cache d'un plugin utilisateur ou de tous les plugins utilisateur ayant enregistrés une configuration.
configuration_cache_lire()  : array<string, mixed>
Lit la configuration standard d'un type de cache d'un plugin utilisateur, de tous les types de caches ou de tous les plugins utilisateur ayant enregistrés une configuration.
configuration_cache_effacer()  : bool
Efface les configurations standard de types de cache d'un plugin utilisateur ou de tous les plugins utilisateur ayant enregistrés une configuration.
configuration_codage_csv_lire()  : array<string, mixed>
Lit la configuration du délimiteur CSV correspondant au codage (`csv`, `ssv`, ou `tsv`).

Functions

cache_ecrire()

Ecrit un contenu donné dans un cache spécifié par son identifiant relatif ou par son chemin complet.

cache_ecrire(string $plugin, string $type_cache, array<string, mixed>|string $cache, array<string|int, mixed>|string $contenu[, null|bool $post_cache = true ]) : bool
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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

$cache : array<string, mixed>|string

Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant les composants canoniques du nom.

$contenu : array<string|int, mixed>|string

Contenu sous forme de tableau à sérialiser/encoder ou sous la forme d'une chaine.

$post_cache : null|bool = true

true si on doit appeler le pipeline post_cache ou false sinon. Le défaut vaut true. Permet d'utiliser l'API dans le pipeline post_cache.

Tags
uses
configuration_cache_lire()
uses
ezcache_cache_verifier()
uses
ezcache_cache_composer()
uses
ezcache_cache_decomposer()
uses
sous_repertoire()
uses
ecrire_fichier()
uses
ecrire_fichier_securise()
Return values
bool —

True si l'écriture s'est bien passée, false sinon.

cache_lire()

Lit le cache spécifié par son identifiant relatif ou son chemin complet et renvoie le contenu sous forme de tableau ou de chaine suivant l’attribut de sérialisation.

cache_lire(string $plugin, string $type_cache, array<string, mixed>|string $cache) : array<string|int, mixed>|bool|string

En cas d’erreur, la fonction renvoie false.

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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

$cache : array<string, mixed>|string

Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant les composants canoniques du nom.

Tags
uses
configuration_cache_lire()
uses
ezcache_cache_verifier()
uses
ezcache_cache_composer()
uses
lire_fichier()
uses
lire_fichier_securise()
uses
ezcache_cache_decoder()
throws
Exception
Return values
array<string|int, mixed>|bool|string —

Contenu du fichier sous la forme d'un tableau, d'une chaine ou false si une erreur s'est produite.

cache_est_valide()

Teste l'existence d'un cache sur le disque spécifié par son identifiant relatif ou par son chemin complet et, si il existe, teste si la date d'expiration du fichier n'est pas dépassée. Si le fichier existe et n'est pas périmé, la fonction renvoie le chemin complet, sinon elle renvoie une chaine vide.

cache_est_valide(string $plugin, string $type_cache, array<string, mixed>|string $cache) : string
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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

$cache : array<string, mixed>|string

Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant les composants canoniques du nom.

Tags
uses
configuration_cache_lire()
uses
ezcache_cache_composer()
uses
ezcache_cache_valider()
Return values
string —

Le chemin complet du fichier si valide, la chaine vide sinon.

cache_nommer()

Renvoie le chemin complet du cache sans tester son existence.

cache_nommer(string $plugin, string $type_cache, array<string, mixed> $cache) : string

Cette fonction est une encapsulation du service ezcache_cache_composer().

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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

$cache : array<string, mixed>

Identifiant du cache sous la forme d'un tableau fournissant les composants canoniques du nom.

Tags
uses
configuration_cache_lire()
uses
ezcache_cache_verifier()
uses
ezcache_cache_composer()
Return values
string —

Chemin complet du fichier cache

cache_supprimer()

Supprime le cache spécifié par son identifiant relatif ou par son chemin complet.

cache_supprimer(string $plugin, string $type_cache, array<string, mixed>|string $cache[, null|bool $post_cache = true ]) : bool
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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

$cache : array<string, mixed>|string

Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant les composants canoniques du nom.

$post_cache : null|bool = true

true si on doit appeler le pipeline post_cache ou false sinon. Le défaut vaut true. Permet d'utiliser l'API dans le pipeline post_cache.

Tags
uses
configuration_cache_lire()
uses
ezcache_cache_verifier()
uses
ezcache_cache_composer()
uses
ezcache_cache_decomposer()
uses
supprimer_fichier()
Return values
bool —

true si la suppression s'est bien passée, false sinon.

cache_repertorier()

Retourne la description des caches d'un plugin utilisateur filtrée sur un ensemble de critères. La description de base fournie par Cache Factory contient les éléments de l’identifiant relatif mais peut-être remplacée ou complétée par le plugin appelant au travers de services propres.

cache_repertorier(string $plugin, string $type_cache[, null|array<string, mixed> $filtres = [] ]) : array<string|int, mixed>

Les filtres concernent uniquement les éléments de l’identifiant relatif.

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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

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

Tableau associatif [champ] = valeur ou [champ] = !valeur de critères de filtres sur les composants de caches. Les opérateurs égalité et inégalité sont possibles.

Tags
uses
configuration_cache_lire()
uses
ezcache_cache_decomposer()
uses
ezcache_cache_completer()
used-by
formulaires_cache_vider_charger()
Return values
array<string|int, mixed> —

Tableau des descriptions des fichiers cache créés par le plugin indexé par le chemin complet de chaque fichier cache.

cache_vider()

Supprime, pour un plugin donné, les caches désignés par leur chemin complet.

cache_vider(string $plugin, string $type_cache, array<string|int, mixed> $caches[, null|bool $post_cache = true ]) : bool
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.

$type_cache : string

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin

$caches : array<string|int, mixed>

Liste des fichiers caches désignés par leur chemin complet.

$post_cache : null|bool = true

true si on doit appeler le pipeline post_cache ou false sinon. Le défaut vaut true. Permet d'utiliser l'API dans le pipeline post_cache.

Tags
uses
configuration_cache_lire()
uses
supprimer_fichier()
uses
ezcache_cache_decomposer()
used-by
formulaires_cache_vider_traiter()
used-by
formulaires_cache_vider_traiter()
Return values
bool —

true si la suppression s'est bien passée, false sinon.

configuration_cache_recharger()

Recharge les configurations standard des types de cache d'un plugin utilisateur ou de tous les plugins utilisateur ayant enregistrés une configuration.

configuration_cache_recharger([null|string $plugin = '' ]) : void
Parameters
$plugin : null|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. Si vide, toutes les configurations sont rechargées.

Tags
uses
ezcache_cache_configurer()

configuration_cache_lire()

Lit la configuration standard d'un type de cache d'un plugin utilisateur, de tous les types de caches ou de tous les plugins utilisateur ayant enregistrés une configuration.

configuration_cache_lire([null|string $plugin = '' ][, null|string $type_cache = '' ]) : array<string, mixed>
Parameters
$plugin : null|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. Si vide, toutes les configurations sont fournies.

$type_cache : null|string = ''

Type de cache identifiant la configuration dans la liste des configurations de cache du plugin Si vide toutes les configurations du plugin sont renvoyées.

Tags
uses
lire_config()
uses
ezcache_cache_configurer()
used-by
ezcache_affiche_milieu()
used-by
formulaires_cache_vider_charger()
used-by
cache_ecrire()
used-by
cache_lire()
used-by
cache_est_valide()
used-by
cache_nommer()
used-by
cache_supprimer()
used-by
cache_repertorier()
used-by
cache_vider()
Return values
array<string, mixed> —

Tableau de configuration des caches d'un plugin utilisateur ou tableau vide si aucune configuration n'est encore enregistrée.

configuration_cache_effacer()

Efface les configurations standard de types de cache d'un plugin utilisateur ou de tous les plugins utilisateur ayant enregistrés une configuration.

configuration_cache_effacer([null|string $plugin = '' ]) : bool
Parameters
$plugin : null|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. Si vide, toutes les configurations sont effacées.

Tags
uses
lire_config()
uses
effacer_config()
used-by
ezcache_affiche_milieu()
Return values
bool —

true si la suppression s'est bien passée, false sinon.

configuration_codage_csv_lire()

Lit la configuration du délimiteur CSV correspondant au codage (`csv`, `ssv`, ou `tsv`).

configuration_codage_csv_lire() : array<string, mixed>
Return values
array<string, mixed> —

Tableau de configuration du codage CSV qui définit le délimiteur.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results