Session
in package
Table of Contents
- active() : bool
- Indique si la session est active (un utilisateur est connecté et son token n'a pas expiré)
- connected() : void
- Indique si un compte est actuellement connecté (le token existe).
- cookie() : string
- Ajouter un suffix au nom du cookie
- decodeToken() : string
- Retourne le contenu du token envoyé en paramètre (ou du token de session)
- destroy() : bool
- Détruit la session et le cookie
- set() : mixed
- Définir le token JWT dans la session et en cookie
- setCookie() : string
- Définir un cookie
- start() : mixed
- Démarrer la session si elle ne l'est pas déjà
- test() : array<string|int, mixed>
- Effectue les tests de connexion avec identifiant et mot de passe.
- token() : string
- Retourne le token de session actuel
Methods
active()
Indique si la session est active (un utilisateur est connecté et son token n'a pas expiré)
public
static active() : bool
Return values
bool —connected()
Indique si un compte est actuellement connecté (le token existe).
public
static connected() : void
Attention : un token ne suffit pas pour dire que la connexion est sûre. le token peut avoir expiré, il faut donc aussi faire appel à la fonction Session::active())
Return values
void —cookie()
Ajouter un suffix au nom du cookie
public
static cookie(mixed $nom) : string
Parameters
- $nom : mixed
Return values
string —decodeToken()
Retourne le contenu du token envoyé en paramètre (ou du token de session)
public
static decodeToken([mixed $token = false ]) : string
Parameters
- $token : mixed = false
Return values
string —destroy()
Détruit la session et le cookie
public
static destroy() : bool
Return values
bool —set()
Définir le token JWT dans la session et en cookie
public
static set(mixed $token) : mixed
Parameters
- $token : mixed
Return values
mixed —setCookie()
Définir un cookie
public
static setCookie(mixed $nom, mixed $valeur) : string
Parameters
- $nom : mixed
- $valeur : mixed
Return values
string —start()
Démarrer la session si elle ne l'est pas déjà
public
static start() : mixed
Return values
mixed —test()
Effectue les tests de connexion avec identifiant et mot de passe.
public
static test(mixed $credentials) : array<string|int, mixed>
En cas d'erreur, une structure contenant un message est retournée
Parameters
- $credentials : mixed
-
Un tableau contenant les champs identifiant et pass
Return values
array<string|int, mixed> —token()
Retourne le token de session actuel
public
static token() : string