$session.setPersistentObject

Description

Ajoute, met à jour ou supprime un objet persistent de session.

Syntaxe

$session.setPersistentObject( name , value [ , options ] )

Paramètres

name string

Nom de l'objet à mettre à jour ou à définir

value any

Valeur à inscrire dans l'objet. La valeur peut être de n'importe quel type.

Si la valeur est null, l'objet persistent est supprimé.

Objets de type file

Si la valeur est de type file, la méthode se charge automatiquement de convertir ce dernier en objet "mémoire". En effet, les objets persistents ont pour fonction d'être réutilisés lors de threads ultérieurs. Or il n'y a pas de garantie qu'un fichier en filesystem soit toujours existant à ce moment. Pour s'assurer que le fichier sera toujours présent, il est nécessaire que son contenu soit conservé en mémoire au sein de la session. Pour cette raison, la méthode se charge de convertir l'objet en fichier "in memory".

Il n'est donc pas nécessaire d'invoquer la méthode $file.toMemFile sur l'objet passé en valeur.

options map

Les options permettent de spécifier des informations complémentaires concernant le format de la donnée ou la façon de la traiter. Les options suivantes sont reconnues:

format string

Format de données. Peut valoir "xml" pour indiquer que la données est à traiter en tant qu'arbre XML (dans ce cas la ou les valeurs ne seront pas échappées au niveau de l'arbre de sortie)

secret boolean

Flag true/false indiquant si l'objet est secret. Un objet secret se distingue d'un objet standard par le fait qu'il n'est pas repris dans l'arbre de sortie XML.

Par défaut, le flag est false.

Retour

Retourne toujours null.

Exemple

Non disponible