Référence de la classe Game

Classe Game (Sockets) Plus de détails...

Graphe d'héritage de Game:

Graphe de collaboration de Game:

Fonctions membres publiques
	__construct ()
	Constructeur de la classe Game.
	onOpen (ConnectionInterface $conn)
	Fonction appelée lors de la connexion d'un joueur.
	onMessage (ConnectionInterface $from, $msg)
	Fonction appelée lors de la réception d'un message.
	onClose (ConnectionInterface $conn)
	Ferme la connexion d'un client.
	onError (ConnectionInterface $conn, Exception $e)
	Fonction appelée lors d'une erreur.

Fonctions membres protégées
	escape (string $string)
	Fonction permettant d'échapper les caractères spéciaux.

Attributs protégés
SplObjectStorage	$clients
array	$games

Fonctions membres privées
	updatePlayer (string $game)
	Envoie un signal à tous les clients avec la nouvelle liste des joueurs.
	sendToGame (string $game, string $command, string $content)
	Fonction permettant d'envoyer un message à une partie.
	redirectUserToGame (string $game, string $uuid)
	Redirige un joueur vers la partie si elle a commencé

Description détaillée

Classe Game (Sockets)

Classe permettant de gérer le jeu en temps réel

Définition à la ligne 25 du fichier Game.php.

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

Constructeur de la classe Game.

Définition à la ligne 42 du fichier Game.php.

Documentation des fonctions membres

escape()

escape ( string $string )

protected

Fonction permettant d'échapper les caractères spéciaux.

Paramètres

string

$string

La chaîne à échapper

Renvoie

string La chaîne échappée

Définition à la ligne 189 du fichier Game.php.

onClose()

onClose

(

ConnectionInterface

$conn

)

Ferme la connexion d'un client.

Paramètres

ConnectionInterface

$conn

Connexion à fermer

Renvoie

void

Exceptions

Exception

Exception levée dans le cas d'une erreur

Définition à la ligne 160 du fichier Game.php.

onError()

onError	(	ConnectionInterface	$conn,
		Exception	$e )

Fonction appelée lors d'une erreur.

Paramètres

ConnectionInterface	$conn	La connexion du joueur
Exception	$e	L'exception levée

Définition à la ligne 178 du fichier Game.php.

onMessage()

onMessage	(	ConnectionInterface	$from,
			$msg )

Fonction appelée lors de la réception d'un message.

Gère l'affichage des joueurs en temps réel

Paramètres

ConnectionInterface	$from	La connexion du joueur
string	$msg	Le message reçu

Exceptions

Exception

Exception levée si le message est invalide

Définition à la ligne 65 du fichier Game.php.

onOpen()

onOpen

(

ConnectionInterface

$conn

)

Fonction appelée lors de la connexion d'un joueur.

Envoie un message de confirmation de connexion

Paramètres

ConnectionInterface

$conn

La connexion du joueur

Définition à la ligne 53 du fichier Game.php.

redirectUserToGame()

redirectUserToGame ( string $game, string $uuid )

private

Redirige un joueur vers la partie si elle a commencé

Paramètres

string	$game	Code de la partie
string	$uuid	UUID du joueur

Renvoie

void

Exceptions

Exception

Exception levée quand la partie n'existe pas

Définition à la ligne 144 du fichier Game.php.

sendToGame()

sendToGame ( string $game, string $command, string $content )

private

Fonction permettant d'envoyer un message à une partie.

Paramètres

string	$game	La partie à laquelle envoyer le message
string	$command	La commande à envoyer
string	$content	Le contenu du message

Définition à la ligne 130 du fichier Game.php.

updatePlayer()

updatePlayer ( string $game )

private

Envoie un signal à tous les clients avec la nouvelle liste des joueurs.

Paramètres

string

$game

Code de la partie

Renvoie

void

Exceptions

Exception

Exception levée quand la partie n'existe pas

Définition à la ligne 105 du fichier Game.php.

Documentation des champs

$clients

SplObjectStorage $clients

protected

Définition à la ligne 31 du fichier Game.php.

$games

array $games

protected

Définition à la ligne 37 du fichier Game.php.

---

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

• src/App/Sockets/Game.php