add: code documentation and code refactoring

composer.json

@@ -23,7 +23,8 @@
         "guzzlehttp/guzzle": "^7.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.5",
+        "symfony/var-dumper": "^6.1"
     },
     "license": "MIT"
 }

src/Auth/Authentication.php

@@ -14,6 +14,8 @@ class Authentication
     private string $api_key;
 
     /**
+     * Create an Authentication class instance.
+     *
      * @param string $api_key
      */
     public function __construct(string $api_key = '')
@@ -22,6 +24,8 @@ public function __construct(string $api_key = '')
     }
 
     /**
+     * Set yor api key in instance, you can get at R6Stats Discord (https://discord.gg/2Hz8wrKk3z).
+     *
      * @param string $api_key
      */
     public function setApiKey(string $api_key): void
@@ -30,6 +34,8 @@ public function setApiKey(string $api_key): void
     }
 
     /**
+     * Get yor api key in instance, if you don't have an api key, you can get at R6Stats Discord (https://discord.gg/2Hz8wrKk3z).
+     *
      * @return string
      */
     public function getApiKey(): string

src/Stats/Contracts/GameInterface.php

@@ -2,7 +2,12 @@
 
 namespace RainbowStats\RainbowStats\Stats\Contracts;
 
+use stdClass;
+
 interface GameInterface
 {
-    public function leaderboard(): array|string|\stdClass;
+    /**
+     * @return array|string|stdClass
+     */
+    public function leaderboard(): array|string|stdClass;
 }

src/Stats/Game.php

@@ -8,15 +8,29 @@
 
 class Game implements GameInterface
 {
+    /**
+     * @var StatsApi
+     */
     private StatsApi $api;
 
+    /**
+     * Create a Game class instance.
+     *
+     * @param Authentication $authentication
+     * @param array $data
+     */
     public function __construct(Authentication $authentication, array $data)
     {
         $this->api = new StatsApi($authentication, $data);
     }
 
+    /**
+     * Get the game leaderboard. Returns an array with a maximum of 100 objects with information for each player.
+     *
+     * @return array|string|stdClass
+     */
     public function leaderboard(): array|string|stdClass
     {
-        return $this->api->leaderboard('game');
+        return $this->api->leaderboard();
     }
 }