wincache_ucache_add
(PECL wincache >= 1.1.0)
wincache_ucache_add — Ajoute une nouvelle variable au cache utilisateur
Description
Ajoute une variable au cache utilisateur, uniquement si elle n'existe pas déjà dans le cache. La variable restera dans le cache tant que le délai d'expiration n'est pas atteint ou qu'elle n'est effacée par la fonction wincache_ucache_delete() ou la fonction wincache_ucache_clear().
Liste de paramètres
-
key
-
Stocke la variable en utilisant le nom
key
. Si une variable correspondant à la même clé est déjà présente dans le cache, la fonction échouera et retourneraFALSE
. Le paramètrekey
est sensible à la casse. Pour écraser cette valeur, sikey
est présent, utilisez plutôt la fonction wincache_ucache_set().key
peut également être un tableau de paires nom => valeur où les noms seront utilisés comme clés. Ce format peut être utilisé pour ajouter de multiples valeurs dans le cache en une seule opération. -
value
-
La valeur de la variable à stocker. Le paramètre
Value
supporte tous les types de données, sauf les ressources, comme des pointeurs de fichiers. Ce paramètre sera ignoré si le premier argument est un tableau. De façon général, il convient de passer la valeurNULL
au paramètrevalue
lors de l'utilisation d'un tableau pour le paramètrekey
. Si le paramètrevalue
est un objet, ou un tableau contenant des objets, alors les objets seront linéarisés. Reportez-vous à la fonction __sleep() pour plus de détails sur la linéarisation d'objets. -
values
-
Tableau associatif de clés et de valeurs.
-
ttl
-
Durée de vie de la variable dans le cache, en secondes. Après la durée spécifiée par le paramètre
ttl
, la variable stockée sera supprimée du cache. Ce paramètre prend, comme valeur par défaut, zéro (0), ce qui signifie que la variable restera dans le cache tant qu'elle n'est pas explicitement effacée en utilisant la fonction wincache_ucache_delete() ou la fonction wincache_ucache_clear().
Valeurs de retour
Si le paramètre key
est une chaîne de caractères, la fonction retourne
TRUE
en cas de succès, FALSE
si une erreur survient.
Si le paramètre key
est un tableau, la fonction retourne :
- Si toutes les paires nom => valeur du tableau peuvent être définies, la fonction retournera un tableau vide ;
-
Si toutes les paires nom => valeur du tableau ne peuvent être définies, la fonction retournera
FALSE
; - Si certaines peuvent être définies, et d'autres non, la fonction retournera un tableau de paires nom => valeur n'ayant pû être définies dans le cache utilisateur.
Exemples
Exemple #1 Exemple avec wincache_ucache_add() et le paramètre key
sous forme de chaîne de caractères
<?php $bar = 'BAR'; var_dump(wincache_ucache_add('foo', $bar)); var_dump(wincache_ucache_add('foo', $bar)); var_dump(wincache_ucache_get('foo')); ?>
<?php $colors_array = array('green' => '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); var_dump(wincache_ucache_add($colors_array)); var_dump(wincache_ucache_add($colors_array)); var_dump(wincache_ucache_get('Blue')); ?>
L'exemple ci-dessus va afficher :
array(0) { } array(4) { ["green"]=> int(-1) ["Blue"]=> int(-1) ["yellow"]=> int(-1) ["cyan"]=> int(-1) } string(1) "6"
Voir aussi
- wincache_ucache_set() - Ajoute une variable au cache utilisateur et écrase la variable si elle existe déjà dans le cache
- wincache_ucache_get() - Récupère une variable stokée dans le cache utilisateur
- wincache_ucache_delete() - Supprime les variables du cache utilisateur
- wincache_ucache_clear() - Supprime le contenu d'une entrée du cache utilisateur
- wincache_ucache_exists() - Vérifie si une variable existe dans le cache utilisateur
- wincache_ucache_meminfo() - Récupère des informations sur l'utilisation mémoire du cache utilisateur
- wincache_ucache_info() - Récupère des informations sur des données stokées dans le cache utilisateur
- __sleep()