Add comments and cleanup code

MartDel · MartDel · commit 6b25bace878e · 2021-03-30T11:36:06.000+02:00
diff --git a/index.html b/index.html
@@ -1,8 +1,8 @@
 <!DOCTYPE html>
-<html lang="fr" dir="ltr">
+<html lang="en" dir="ltr">
     <head>
         <meta charset="utf-8" />
-        <title>Chat</title>
+        <title>Chat - Client</title>
     </head>
     <body>
         <!-- Form to send messages -->
@@ -15,19 +15,19 @@
         <ul id="chat"></ul>
 
         <script type="text/javascript">
+            const FORM_ID = 'msg_form'
+            const CHAT_ID = 'chat'
+            const SOCKET_HOST = 'ws://localhost:8080'
+
             // Manage socket
-            const socket = new WebSocket('ws://localhost:8080');
-            socket.onopen = function(e) {
-                const target = e.target
-                console.log('Connected to ' + target.url);
-            }
-            socket.onmessage = function(e) {
-                const msg = e.data
-                addMessage(msg)
-            }
+            const socket = new WebSocket(SOCKET_HOST);
+            // The socket is open
+            socket.onopen = (e) => console.log('Connected to ' + e.target.url)
+            // The client get a message
+            socket.onmessage = (e) => addMessage(e.data)
 
             // Send message from the form
-            document.getElementById('msg_form').onsubmit = (e) => {
+            document.getElementById(FORM_ID).onsubmit = (e) => {
                 e.preventDefault()
                 const form = e.target
                 const msg = form[0].value
@@ -36,11 +36,14 @@
                 socket.send(msg)
             }
 
-            // Add a message to the chat
+            /**
+             * Add a message to the chat
+             * @param {String} msg The message to add
+             */
             function addMessage(msg){
                 const list_node = document.createElement('LI')
                 list_node.innerText = msg
-                document.getElementById('chat').appendChild(list_node)
+                document.getElementById(CHAT_ID).appendChild(list_node)
             }
         </script>
     </body>
diff --git a/server.php b/server.php
@@ -2,12 +2,14 @@
 
 require __DIR__.'/vendor/autoload.php';
 
+// Include Ratchet
 use Ratchet\Server\IoServer;
 use Ratchet\Http\HttpServer;
 use Ratchet\WebSocket\WsServer;
 use Ratchet\MessageComponentInterface;
 use Ratchet\ConnectionInterface;
 
+// Define the app port
 define('APP_PORT', 8080);
 
 class ServerImpl implements MessageComponentInterface {
@@ -17,39 +19,52 @@ public function __construct() {
         $this->clients = new \SplObjectStorage;
     }
 
+    /**
+     * A new connection is on
+     * @param ConnectionInterface $conn Connection data
+     */
     public function onOpen(ConnectionInterface $conn) {
         $this->clients->attach($conn);
-        echo "New connection! ({$conn->resourceId}).\n";
+        echo "New connection : {$conn->resourceId}\n";
     }
 
+    /**
+     * A message is received
+     * @param ConnectionInterface $conn Sender connection data
+     * @param String $msg The received message
+     */
     public function onMessage(ConnectionInterface $conn, $msg) {
-        echo sprintf("New message from '%s': %s\n\n\n", $conn->resourceId, $msg);
-        foreach ($this->clients as $client) { // BROADCAST
+        echo sprintf("New message from '%s': %s\n", $conn->resourceId, $msg);
+        // Send the received message to all connected clients
+        foreach ($this->clients as $client) {
             $message = json_decode($msg, true);
             if ($conn !== $client) {
                 $client->send($msg);
             }
         }
     }
 
+    /**
+     * A connection is over
+     * @param ConnectionInterface $conn Connection data
+     */
     public function onClose(ConnectionInterface $conn) {
         $this->clients->detach($conn);
-        echo "Connection {$conn->resourceId} is gone.\n";
+        echo "Connection to {$conn->resourceId} is over.\n";
     }
 
+    /**
+     * An error is occured
+     * @param ConnectionInterface $conn Involved connection data
+     * @param Exception $e Error data
+     */
     public function onError(ConnectionInterface $conn, \Exception $e) {
-        echo "An error occured on connection {$conn->resourceId}: {$e->getMessage()}\n\n\n";
+        echo "An error occured on connection {$conn->resourceId}: {$e->getMessage()}\n\n";
         $conn->close();
     }
 }
 
-$server = IoServer::factory(
-    new HttpServer(
-        new WsServer(
-            new ServerImpl()
-        )
-    ),
-    APP_PORT
-);
-echo "Server created on port " . APP_PORT . "\n\n";
+// Create and run the server
+$server = IoServer::factory(new HttpServer(new WsServer(new ServerImpl())), APP_PORT);
+echo "Server is running on port " . APP_PORT . "...\n";
 $server->run();
