Classe ControllerAuth. Plus de détails...

Graphe d'héritage de ControllerAuth:

Graphe de collaboration de ControllerAuth:

Fonctions membres publiques
	__construct (FilesystemLoader $loader, Environment $twig)
	Constructeur de la classe ControllerAuth.

	showLoginPage ()
	La méthode showLoginPage permet d'afficher la page de connexion.

	showForgotPasswordPage ()
	Affiche la page de réinitialisation de mot de passe.

	sendResetPasswordLink (string $email)
	Envoie un lien de réinitialisation de mot de passe à l'adresse e-mail fournie.

	showResetPasswordPage (string $token)
	Affiche la page de réinitialisation de mot de passe.

	resetPassword (string $token, string $password, string $passwordConfirm)
	Réinitialise le mot de passe de l'utilisateur.

	showRegistrationPage ()
	La méthode showRegistrationPage permet d'afficher la page d'inscription.

	login (?string $email, ?string $password, ?bool $rememberMe, ?string $cloudflareCaptchaToken)
	Traite la demande de connexion de l'utilisateur.

	restoreSession ()
	Permet de reprendre la session via un cookie.

	logOut ()
	Déconnecte l'utilisateur.

	register (?string $username, ?string $email, ?string $password, ?string $passwordConfirm, ?bool $termsOfServiceIsChecked, ?bool $privacyPolicyIsChecked, ?string $cloudflareCaptchaToken)
	La méthode register permet d'inscrire un utilisateur.

	confirmEmail (string $emailVerifToken, bool $isLoggedIn)
	Confirme l'adresse e-mail d'un utilisateur à l'aide du token de vérification.

Fonctions membres publiques hérités de Controller
	getPdo ()
	Retourne l'attribut PDO, correspondant à la connexion à la base de données.

	setPdo (PDO $pdo)
	Modifie l'attribut PDO, correspondant à la connexion à la base de données.

	call (string $method, ?array $args=[])
	Appelle la méthode du Controller passée en paramètre.

	getLoader ()
	Retourne l'attribut loader, correspondant au loader de Twig.

	setLoader (FilesystemLoader $loader)
	Modifie l'attribut loader, correspondant au loader de Twig.

	getTwig ()
	Retourne l'attribut twig, correspondant à l'environnement de Twig.

	setTwig (Environment $twig)
	Modifie l'attribut twig, correspondant à l'environnement de Twig.

	getGet ()
	Retourne l'attribut GET, correspondant aux données passées en paramètre via la méthode GET.

	setGet (?array $get)
	Modifie l'attribut GET, correspondant aux données passées en paramètre via la méthode GET.

	getPost ()
	Retourne l'attribut POST, correspondant aux données passées en paramètre via la méthode POST.

	setPost (?array $post)
	Modifie l'attribut POST, correspondant aux données passées en paramètre via la méthode POST.

Fonctions membres privées
	verifyCaptcha (string $cloudflareCaptchaToken)
	Permet de vérifier le token de captcha auprès de Cloudflare.

	authenticate (User $user)
	Permet d'authentifier l'utilisateur.

	clearRememberCookies ()
	Supprime les cookies de connexion.

Description détaillée

Classe ControllerAuth.

La classe ControllerAuth est un contrôleur permettant de gérer l'authentification des utilisateurs (connexion & inscription)

Définition à la ligne 42 du fichier ControllerAuth.class.php.

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	FilesystemLoader	$loader,
		Environment	$twig )

Constructeur de la classe ControllerAuth.

Paramètres

FilesystemLoader	$loader	Le loader de Twig
Environment	$twig	L'environnement de Twig

Réimplémentée à partir de Controller.

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

Documentation des fonctions membres

◆ authenticate()

authenticate ( User $user )

private

Permet d'authentifier l'utilisateur.

Vérifie si l'utilisateur est un joueur ou un modérateur, puis stocke les informations nécessaires en variables de session

Paramètres

User $user Utilisateur à authentifier

Renvoie: bool Renvoie true si l'utilisateur est authentifié, false sinon

Exceptions

DateMalformedStringException	Exception levée dans le cas d'une date malformée
AuthenticationException	Exception levée dans le cas d'une erreur d'authentification

Définition à la ligne 390 du fichier ControllerAuth.class.php.

◆ clearRememberCookies()

clearRememberCookies ( )

private

Supprime les cookies de connexion.

Renvoie: void

Définition à la ligne 497 du fichier ControllerAuth.class.php.

◆ confirmEmail()

confirmEmail	(	string	$emailVerifToken,
		bool	$isLoggedIn )

Confirme l'adresse e-mail d'un utilisateur à l'aide du token de vérification.

Cette méthode utilise le token de vérification d'e-mail pour rechercher l'utilisateur dans la base de données. Si l'utilisateur est trouvé, son compte est confirmé et un message de confirmation est affiché. Sinon, un message d'erreur est affiché. Le résultat de la confirmation est ensuite rendu à l'aide de Twig.

Paramètres

string $emailVerifToken Le token de vérification d'e-mail de l'utilisateur.

Exceptions

AuthenticationException Exception levée dans le cas d'une erreur d'authentification

Définition à la ligne 675 du fichier ControllerAuth.class.php.

◆ login()

login	(	?string	$email,
		?string	$password,
		?bool	$rememberMe,
		?string	$cloudflareCaptchaToken )

Traite la demande de connexion de l'utilisateur.

Vérifie si un utilisateur portant l'adresse e-mail fournie en paramètre existe. Si oui, vérifie par la suite son adresse e-mail a bien été vérifiée. Dans le cas contraire, lève une exception Vérifie ensuite que le compte n'est pas désactivé. Dans le cas contraire, lève une exception. Vérifie que le mot de passe fourni correspond bien au mot de passe inscrit en base de données. Si toutes les vérifications passent, ouvre la session et renseigne les éléments importants en variables de session.

Paramètres

?string	$email	Adresse e-mail fournie dans le formulaire de connexion
?string	$password	Mot de passe fourni dans le formulaire de connexion
?bool	$rememberMe	Booléen permettant de savoir si l'utilisateur souhaite rester connecté
?string	$cloudflareCaptchaToken	Token de captcha fourni par Cloudflare

Renvoie: bool

Définition à la ligne 278 du fichier ControllerAuth.class.php.

◆ logOut()

logOut ( )

Déconnecte l'utilisateur.

Commence par démarrer la session afin de pouvoir y supprimer toutes les variables stockées dessus, puis détruit celle-ci.

Renvoie: void

Exceptions

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

Définition à la ligne 510 du fichier ControllerAuth.class.php.

◆ register()

register	(	?string	$username,
		?string	$email,
		?string	$password,
		?string	$passwordConfirm,
		?bool	$termsOfServiceIsChecked,
		?bool	$privacyPolicyIsChecked,
		?string	$cloudflareCaptchaToken )

La méthode register permet d'inscrire un utilisateur.

Vérifie si un utilisateur portant l'adresse e-mail fournie en paramètre existe. Si oui, lève une exception. Vérifie que le nom d'utilisateur fourni n'existe pas déjà en base de données. Si oui, lève une exception. Crée un utilisateur avec l'adresse e-mail fournie, un mot de passe hashé fourni et un token de vérification de l'email. Envoie un mail avec phpmailer contenant un lien de confirmation de compte. Crée un joueur avec l'identifiant utilisateur créé, le nom d'utilisateur fourni et l'adresse e-mail fournie.

Paramètres

?string	$username	Nom d'utilisateur fourni dans le formulaire d'inscription
?string	$email	Adresse e-mail fournie dans le formulaire d'inscription
?string	$password	Mot de passe fourni dans le formulaire d'inscription
?string	$passwordConfirm	Confirmation du mot de passe fourni dans le formulaire d'inscription
?bool	$termsOfServiceIsChecked	Condition d'acceptation des conditions d'utilisation
?bool	$privacyPolicyIsChecked	Condition d'acceptation de la politique de confidentialité
?string	$cloudflareCaptchaToken	Token du captcha fourni par Cloudflare

Renvoie: void

Définition à la ligne 551 du fichier ControllerAuth.class.php.

◆ resetPassword()

resetPassword	(	string	$token,
		string	$password,
		string	$passwordConfirm )

Réinitialise le mot de passe de l'utilisateur.

Vérifie que le mot de passe et sa confirmation sont identiques, puis les hashes avant de les stocker en base de données

Paramètres

string	$token	Token de réinitialisation de mot de passe
string	$password	Nouveau mot de passe
string	$passwordConfirm	Confirmation du nouveau mot de passe

Exceptions

MalformedRequestException	Exception levée dans le cas d'une requête malformée
DateMalformedStringException	Exception levée dans le cas d'une date malformée
Exception	Exception levée dans le cas d'une erreur quelconque

Définition à la ligne 189 du fichier ControllerAuth.class.php.

◆ restoreSession()

restoreSession ( )

Permet de reprendre la session via un cookie.

Vérifie si les cookies de connexion sont présents, puis authentifie l'utilisateur si c'est le cas

Renvoie: bool Renvoie true si l'utilisateur est authentifié, false sinon

Exceptions

DateMalformedStringException	Exception levée dans le cas d'une date malformée
AuthenticationException	Exception levée dans le cas d'une erreur d'authentification

Définition à la ligne 438 du fichier ControllerAuth.class.php.

◆ sendResetPasswordLink()

sendResetPasswordLink ( string $email )

Envoie un lien de réinitialisation de mot de passe à l'adresse e-mail fournie.

Paramètres

string $email Adresse e-mail pré-remplie dans le formulaire d'inscription

Renvoie: void

Exceptions

DateMalformedStringException	Exception levée dans le cas d'une date malformée
RandomException	Exception levée dans le cas d'une erreur de génération de nombre aléatoire

Définition à la ligne 90 du fichier ControllerAuth.class.php.

◆ showForgotPasswordPage()

showForgotPasswordPage ( )

Affiche la page de réinitialisation de mot de passe.

Renvoie: void

Exceptions

RuntimeError	Exception levée dans le cas d'une erreur d'exécution
SyntaxError	Exception levée dans le cas d'une erreur de syntaxe
LoaderError	Exception levée dans le cas d'une erreur de chargement

Définition à la ligne 77 du fichier ControllerAuth.class.php.

◆ showLoginPage()

showLoginPage ( )

La méthode showLoginPage permet d'afficher la page de connexion.

Renvoie: void

Exceptions

LoaderError	Exception levée dans le cas d'une erreur de chargement
RuntimeError	Exception levée dans le cas d'une erreur d'exécution
SyntaxError	Exception levée dans le cas d'une erreur de syntaxe

Définition à la ligne 62 du fichier ControllerAuth.class.php.

◆ showRegistrationPage()

showRegistrationPage ( )

La méthode showRegistrationPage permet d'afficher la page d'inscription.

Renvoie: void

Exceptions

LoaderError	Exception levée dans le cas d'une erreur de chargement
RuntimeError	Exception levée dans le cas d'une erreur d'exécution
SyntaxError	Exception levée dans le cas d'une erreur de syntaxe

Définition à la ligne 257 du fichier ControllerAuth.class.php.

◆ showResetPasswordPage()

showResetPasswordPage ( string $token )

Affiche la page de réinitialisation de mot de passe.

Paramètres

string $token Token de réinitialisation de mot de passe

Exceptions

SyntaxError	Exception levée dans le cas d'une erreur de syntaxe
RuntimeError	Exception levée dans le cas d'une erreur d'exécution
LoaderError	Exception levée dans le cas d'une erreur de chargement
DateMalformedStringException	Exception levée dans le cas d'une date incorrecte
MalformedRequestException	Exception levée dans le cas d'une requête malformée

Définition à la ligne 165 du fichier ControllerAuth.class.php.

◆ verifyCaptcha()

verifyCaptcha ( string $cloudflareCaptchaToken )

private

Permet de vérifier le token de captcha auprès de Cloudflare.

Paramètres

string $cloudflareCaptchaToken Token de captcha fourni par Cloudflare

Renvoie: bool Renvoie true si le captcha est valide, false sinon

Exceptions

Exception Exception levée en cas d'erreur lors de la vérification du captcha

Définition à la ligne 353 du fichier ControllerAuth.class.php.

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

src/Controllers/ControllerAuth.class.php

Fonctions membres publiques

Fonctions membres privées

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ authenticate()

◆ clearRememberCookies()

◆ confirmEmail()

◆ login()

◆ logOut()

◆ register()

◆ resetPassword()

◆ restoreSession()

◆ sendResetPasswordLink()

◆ showForgotPasswordPage()

◆ showLoginPage()

◆ showRegistrationPage()

◆ showResetPasswordPage()

◆ verifyCaptcha()