Référence de la classe GameRecord

Classe GameRecord. Plus de détails...

Graphe de collaboration de GameRecord:

Fonctions membres publiques
	__construct (string $code, Game $game, ?Player $hostedBy, ?array $players, GameRecordState $state, bool $isPrivate, ?string $token=null, ?DateTime $createdAt=null, ?DateTime $updatedAt=null, ?DateTime $finishedAt=null)
	Constructeur de la classe GameRecord.
	getCode ()
	Getter de l'attribut uuid.
	setCode (string $code)
	Setter de l'attribut uuid.
	getToken ()
	Getter de l'attribut token.
	setToken (?string $token)
	Setter de l'attribut token.
	generateToken ()
	Génère un token aléatoire pour la partie.
	getGame ()
	Getter de l'attribut game.
	setGame (Game $game)
	Setter de l'attribut game.
	getHostedBy ()
	Getter de l'attribut hostedBy.
	setHostedBy (?Player $player)
	Setter de l'attribut hostedBy.
	getPlayers ()
	Getter de l'attribut players.
	setPlayers (?array $players)
	Setter de l'attribut players.
	getState ()
	Getter de l'attribut state.
	setState (GameRecordState $state)
	Setter de l'attribut state.
	isPrivate ()
	Getter de l'attribut isPrivate.
	setPrivate (bool $isPrivate)
	Setter de l'attribut isPrivate.
	getCreatedAt ()
	Getter de l'attribut createdAt.
	setCreatedAt (DateTime $createdAt)
	Setter de l'attribut createdAt.
	getUpdatedAt ()
	Getter de l'attribut updatedAt.
	setUpdatedAt (DateTime $updatedAt)
	Setter de l'attribut updatedAt.
	getFinishedAt ()
	Getter de l'attribut finishedAt.
	setFinishedAt (?DateTime $finishedAt)
	Setter de l'attribut finishedAt.
	addPlayer (Player $player)
	Ajoute un joueur à la partie.
	removePlayer (Player $player)
	Supprime un joueur de la partie.

Attributs privés
string	$code
string	$token
Game	$game
Player	$hostedBy
array	$players
GameRecordState	$state
bool	$private
DateTime	$createdAt
DateTime	$updatedAt
DateTime	$finishedAt

Description détaillée

Classe GameRecord.

La classe GameRecord permet de représenter une partie avec ses attributs et ses méthodes

Définition à la ligne 52 du fichier gameRecord.class.php.

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$code,
		Game	$game,
		?Player	$hostedBy,
		?array	$players,
		GameRecordState	$state,
		bool	$isPrivate,
		?string	$token = null,
		?DateTime	$createdAt = null,
		?DateTime	$updatedAt = null,
		?DateTime	$finishedAt = null )

Constructeur de la classe GameRecord.

Paramètres

string	$code	Identifiant de la partie
string | null	$token	Token de la partie
Game	$game	Jeu de la partie
Player | null	$hostedBy	Joueur qui a créé la partie
Player[] | null	$players	Joueurs de la partie
GameRecordState	$state	Etat de la partie
bool	$isPrivate	Indique si la partie est privée
DateTime | null	$createdAt	Date de création de la partie
DateTime | null	$updatedAt	Date de dernière mise à jour de la partie
DateTime | null	$finishedAt	Date de fin de la partie

Définition à la ligne 120 du fichier gameRecord.class.php.

Documentation des fonctions membres

addPlayer()

addPlayer

(

Player

$player

)

Ajoute un joueur à la partie.

Paramètres

Player

$player

Joueur à ajouter

Renvoie

void

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

generateToken()

generateToken

(

)

Génère un token aléatoire pour la partie.

Renvoie

string Token généré en clair

Exceptions

RandomException

Exception levée en cas d'erreur lors de la génération du token

Définition à la ligne 181 du fichier gameRecord.class.php.

getCode()

getCode

(

)

Getter de l'attribut uuid.

Renvoie

string Identifiant de la partie

Définition à la ligne 139 du fichier gameRecord.class.php.

getCreatedAt()

getCreatedAt

(

)

Getter de l'attribut createdAt.

Renvoie

DateTime Date de création de la partie

Définition à la ligne 298 du fichier gameRecord.class.php.

getFinishedAt()

getFinishedAt

(

)

Getter de l'attribut finishedAt.

Renvoie

DateTime|null Date de fin de la partie

Définition à la ligne 340 du fichier gameRecord.class.php.

getGame()

getGame

(

)

Getter de l'attribut game.

Renvoie

Game Jeu de la partie

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

getHostedBy()

getHostedBy

(

)

Getter de l'attribut hostedBy.

Renvoie

Player Joueur qui a créé la partie

Définition à la ligne 214 du fichier gameRecord.class.php.

getPlayers()

getPlayers

(

)

Getter de l'attribut players.

Renvoie

Player[]|null Tableau des joueurs

Définition à la ligne 235 du fichier gameRecord.class.php.

getState()

getState

(

)

Getter de l'attribut state.

Renvoie

GameRecordState Etat de la partie

Définition à la ligne 256 du fichier gameRecord.class.php.

getToken()

getToken

(

)

Getter de l'attribut token.

Renvoie

string|null Token de la partie

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

getUpdatedAt()

getUpdatedAt

(

)

Getter de l'attribut updatedAt.

Renvoie

DateTime Date de dernière mise à jour de la partie

Définition à la ligne 319 du fichier gameRecord.class.php.

isPrivate()

isPrivate

(

)

Getter de l'attribut isPrivate.

Renvoie

bool Indique si la partie est privée

Définition à la ligne 277 du fichier gameRecord.class.php.

removePlayer()

removePlayer

(

Player

$player

)

Supprime un joueur de la partie.

Paramètres

Player

$player

Joueur à supprimer

Renvoie

void

Définition à la ligne 371 du fichier gameRecord.class.php.

setCode()

setCode

(

string

$code

)

Setter de l'attribut uuid.

Paramètres

string

$code

Identifiant de la partie

Renvoie

void

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

setCreatedAt()

setCreatedAt

(

DateTime

$createdAt

)

Setter de l'attribut createdAt.

Paramètres

DateTime

$createdAt

Date de création de la partie

Renvoie

void

Définition à la ligne 309 du fichier gameRecord.class.php.

setFinishedAt()

setFinishedAt

(

?DateTime

$finishedAt

)

Setter de l'attribut finishedAt.

Paramètres

DateTime | null

$finishedAt

Date de fin de la partie

Renvoie

void

Définition à la ligne 351 du fichier gameRecord.class.php.

setGame()

setGame

(

Game

$game

)

Setter de l'attribut game.

Paramètres

Game

$game

Jeu de la partie

Renvoie

void

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

setHostedBy()

setHostedBy

(

?Player

$player

)

Setter de l'attribut hostedBy.

Paramètres

Player | null

$player

Joueur qui a créé la partie

Renvoie

void

Définition à la ligne 225 du fichier gameRecord.class.php.

setPlayers()

setPlayers

(

?array

$players

)

Setter de l'attribut players.

Paramètres

Player[] | null

$players

Tableau des joueurs

Renvoie

void

Définition à la ligne 246 du fichier gameRecord.class.php.

setPrivate()

setPrivate

(

bool

$isPrivate

)

Setter de l'attribut isPrivate.

Paramètres

bool

$isPrivate

Indique si la partie est privée

Renvoie

void

Définition à la ligne 288 du fichier gameRecord.class.php.

setState()

setState

(

GameRecordState

$state

)

Setter de l'attribut state.

Paramètres

GameRecordState

$state

Etat de la partie

Renvoie

void

Définition à la ligne 267 du fichier gameRecord.class.php.

setToken()

setToken

(

?string

$token

)

Setter de l'attribut token.

Paramètres

string | null

$token

Token de la partie

Renvoie

void

Définition à la ligne 171 du fichier gameRecord.class.php.

setUpdatedAt()

setUpdatedAt

(

DateTime

$updatedAt

)

Setter de l'attribut updatedAt.

Paramètres

DateTime

$updatedAt

Date de dernière mise à jour de la partie

Renvoie

void

Définition à la ligne 330 du fichier gameRecord.class.php.

Documentation des champs

$code

string $code

private

Définition à la ligne 58 du fichier gameRecord.class.php.

$createdAt

DateTime $createdAt

private

Définition à la ligne 94 du fichier gameRecord.class.php.

$finishedAt

DateTime $finishedAt

private

Définition à la ligne 104 du fichier gameRecord.class.php.

$game

Game $game

private

Définition à la ligne 69 du fichier gameRecord.class.php.

$hostedBy

Player $hostedBy

private

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

$players

array $players

private

Définition à la ligne 79 du fichier gameRecord.class.php.

$private

bool $private

private

Définition à la ligne 89 du fichier gameRecord.class.php.

$state

GameRecordState $state

private

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

$token

string $token

private

Définition à la ligne 64 du fichier gameRecord.class.php.

$updatedAt

DateTime $updatedAt

private

Définition à la ligne 99 du fichier gameRecord.class.php.

---

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

• src/Models/gameRecord.class.php