Référence de la classe UserDAO

Classe UserDAO. Plus de détails...

Fonctions membres publiques
	__construct (?PDO $pdo)
	Le constructeur de la classe UserDAO.
	getPdo ()
	Retourne la connexion à la base de données.
	setPdo (?PDO $pdo)
	Modifie la connexion à la base de données.
	findById (int $id)
	Retourne un objet User (ou null) à partir de l'ID passé en paramètre.
	hydrate (array $data)
	Hydrate un objet User à partir des données passées en paramètre.
	update (User $user)
	Met à jour un utilisateur en base de données.
	findByEmail (?string $email)
	disableAccount ($id)
	Désactive un compte utilisateur à partir de l'ID passé en paramètre.
	findByEmailVerifyToken (string $emailVerifToken)
	Retourne un objet User (ou null) à partir du token de vérification d'email passé en paramètre.
	createUser (string $email, string $password, string $emailVerifToken)
	Crée un utilisateur en base de données.
	confirmUser (string $emailVerifToken)
	Confirme un utilisateur en mettant à jour la date de confirmation et en supprimant le token de vérification d'email.

Attributs privés
PDO	$pdo

Description détaillée

Classe UserDAO.

La classe UserDAO permet de gérer les utilisateurs en base de données

Définition à la ligne 21 du fichier user.dao.php.

Documentation des constructeurs et destructeur

__construct()

__construct

(

?PDO

$pdo

)

Le constructeur de la classe UserDAO.

Paramètres

PDO | null

$pdo

Définition à la ligne 33 du fichier user.dao.php.

Documentation des fonctions membres

confirmUser()

confirmUser

(

string

$emailVerifToken

)

Confirme un utilisateur en mettant à jour la date de confirmation et en supprimant le token de vérification d'email.

Paramètres

string

$emailVerifToken

Le token de vérification d'email de l'utilisateur

Renvoie

bool Retourne true si l'utilisateur a pu être confirmé, false sinon

Définition à la ligne 218 du fichier user.dao.php.

createUser()

createUser	(	string	$email,
		string	$password,
		string	$emailVerifToken )

Crée un utilisateur en base de données.

Paramètres

string	$email	L'adresse e-mail de l'utilisateur
string	$password	Le mot de passe de l'utilisateur
string	$emailVerifToken	Le token de verification de l'utilisateur

Renvoie

bool Retourne true si l'utilisateur a pu être créé, false sinon

Définition à la ligne 204 du fichier user.dao.php.

disableAccount()

disableAccount

(

$id

)

Désactive un compte utilisateur à partir de l'ID passé en paramètre.

La demande de suppression effective d'un compte n'est pas possible. Afin de supprimer son compte, un joueur doit avant tout le désactiver. Une fois le compte désactivé, le joueur possède 30 jours pour demander à récupérer celui-ci. Au bout de cette période, toutes les données sont définitivement supprimées.

Paramètres

$id	L'ID du compte utilisateur à désactiver

Renvoie

void

Définition à la ligne 164 du fichier user.dao.php.

findByEmail()

findByEmail

(

?string

$email

)

Retourne un utilisateur en fonction de son email

Paramètres

string | null

$email

Email de l'utilisateur

Renvoie

User|null Objet retourné par la méthode, ici un utilisateur (ou null si non-trouvé)

Exceptions

DateMalformedStringException

Exception levée dans le cas d'une date malformée

Définition à la ligne 139 du fichier user.dao.php.

findByEmailVerifyToken()

findByEmailVerifyToken

(

string

$emailVerifToken

)

Retourne un objet User (ou null) à partir du token de vérification d'email passé en paramètre.

Paramètres

string

$emailVerifToken

Le token de vérification d'email de l'utilisateur

Renvoie

User|null Objet retourné par la méthode, ici un utilisateur (ou null si non-trouvé)

Exceptions

DateMalformedStringException

Exception levée dans le cas d'une date malformée

Définition à la ligne 180 du fichier user.dao.php.

findById()

findById

(

int

$id

)

Retourne un objet User (ou null) à partir de l'ID passé en paramètre.

Paramètres

int

$id

L'ID de l'utilisateur recherché

Renvoie

User|null Objet retourné par la méthode, ici un utilisateur (ou null si non-trouvé)

Exceptions

DateMalformedStringException

Exception levée dans le cas d'une date malformée

Définition à la ligne 62 du fichier user.dao.php.

getPdo()

getPdo

(

)

Retourne la connexion à la base de données.

Renvoie

PDO|null Objet retourné par la méthode, ici un PDO représentant la connexion à la base de données

Définition à la ligne 42 du fichier user.dao.php.

hydrate()

hydrate

(

array

$data

)

Hydrate un objet User à partir des données passées en paramètre.

Paramètres

array

$data

Le tableau associatif contenant les données de l'utilisateur

Renvoie

User Objet retourné par la méthode, ici un utilisateur

Exceptions

DateMalformedStringException|Exception

Exception levée dans le cas d'une date malformée

Définition à la ligne 84 du fichier user.dao.php.

setPdo()

setPdo

(

?PDO

$pdo

)

Modifie la connexion à la base de données.

Paramètres

PDO | null

$pdo

La nouvelle connexion à la base de données

Définition à la ligne 51 du fichier user.dao.php.

update()

update

(

User

$user

)

Met à jour un utilisateur en base de données.

Paramètres

User

$user

L'utilisateur à mettre à jour

Renvoie

bool Retourne true si la mise à jour a réussi, false sinon

Définition à la ligne 103 du fichier user.dao.php.

Documentation des champs

$pdo

PDO $pdo

private

Définition à la ligne 27 du fichier user.dao.php.

---

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

• src/Models/user.dao.php