Docs For Class CopixAJAXSession

Description

Implements interfaces:

Countable (internal interface)
IteratorAggregate (internal interface)

Session AJAX de page.

Located in /utils/CopixAJAX.class.php (line 15)

Class Constant Summary

TIMEOUT = 300

Method Summary

CopixAJAXSession __construct ( $pSessionId, string $psessionId)

integer count ()

void delete (string $pKey)

mixed get (integer|string $pKey, [mixed $pDefault = null])

Iterator getIterator ()

string getSessionId ()

boolean isNewSession ()

boolean isStale ()

mixed pop (string $pKey, [ $pDefault = null], mixed $pValue)

void set (integer|string $pKey, mixed $pValue)

void touch ()

mixed &__get (string $pKey)

boolean __isset (string $pKey)

mixed __set (string $pKey, mixed $pValue)

string __toString ()

void __unset (string $pKey)

void __wakeup ()

Methods

Constructor __construct (line 72)

Crée une nouvelle session pour cette page.

access: public

CopixAJAXSession __construct ( $pSessionId, string $psessionId)

string $psessionId: Identifiant de la page.
$pSessionId

count (line 168)

Retourne le nombre de valeurs.

access: public

integer count ()

Implementation of:

Countable::count

delete (line 231)

Supprime une valeur pour une clef donnée.

see: offsetUnset ()
access: public

void delete (string $pKey)

string $pKey

get (line 189)

Retourne la valeur pour une clef donnée.

return: Donnée en session.
see: CopixAJAXSession::__get()
access: public

mixed get (integer|string $pKey, [mixed $pDefault = null])

integer|string $pKey
mixed $pDefault: Valeur par défaut.

getIterator (line 177)

Crée un itérateur sur les valeurs.

access: public

Iterator getIterator ()

Implementation of:

IteratorAggregate::getIterator

getSessionId (line 99)

Retourne l'identifiant de la page à laquelle cette session est associé

access: public

string getSessionId ()

isNewSession (line 90)

Détermine si la session vient juste d'être créée.

return: Vrai si la session vient d'être créée.
access: public

boolean isNewSession ()

isStale (line 108)

Détermine si cette session n'est plus utilisée.

return: Vrai si on peut la détruire sans risque.
access: public

boolean isStale ()

pop (line 218)

Combinaison de get () et delete () : supprime l'entrée et retourne sa valeur.

return: Donnée en session.
see: CopixAJAXSession::get(), CopixAJAXSession::__unset()
access: public

mixed pop (string $pKey, [ $pDefault = null], mixed $pValue)

string $pKey: Clef de la valeur.
mixed $pValue: Valeur à définir.
$pDefault

set (line 205)

Définit la valeur pour une clef donnée.

see: CopixAJAXSession::__set()
access: public

void set (integer|string $pKey, mixed $pValue)

integer|string $pKey
mixed $pValue: Valeur à définir.

touch (line 115)

Met à jour la date de dernière utilisation.

access: public

void touch ()

__get (line 128)

Récupère une valeur pour une clef donnée.

return: Valeur.
access: public

mixed &__get (string $pKey)

string $pKey: Clef de la valeur.

__isset (line 150)

Teste si une valeur est définie pour une clef donnée.

return: Vrai si la valeur est définie.
access: public

boolean __isset (string $pKey)

string $pKey: Clef de la valeur.

__set (line 139)

Définit la valeur pour une clef donnée.

return: Référence à la valeur.
access: public

mixed __set (string $pKey, mixed $pValue)

string $pKey: Clef de la valeur.
mixed $pValue: Valeur à fixer.

__toString (line 57)

Représentation textuelle.

access: public

string __toString ()

__unset (line 159)

Supprime une valeur

access: public

void __unset (string $pKey)

string $pKey: Clef de la valeur.

__wakeup (line 81)

Au "réveil" (désérialisation), met $this->_newSession à faux.

access: public

void __wakeup ()

Class Constants

TIMEOUT = 300 (line 21)

Durée de vie d'une session en secondes.