Classe ControllerGame. Plus de détails...

Graphe d'héritage de ControllerGame:

Graphe de collaboration de ControllerGame:

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

	showHomePage ()
	Affiche la page d'accueil avec la liste des jeux.

	initGame (string $code, ?array $settings)
	Permet d'initialiser le jeu après validation des paramètres et que les joueurs soient prêts.

	getGameInformations (?int $id)
	Récupère les informations d'un jeu et le retourne au format JSON.

	showGame (string $code)
	Affiche la page de la partie dont le code est passé en paramètre.

	joinGameWithCode (string $method, string $code)
	Rejoint une partie avec un code (Méthode GET ou POST autorisée)

	changeVisibility (string $code, bool $isPrivate)
	Permet de changer la visibilité d'une partie.

	joinGameFromSearch (int $gameId)
	Rejoint une partie suite à une recherche de partie.

	quitGame (string $code, string $playerUuid)
	Quitte une partie.

	createGame (int $gameId)
	Crée une partie en base de données pour un jeu donné

	endGame (string $code, string $token, ?array $results=null)
	Termine une partie et met à jour les scores et les gagnants.

	isPlayerMuted (string $playerUsername)
	Vérifie si un joueur est mute.

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
	getGameSettings (int $id)
	Récupère les paramètres du jeu dont l'ID est passé en paramètre.

	getGameFolder (int $id)
	Récupère le dossier du jeu dont l'ID est passé en paramètre.

	getGameUrl (int $id)

	showGameSettings (GameRecord $gameRecord)
	Affiche la page des paramètres de la partie.

	joinGame (string $code, ?string $playerUuid=null)
	Rejoint une partie avec un code.

	getGameModifiableSettings (int $id)
	Récupère les paramètres modifiables du jeu dont l'ID est passé en paramètre.

	showInGame (GameRecord $gameRecord)
	Affiche la page de la partie en cours.

	calculateAndUpdateElo (array $allPlayers, array $winners, array $looser)
	Calcule et met à jour les scores Elo des joueurs.

	averageElo (array $players)

Description détaillée

Classe ControllerGame.

Contrôleur permettant de gérer l'affichage des jeux sur différente page.

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

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	FilesystemLoader	$loader,
		Environment	$twig )

Constructeur de la classe ControllerGame.

Paramètres

FilesystemLoader	$loader	Loader Twig
Environment	$twig	Environnement Twig

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

Définition à la ligne 49 du fichier ControllerGame.class.php.

Documentation des fonctions membres

◆ averageElo()

averageElo ( array $players )

private

Paramètres

array $players Tableau des joueurs

Renvoie: float Moyenne des scores Elo des joueurs

Définition à la ligne 777 du fichier ControllerGame.class.php.

◆ calculateAndUpdateElo()

calculateAndUpdateElo	(	array	$allPlayers,
		array	$winners,
		array	$looser )

private

Calcule et met à jour les scores Elo des joueurs.

Paramètres

array	$allPlayers	Tableau des joueurs
array	$winners	Tableau des joueurs gagnants
array	$looser	Tableau des joueurs perdants

Renvoie: void

Définition à la ligne 751 du fichier ControllerGame.class.php.

◆ changeVisibility()

changeVisibility	(	string	$code,
		bool	$isPrivate )

Permet de changer la visibilité d'une partie.

Paramètres

string	$code	Code de la partie
bool	$isPrivate	Vrai si la partie doit être privée, faux sinon

Renvoie: void

Définition à la ligne 503 du fichier ControllerGame.class.php.

◆ createGame()

createGame ( int $gameId )

Crée une partie en base de données pour un jeu donné

Paramètres

int $gameId Identifiant du jeu

Renvoie: void

Exceptions

GameUnavailableException	Exception levée si le jeu n'est pas disponible
RandomException	Exceptions levées en cas d'erreur lors de la génération du code
Exception	Exceptions levées en cas d'erreur avec la base de données

Définition à la ligne 626 du fichier ControllerGame.class.php.

◆ endGame()

endGame	(	string	$code,
		string	$token,
		?array	$results = null )

Termine une partie et met à jour les scores et les gagnants.

Paramètres

string	$code	Code de la partie
string	$token	Token de la partie
array \| null	$results	Résultats de la partie si le jeu les renvoies

Renvoie: void

Définition à la ligne 670 du fichier ControllerGame.class.php.

◆ getGameFolder()

getGameFolder ( int $id )

private

Récupère le dossier du jeu dont l'ID est passé en paramètre.

Paramètres

int $id

Renvoie: string Chemin du dossier du jeu

Définition à la ligne 282 du fichier ControllerGame.class.php.

◆ getGameInformations()

getGameInformations ( ?int $id )

Récupère les informations d'un jeu et le retourne au format JSON.

Paramètres

int | null $id L'identifiant du jeu

Renvoie: void

Définition à la ligne 302 du fichier ControllerGame.class.php.

◆ getGameModifiableSettings()

getGameModifiableSettings ( int $id )

private

Récupère les paramètres modifiables du jeu dont l'ID est passé en paramètre.

Paramètres

int $id ID du jeu

Renvoie: array Tableau associatif contenant les paramètres modifiables du jeu

Définition à la ligne 456 du fichier ControllerGame.class.php.

◆ getGameSettings()

getGameSettings ( int $id )

private

Récupère les paramètres du jeu dont l'ID est passé en paramètre.

Paramètres

int $id ID du jeu

Renvoie: array Tableau associatif contenant les paramètres du jeu

Exceptions

GameUnavailableException Exception levée si le fichier de paramètres du jeu n'existe pas

Définition à la ligne 265 du fichier ControllerGame.class.php.

◆ getGameUrl()

getGameUrl ( int $id )

private

Définition à la ligne 287 du fichier ControllerGame.class.php.

◆ initGame()

initGame	(	string	$code,
		?array	$settings )

Permet d'initialiser le jeu après validation des paramètres et que les joueurs soient prêts.

Paramètres

string	$code	Code de la partie
array \| null	$settings	Paramètres du jeu

Exceptions

GameSettingsException	Exception levée si les paramètres du jeu ne sont pas valides
GameUnavailableException	Exception levée si le jeu n'est pas disponible
MalformedRequestException	Exception levée si la partie est déjà commencée ou terminée
NotFoundException	Exception levée si la partie n'existe pas
Exception	Exception levée en cas d'erreur avec la base de données

Définition à la ligne 101 du fichier ControllerGame.class.php.

◆ isPlayerMuted()

isPlayerMuted ( string $playerUsername )

Vérifie si un joueur est mute.

Paramètres

string $playerUsername Nom d'utilisateur du joueur

Renvoie: void

Exceptions

DateMalformedStringException Exception levée si la date est mal formée

Définition à la ligne 792 du fichier ControllerGame.class.php.

◆ joinGame()

joinGame	(	string	$code,
		?string	$playerUuid = null )

private

Rejoint une partie avec un code.

Paramètres

string	$code	Code de la partie
string \| null	$playerUuid	UUID de l'utilisateur, null si l'utilisateur n'est pas connecté

Renvoie: string Réponse au format JSON

Exceptions

GameUnavailableException	Exception levée si la partie n'est pas disponible
NotFoundException	Exception levée si la partie n'existe pas
Exception	Exception levée en cas d'erreur avec la base de données

Définition à la ligne 417 du fichier ControllerGame.class.php.

◆ joinGameFromSearch()

joinGameFromSearch ( int $gameId )

Rejoint une partie suite à une recherche de partie.

Paramètres

int $gameId Identifiant du jeu à rejoindre

Renvoie: void

Exceptions

Exception Exception levée en cas d'erreur avec la base de données

Définition à la ligne 533 du fichier ControllerGame.class.php.

◆ joinGameWithCode()

joinGameWithCode	(	string	$method,
		string	$code )

Rejoint une partie avec un code (Méthode GET ou POST autorisée)

Paramètres

string	$method	Méthode HTTP utilisée
string	$code	Code de la partie

Exceptions

GameUnavailableException	Exception levée si le jeu n'est pas disponible
NotFoundException	Exception levée si la partie n'existe pas

Définition à la ligne 395 du fichier ControllerGame.class.php.

◆ quitGame()

quitGame	(	string	$code,
		string	$playerUuid )

Quitte une partie.

Paramètres

string	$code	UUID de la partie à quitter
string	$playerUuid	UUID du joueur qui quitte la partie

Renvoie: void

Exceptions

NotFoundException	Exception levée si la partie n'existe pas
Exception	Exception levée en cas d'erreur avec la base de données

Définition à la ligne 594 du fichier ControllerGame.class.php.

◆ showGame()

showGame ( string $code )

Affiche la page de la partie dont le code est passé en paramètre.

Paramètres

string $code Code de la partie

Renvoie: void

Exceptions

NotFoundException	Exception levée si la partie n'existe pas
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 du template
Exception	Exception levée en cas d'erreur avec la base de données

Définition à la ligne 328 du fichier ControllerGame.class.php.

◆ showGameSettings()

showGameSettings ( GameRecord $gameRecord )

private

Affiche la page des paramètres de la partie.

Paramètres

GameRecord $gameRecord Instance de GameRecord

Renvoie: void

Exceptions

LoaderError	Exception levée dans le cas d'une erreur de chargement du template
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
GameUnavailableException\|NotFoundException	Exception levée si la partie n'existe pas ou si le jeu n'est pas disponible
Exception	Exception levée en cas d'erreur avec la base de données

Définition à la ligne 361 du fichier ControllerGame.class.php.

◆ showHomePage()

showHomePage ( )

Affiche la page d'accueil avec la liste des jeux.

Renvoie: void

Exceptions

LoaderError	Exception levée dans le cas d'une erreur de chargement du template
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 61 du fichier ControllerGame.class.php.

◆ showInGame()

showInGame ( GameRecord $gameRecord )

private

Affiche la page de la partie en cours.

Paramètres

GameRecord $gameRecord Instance de GameRecord

Renvoie: void

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 du template
UnauthorizedAccessException	Exception levée si l'utilisateur n'est pas dans la partie

Définition à la ligne 471 du fichier ControllerGame.class.php.

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

src/Controllers/ControllerGame.class.php

Fonctions membres publiques

Fonctions membres privées

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ averageElo()

◆ calculateAndUpdateElo()

◆ changeVisibility()

◆ createGame()

◆ endGame()

◆ getGameFolder()

◆ getGameInformations()

◆ getGameModifiableSettings()

◆ getGameSettings()

◆ getGameUrl()

◆ initGame()

◆ isPlayerMuted()

◆ joinGame()

◆ joinGameFromSearch()

◆ joinGameWithCode()

◆ quitGame()

◆ showGame()

◆ showGameSettings()

◆ showHomePage()

◆ showInGame()