Documentation du code de SPIP et de ses plugins

SPIP

Cache

Table of Contents

Constants

_AGE_CACHE_ATIME  = 3600

Functions

action_calculer_taille_cache_dist()  : mixed
Calculer la taille du cache ou du cache image pour l'afficher en ajax sur la page d'admin de SPIP
calculer_taille_dossier()  : int
Calculer la taille d'un dossier, sous dossiers inclus
action_purger_dist()  : mixed
Action de purge du cache
taille_du_cache()  : int
Évalue approximativement la taille du cache
inc_suivre_invalideur_dist()  : mixed
Invalider les caches liés à telle condition
purger_repertoire()  : int
Purge un répertoire de ses fichiers
inc_retire_caches_dist()  : mixed
retire_caches()  : mixed
calcul_invalideurs()  : mixed
supprime_invalideurs()  : mixed
maj_invalideurs()  : mixed
insere_invalideur()  : mixed
applique_invalideur()  : mixed
suivre_invalideur()  : mixed

Constants

Functions

action_calculer_taille_cache_dist()

Calculer la taille du cache ou du cache image pour l'afficher en ajax sur la page d'admin de SPIP

action_calculer_taille_cache_dist([string|null $arg = null ]) : mixed

Si l'argument reçu est 'images', c'est la taille du cache _DIR_VAR qui est calculé, sinon celle du cache des squelettes (approximation)

Parameters
$arg : string|null = null

Argument attendu. En absence utilise l'argument de l'action sécurisée.

calculer_taille_dossier()

Calculer la taille d'un dossier, sous dossiers inclus

calculer_taille_dossier(string $dir) : int
Parameters
$dir : string

Répertoire dont on souhaite évaluer la taille

Return values
int

Taille en octets

action_purger_dist()

Action de purge du cache

action_purger_dist([string|null $arg = null ]) : mixed

L'argument peut être :

  • inhibe_cache : inhibe le cache pendant 24h
  • reactive_cache : enlève l'inhibition du cache
  • cache : nettoie tous les caches (sauf celui des vignettes)
  • squelettes : nettoie le cache de compilation des squelettes
  • vignettes : nettoie le cache des vignettes (et compressions css/js)
Parameters
$arg : string|null = null

Argument attendu. En absence utilise l'argument de l'action sécurisée.

Tags
pipeline_appel

trig_purger

uses
supprime_invalideurs()
uses
purger_repertoire()

taille_du_cache()

Évalue approximativement la taille du cache

taille_du_cache() : int

Pour de gros volumes, impossible d'ouvrir chaque fichier, on y va donc à l'estime !

Return values
int

Taille approximative en octets

inc_suivre_invalideur_dist()

Invalider les caches liés à telle condition

inc_suivre_invalideur_dist(string $cond[, bool $modif = true ]) : mixed

Les invalideurs sont de la forme 'objet/id_objet'. La condition est géneralement "id='objet/id_objet'".

Ici on se contente de noter la date de mise à jour dans les metas, pour le type d'objet en question (non utilisé cependant) et pour tout le site (sur la meta derniere_modif)

Parameters
$cond : string

Condition d'invalidation

$modif : bool = true

Inutilisé

Tags
global

array $derniere_modif_invalide Par défaut à true, la meta derniere_modif est systématiquement calculée dès qu'un invalideur se présente. Cette globale peut être mise à false (aucun changement sur derniere_modif) ou sur une liste de type d'objets (changements uniquement lorsqu'une modification d'un des objets se présente).

purger_repertoire()

Purge un répertoire de ses fichiers

purger_repertoire(string $dir[, array<string|int, mixed> $options = [] ]) : int

Utilisée entre autres pour vider le cache depuis l'espace privé

Parameters
$dir : string

Chemin du répertoire à purger

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

Tableau des options. Peut être :

  • atime : timestamp pour ne supprimer que les fichiers antérieurs à cette date (via fileatime)
  • mtime : timestamp pour ne supprimer que les fichiers antérieurs à cette date (via filemtime)
  • limit : nombre maximum de suppressions
Tags
uses
supprimer_fichier()
used-by
action_purger_dist()
used-by
appliquer_modifs_config()
Return values
int

Nombre de fichiers supprimés

inc_retire_caches_dist()

inc_retire_caches_dist([mixed $chemin = '' ]) : mixed
Parameters
$chemin : mixed = ''

retire_caches()

retire_caches([mixed $chemin = '' ]) : mixed
Parameters
$chemin : mixed = ''

calcul_invalideurs()

calcul_invalideurs(mixed $corps, mixed $primary, mixed &$boucles, mixed $id_boucle) : mixed
Parameters
$corps : mixed
$primary : mixed
$boucles : mixed
$id_boucle : mixed

maj_invalideurs()

maj_invalideurs(mixed $fichier, mixed &$page) : mixed
Parameters
$fichier : mixed
$page : mixed

insere_invalideur()

insere_invalideur(mixed $inval, mixed $fichier) : mixed
Parameters
$inval : mixed
$fichier : mixed

applique_invalideur()

applique_invalideur(mixed $depart) : mixed
Parameters
$depart : mixed

suivre_invalideur()

suivre_invalideur(mixed $cond[, mixed $modif = true ]) : mixed
Parameters
$cond : mixed
$modif : mixed = true

        
On this page

Search results