Classe GameRecordDAO. Plus de détails...

Fonctions membres publiques
	__construct (?PDO $pdo)
	Constructeur de la classe GameRecordDAO.

	findByGameId (int $gameId)
	Retourne la liste des parties grâce à l'ID du jeu.

	getPdo ()
	Retourne la connexion à la base de données.

	setPdo (?PDO $pdo)
	Modifie la connexion à la base de données.

	findByGameIdAndState (int $gameId, GameRecordState $state)
	Retourne la liste des parties grâce à l'ID du jeu.

	findByCode (string $code)
	Retourne un objet GameRecord (ou null) à partir du code passé en paramètre.

	findByHostUuid (string $uuid)
	Retourne un tableau d'objets GameRecord (ou null) à partir de l'UUID passé en paramètre correspondant aux parties hébergées par un joueur.

	findByState (GameRecordState $state)
	Retourne un tableau d'objets GameRecord (ou null) à partir de l'état passé en paramètre.

	insert (GameRecord $gameRecord)
	Insère un enregistrement de partie en base de données.

	update (GameRecord $gameRecord)
	Met à jour un enregistrement de partie en base de données.

	updatePlayers (string $gameCode, array $players)
	Met à jour les joueurs d'une partie en base de données.

	delete (string $code)
	Supprime un enregistrement de partie en base de données.

	addPlayer (GameRecord $gameRecord, Player $player)
	Ajoute un joueur à une partie en base de données.

	removePlayer (string $gameCode, string $playerUuid)
	Supprime un joueur d'une partie.

	addWinner (string $code, mixed $uuid)
	Enregistre un gagnant d'une partie dans la table cp_won.

Fonctions membres privées
	hydrateMany (array $rows)
	Retourne la liste des parties hydratées.

	hydrate (array $row)
	Retourne un enregistrement de partie hydraté

	findPlayersByGameRecordCode (string $code)
	Retourne la liste des joueurs dans une partie grâce au code de celle-ci.

Attributs privés
PDO	$pdo

Description détaillée

Classe GameRecordDAO.

La classe GameRecordDAO permet de gérer les parties en base de données

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

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( ?PDO $pdo )

Constructeur de la classe GameRecordDAO.

Paramètres

PDO | null $pdo Connexion à la base de données

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

Documentation des fonctions membres

◆ addPlayer()

addPlayer	(	GameRecord	$gameRecord,
		Player	$player )

Ajoute un joueur à une partie en base de données.

Paramètres

GameRecord	$gameRecord	Enregistrement de la partie
Player	$player	Joueur à ajouter

Renvoie: bool Retourne true si l'ajout a réussi, false sinon

Définition à la ligne 362 du fichier gameRecord.dao.php.

◆ addWinner()

addWinner	(	string	$code,
		mixed	$uuid )

Enregistre un gagnant d'une partie dans la table cp_won.

Paramètres

string	$code	Code de la partie
mixed	$uuid	UUID du joueur gagnant

Renvoie: bool Retourne true si l'ajout a réussi, false sinon

Définition à la ligne 393 du fichier gameRecord.dao.php.

◆ delete()

delete ( string $code )

Supprime un enregistrement de partie en base de données.

Paramètres

string $code Code de la partie à supprimer

Renvoie: bool Retourne true si la suppression a réussi, false sinon

Définition à la ligne 349 du fichier gameRecord.dao.php.

◆ findByCode()

findByCode ( string $code )

Retourne un objet GameRecord (ou null) à partir du code passé en paramètre.

Paramètres

string $code Code de la partie recherchée

Renvoie: GameRecord|null Enregistrement de la partie (GameRecord) (ou null si non-trouvé)

Exceptions

Exception

Définition à la ligne 191 du fichier gameRecord.dao.php.

◆ findByGameId()

findByGameId ( int $gameId )

Retourne la liste des parties grâce à l'ID du jeu.

Paramètres

int $gameId ID de la partie

Renvoie: GameRecord[]|null Tableau d'objets GameRecord (ou null si une erreur survient)

Exceptions

Exception Exception levée en cas d'erreur lors de l'hydratation

Définition à la ligne 44 du fichier gameRecord.dao.php.

◆ findByGameIdAndState()

findByGameIdAndState	(	int	$gameId,
		GameRecordState	$state )

Retourne la liste des parties grâce à l'ID du jeu.

Paramètres

int	$gameId	ID de la partie
GameRecordState	$state	Etat de la partie

Renvoie: GameRecord[]|null Tableau d'objets GameRecord (ou null si une erreur survient)

Exceptions

Exception Exception levée en cas d'erreur lors de l'hydratation

Définition à la ligne 162 du fichier gameRecord.dao.php.

◆ findByHostUuid()

findByHostUuid ( string $uuid )

Retourne un tableau d'objets GameRecord (ou null) à partir de l'UUID passé en paramètre correspondant aux parties hébergées par un joueur.

Paramètres

string $uuid L'UUID du joueur ayant hébergé les parties

Renvoie: GameRecord[]|null Tableau de GameRecord (ou null si non-trouvé)

Exceptions

Exception

Définition à la ligne 212 du fichier gameRecord.dao.php.

◆ findByState()

findByState ( GameRecordState $state )

Retourne un tableau d'objets GameRecord (ou null) à partir de l'état passé en paramètre.

Paramètres

GameRecordState $state L'état des parties recherchées

Renvoie: GameRecord[]|null Tableau de GameRecord (ou null si non-trouvé)

Exceptions

Exception

Définition à la ligne 234 du fichier gameRecord.dao.php.

◆ findPlayersByGameRecordCode()

findPlayersByGameRecordCode ( string $code )

private

Retourne la liste des joueurs dans une partie grâce au code de celle-ci.

Paramètres

string $code Code de la partie

Renvoie: array|null

Définition à la ligne 142 du fichier gameRecord.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 123 du fichier gameRecord.dao.php.

◆ hydrate()

hydrate ( array $row )

private

Retourne un enregistrement de partie hydraté

Paramètres

array $row Ligne de la table game_record

Renvoie: GameRecord Enregistrement de la partie hydraté

Exceptions

Exception Exception levée en cas d'erreur lors de l'hydratation

Définition à la ligne 78 du fichier gameRecord.dao.php.

◆ hydrateMany()

hydrateMany ( array $rows )

private

Retourne la liste des parties hydratées.

Paramètres

array $rows Tableau de lignes de la table game_record

Renvoie: GameRecord[] Tableau d'objets GameRecord

Exceptions

Exception Exception levée en cas d'erreur lors de l'hydratation

Définition à la ligne 63 du fichier gameRecord.dao.php.

◆ insert()

insert ( GameRecord $gameRecord )

Insère un enregistrement de partie en base de données.

Paramètres

GameRecord $gameRecord Enregistrement de la partie à insérer

Renvoie: bool Retourne true si l'insertion a réussi, false sinon

Définition à la ligne 260 du fichier gameRecord.dao.php.

◆ removePlayer()

removePlayer	(	string	$gameCode,
		string	$playerUuid )

Supprime un joueur d'une partie.

Paramètres

string	$gameCode	Code de la partie
string	$playerUuid	UUID du joueur à supprimer

Renvoie: bool Retourne true si la suppression a réussi, false sinon

Définition à la ligne 379 du fichier gameRecord.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 132 du fichier gameRecord.dao.php.

◆ update()

update ( GameRecord $gameRecord )

Met à jour un enregistrement de partie en base de données.

Paramètres

GameRecord $gameRecord Enregistrement de la partie à mettre à jour

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

Définition à la ligne 297 du fichier gameRecord.dao.php.

◆ updatePlayers()

updatePlayers	(	string	$gameCode,
		array	$players )

Met à jour les joueurs d'une partie en base de données.

Paramètres

string	$gameCode	Code de la partie à modifier
array	$players	Tableau de joueurs à mettre à jour

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

Définition à la ligne 329 du fichier gameRecord.dao.php.

Documentation des champs

◆ $pdo

PDO $pdo

private

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

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

src/Models/gameRecord.dao.php

Fonctions membres publiques

Fonctions membres privées

Attributs privés

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ addPlayer()

◆ addWinner()

◆ delete()

◆ findByCode()

◆ findByGameId()

◆ findByGameIdAndState()

◆ findByHostUuid()

◆ findByState()

◆ findPlayersByGameRecordCode()

◆ getPdo()

◆ hydrate()

◆ hydrateMany()

◆ insert()

◆ removePlayer()

◆ setPdo()

◆ update()

◆ updatePlayers()

Documentation des champs

◆ $pdo