Référence de la classe Chat

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

Graphe d'héritage de Chat:

Graphe de collaboration de Chat:

Fonctions membres publiques
	__construct ()
	Constructeur de la classe Chat.
	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)
	Fonction appelée lors de la déconnexion d'un joueur.
	onError (ConnectionInterface $conn, Exception $e)
	Fonction appelée lorsqu'une erreur survient.

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

Description détaillée

Classe Chat (Sockets)

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

Définition à la ligne 27 du fichier Chat.php.

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

Constructeur de la classe Chat.

Définition à la ligne 44 du fichier Chat.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 122 du fichier Chat.php.

onClose()

onClose

(

ConnectionInterface

$conn

)

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

Retire le joueur de la liste des clients

Paramètres

ConnectionInterface

$conn

La connexion du joueur

Définition à la ligne 132 du fichier Chat.php.

onError()

onError	(	ConnectionInterface	$conn,
		Exception	$e )

Fonction appelée lorsqu'une erreur survient.

Ferme la connexion

Paramètres

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

Définition à la ligne 155 du fichier Chat.php.

onMessage()

onMessage	(	ConnectionInterface	$from,
			$msg )

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

Envoie le message à tous les joueurs de la partie

Paramètres

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

Exceptions

DateMalformedStringException

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

Définition à la ligne 75 du fichier Chat.php.

onOpen()

onOpen

(

ConnectionInterface

$conn

)

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

Ajoute le joueur à la liste des clients

Paramètres

ConnectionInterface

$conn

La connexion du joueur

Définition à la ligne 55 du fichier Chat.php.

Documentation des champs

$clients

SplObjectStorage $clients

protected

Définition à la ligne 33 du fichier Chat.php.

$games

array $games

protected

Définition à la ligne 39 du fichier Chat.php.

---

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

• src/App/Sockets/Chat.php