refactor: Fix deprecations and fix return type of getCard() (#94)

tcgdex · Jan 14, 2025 · 77a67d3 · 77a67d3
1 parent 18237d4
commit 77a67d3
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 11 deletions.
diff --git a/src/Endpoints/Endpoint.php b/src/Endpoints/Endpoint.php
@@ -36,7 +36,7 @@ public function get(string|int $id)
      /**
       * @return Array<List>
       */
-    public function list(Query $query = null): array
+    public function list(?Query $query = null): array
     {
         $res = $this->tcgdex->fetchWithParams([$this->endpoint], is_null($query) ? null : $query->params);
         if (is_null($this->listModel)) {

diff --git a/src/Endpoints/SetEndpoint.php b/src/Endpoints/SetEndpoint.php
@@ -24,7 +24,7 @@ public function __construct(
         );
     }
 
-    public function getCard(string $set, string $localId): Card
+    public function getCard(string $set, string $localId): ?Card
     {
         $res = $this->tcgdex->fetch($this->endpoint, $set, $localId);
         return Model::build(new Card($this->tcgdex), $res);

diff --git a/src/Model/Card.php b/src/Model/Card.php
@@ -127,4 +127,6 @@ protected function fill(object $data): void
     public ?string $regulationMark = null;
 
     public Legal $legal;
+
+    public ?string $updated = null;
 }
diff --git a/src/Request.php b/src/Request.php
@@ -22,7 +22,7 @@ public static function fetch(...$path)
      * @param string $url
      * @param Array<string, string> $params
      */
-    public static function fetchWithParams(string $url, array $params = null): mixed
+    public static function fetchWithParams(string $url, ?array $params = null): mixed
     {
         if (!is_null($params)) {
             $mapped = array_map(function (string $key, string $value) {

diff --git a/src/TCGdex.php b/src/TCGdex.php
@@ -77,10 +77,7 @@ public static function getVersion()
      */
     public $lang = "en";
 
-    /**
-     * @param String|null $lang
-     */
-    public function __construct($lang = null)
+    public function __construct(?string $lang = null)
     {
         if (is_null(TCGdex::$cache)) {
             // no PSR16 implementation found, try loading the base one
@@ -232,7 +229,7 @@ public function fetch(...$endpoint)
      * @param Array<string> $params the list of parameters to add
      * @return mixed|null
      */
-    public function fetchWithParams(array $endpoint, array $params = null)
+    public function fetchWithParams(array $endpoint, ?array $params = null)
     {
         return Request::fetchWithParams(
             Request::makePath(TCGdex::BASE_URI, $this->lang, ...$endpoint),

diff --git a/tests/TCGdexTest.php b/tests/TCGdexTest.php
@@ -32,10 +32,10 @@ public function testCache(): void
         TCGdex::$client = new Psr18Mock("{\"id\": \"1\"}");
         $tcgdex = new TCGdex("en");
         $card1 = $tcgdex->card->get('testCache');
-        $this->assertEquals($card1->id, "1");
+        $this->assertEquals("1", $card1->id);
         TCGdex::$client = new Psr18Mock("{\"id\": \"2\"}");
         $card2 = $tcgdex->card->get('testCache');
-        $this->assertEquals($card2->id, "1");
+        $this->assertEquals("1", $card2->id);
     }
 
     public function testRealEndpoints(): void
@@ -73,6 +73,15 @@ public function testRealEndpoints(): void
         }
     }
 
+    public function testUnknownCard(): void
+    {
+        TCGdex::$client = null;
+        $tcgdex = new TCGdex("en");
+        $card = $tcgdex->set->getCard('unknownSet', 'unknownCard');
+
+        $this->assertNull($card);
+    }
+
     public function testFetchFullCardFromResume(): void
     {
         TCGdex::$client = null;
@@ -89,6 +98,6 @@ public function testFetchFullSerieFromResume(): void
         $tcgdex = new TCGdex("en");
         $series = $tcgdex->serie->list();
         $this->assertNotEmpty($series);
-        $this->assertNotEmpty($series[0]->fetchFullSerie());
+        $this->assertNotEmpty($series[0]->toSerie());
     }
 }