Référence de la classe RememberToken

Classe rememberToken. Plus de détails...

Fonctions membres publiques
	__construct (int $userId, ?string $token=null, ?string $key=null, ?DateTime $createdAt=null, ?DateTime $expiresAt=null)
	Constructeur de la classe rememberToken.
	getUserId ()
	Retourne l'identifiant de l'utilisateur associé au jeton de connexion.
	setUserId (int $userId)
	Modifie l'identifiant de l'utilisateur associé au jeton de connexion.
	getToken ()
	Retourne le jeton de connexion.
	setToken (string $token)
	Modifie le jeton de connexion.
	getKey ()
	Retourne la clef d'autorisation.
	setKey (string $key)
	Modifie la clef d'autorisation.
	getCreatedAt ()
	Retourne la date de création du jeton de connexion.
	setCreatedAt (DateTime $createdAt)
	Modifie la date de création du jeton de connexion.
	getExpiresAt ()
	Retourne la date d'expiration du jeton de connexion.
	setExpiresAt (DateTime $expiresAt)
	Modifie la date d'expiration du jeton de connexion.
	__toArray ()
	Retourne un tableau associatif contenant les informations du jeton de connexion.
	isExpired ()
	Vérifie si le jeton de connexion est valide.
	generateToken ()
	Génère un jeton de connexion.
	generateKey ()
	Génère une clef d'autorisation.
	isValid (string $key)
	Vérifie si la clef d'autorisation est valide.

Attributs privés
int	$userId
string	$token
string	$key
DateTime	$createdAt
DateTime	$expiresAt

Description détaillée

Classe rememberToken.

La classe rememberToken permet de gérer les jetons de connexion

Définition à la ligne 20 du fichier rememberToken.class.php.

Documentation des constructeurs et destructeur

__construct()

__construct	(	int	$userId,
		?string	$token = null,
		?string	$key = null,
		?DateTime	$createdAt = null,
		?DateTime	$expiresAt = null )

Constructeur de la classe rememberToken.

Paramètres

int	$userId	Identifiant de l'utilisateur associé au jeton de connexion
string | null	$token	Jeton de connexion
string | null	$key	Clef d'autorisation
DateTime | null	$createdAt	Date de création du jeton de connexion
DateTime | null	$expiresAt	Date d'expiration du jeton de connexion

Définition à la ligne 61 du fichier rememberToken.class.php.

Documentation des fonctions membres

__toArray()

__toArray

(

)

Retourne un tableau associatif contenant les informations du jeton de connexion.

Renvoie

array Tableau associatif contenant les informations du jeton de connexion

Définition à la ligne 169 du fichier rememberToken.class.php.

generateKey()

generateKey

(

)

Génère une clef d'autorisation.

Renvoie

string Clef d'autorisation générée

Exceptions

RandomException

Exception levée si la génération de la clef d'autorisation a échoué

Définition à la ligne 204 du fichier rememberToken.class.php.

generateToken()

generateToken

(

)

Génère un jeton de connexion.

Renvoie

string Jeton de connexion généré

Exceptions

RandomException

Exception levée si la génération du jeton de connexion a échoué

Définition à la ligne 193 du fichier rememberToken.class.php.

getCreatedAt()

getCreatedAt

(

)

Retourne la date de création du jeton de connexion.

Renvoie

DateTime Date de création du jeton de connexion

Définition à la ligne 131 du fichier rememberToken.class.php.

getExpiresAt()

getExpiresAt

(

)

Retourne la date d'expiration du jeton de connexion.

Renvoie

DateTime Date d'expiration du jeton de connexion

Définition à la ligne 150 du fichier rememberToken.class.php.

getKey()

getKey

(

)

Retourne la clef d'autorisation.

Renvoie

string Clef d'autorisation

Définition à la ligne 112 du fichier rememberToken.class.php.

getToken()

getToken

(

)

Retourne le jeton de connexion.

Renvoie

string Jeton de connexion

Définition à la ligne 93 du fichier rememberToken.class.php.

getUserId()

getUserId

(

)

Retourne l'identifiant de l'utilisateur associé au jeton de connexion.

Renvoie

int Identifiant de l'utilisateur associé au jeton de connexion

Définition à la ligne 74 du fichier rememberToken.class.php.

isExpired()

isExpired

(

)

Vérifie si le jeton de connexion est valide.

Renvoie

bool True si le jeton de connexion est valide, false sinon

Définition à la ligne 183 du fichier rememberToken.class.php.

isValid()

isValid

(

string

$key

)

Vérifie si la clef d'autorisation est valide.

Paramètres

string

$key

Clef d'autorisation à vérifier

Renvoie

bool True si la clef d'autorisation est valide, false sinon

Définition à la ligne 216 du fichier rememberToken.class.php.

setCreatedAt()

setCreatedAt

(

DateTime

$createdAt

)

Modifie la date de création du jeton de connexion.

Paramètres

DateTime

$createdAt

Nouvelle date de création du jeton de connexion

Renvoie

void

Définition à la ligne 141 du fichier rememberToken.class.php.

setExpiresAt()

setExpiresAt

(

DateTime

$expiresAt

)

Modifie la date d'expiration du jeton de connexion.

Paramètres

DateTime

$expiresAt

Nouvelle date d'expiration du jeton de connexion

Renvoie

void

Définition à la ligne 160 du fichier rememberToken.class.php.

setKey()

setKey

(

string

$key

)

Modifie la clef d'autorisation.

Paramètres

string

$key

Nouvelle clef d'autorisation

Renvoie

void

Définition à la ligne 122 du fichier rememberToken.class.php.

setToken()

setToken

(

string

$token

)

Modifie le jeton de connexion.

Paramètres

string

$token

Nouveau jeton de connexion

Renvoie

void

Définition à la ligne 103 du fichier rememberToken.class.php.

setUserId()

setUserId

(

int

$userId

)

Modifie l'identifiant de l'utilisateur associé au jeton de connexion.

Paramètres

int

$userId

Nouvel identifiant de l'utilisateur associé au jeton de connexion

Renvoie

void

Définition à la ligne 84 du fichier rememberToken.class.php.

Documentation des champs

$createdAt

DateTime $createdAt

private

Définition à la ligne 44 du fichier rememberToken.class.php.

$expiresAt

DateTime $expiresAt

private

Définition à la ligne 50 du fichier rememberToken.class.php.

$key

string $key

private

Définition à la ligne 38 du fichier rememberToken.class.php.

$token

string $token

private

Définition à la ligne 32 du fichier rememberToken.class.php.

$userId

int $userId

private

Définition à la ligne 26 du fichier rememberToken.class.php.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• src/Models/rememberToken.class.php