SO FOOT Front

Transient
in package

Transient - Un transient est un stockage de données à durée indéterminée qui permet de mettre en cache les données pour éviter de faire trop d'appels sur l'API

Tags
example

function uneFonctionQuiRetourneDesDonnees() { // Il n'est pas nécéssaire de définir les paramètres à cet endroit return Transient::temporaire(function($arg1, $arg2) { $data = getAPI($arg1, $arg2); return $data; }); }

$data = uneFonctionQuiRetourneDesDonnees("arg 1", ["arg 2"]); echo $data; // cette donnée est mise en cache temporairement

Table of Contents

cle()  : string
cle - Construire la clé d'identification du transient (si c'est un tableau, elle est transformée en une chaîne de caractères lisible)
file()  : string
file - Déterminer le
get()  : mixed
get - Lire un transient s'il existe
save()  : void
save - Enregistrer le fichier transient dans le dossier dédié
set()  : bool
set - Définir un transient. La clé est automatiquement récupérée via l'appel à get fait précédement
temporaire()  : mixed
Créer un Transient temporaire pour stocker une donnée retournée par la fonction passée en parametre
valeur()  : mixed
Créer un Transient "définitif" pour stocker une donnée retournée par la fonction passée en parametre

Methods

cle()

cle - Construire la clé d'identification du transient (si c'est un tableau, elle est transformée en une chaîne de caractères lisible)

public static cle([mixed $cle = null ]) : string
Parameters
$cle : mixed = null

La clé d'identification du transient

Return values
string —

La clé nettoyée et slugifiée

file()

file - Déterminer le

public static file(mixed $cle) : string
Parameters
$cle : mixed

La clé d'identification du transient

Return values
string —

get()

get - Lire un transient s'il existe

public static get(mixed $cle[, mixed $options = [] ]) : mixed
Parameters
$cle : mixed

La clé d'identification du transient

$options : mixed = []

Options diverses (exemple : temporaire=true pour considérer que ce transient est temporaire, sur une durée définié dans TRANSIENT_TEMPORAIRE_DUREE. On peut définir une durée en jours en indiquant le nombre de jours dans la valeur de l'option. Exemple: temporaire=2 pour 2 jours)

Return values
mixed —

La donnée si le transient existe. Retourne null si le transient n'existe pas

save()

save - Enregistrer le fichier transient dans le dossier dédié

public static save(mixed $cle, mixed $valeur) : void
Parameters
$cle : mixed

La clé d'identification du transient

$valeur : mixed

Le contenu du transient

Return values
void —

set()

set - Définir un transient. La clé est automatiquement récupérée via l'appel à get fait précédement

public static set(mixed $valeur) : bool
Parameters
$valeur : mixed

Le contenu du transient

Return values
bool —

La création du transient a réussit

temporaire()

Créer un Transient temporaire pour stocker une donnée retournée par la fonction passée en parametre

public static temporaire(mixed $fonction[, mixed $duree = false ]) : mixed
Parameters
$fonction : mixed

Code éxécuté pour importer ou cacluler la donnée

$duree : mixed = false

Durée en jours du transient temporaire

Return values
mixed —

Donnée mise en cache

valeur()

Créer un Transient "définitif" pour stocker une donnée retournée par la fonction passée en parametre

public static valeur(mixed $fonction) : mixed
Parameters
$fonction : mixed

Code éxécuté pour importer ou cacluler la donnée

Return values
mixed —

Donnée mise en cache

Search results