Initial fixes for raising PHPStan level to 6

Will still require more work on filling in array item types.
fossar · Feb 8, 2023 · 8a6d6e7 · 8a6d6e7
1 parent ffec474
commit 8a6d6e7
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 12 deletions.
diff --git a/src/controllers/Tags.php b/src/controllers/Tags.php
@@ -30,7 +30,7 @@ public function __construct(Authentication $authentication, \daos\Tags $tagsDao,
         $this->view = $view;
     }
 
-    /* @var ?array<string, array{backColor: string, foreColor: string}> cache of tags and associated colors */
+    /** @var ?array<string, array{backColor: string, foreColor: string}> cache of tags and associated colors */
     protected $tagsColors = null;
 
     /**

diff --git a/src/helpers/ImageUtils.php b/src/helpers/ImageUtils.php
@@ -12,7 +12,7 @@
  * @author     Tobias Zeising <[email protected]>
  */
 class ImageUtils {
-    private static $iconRelWeights = [
+    private const ICON_REL_WEIGHTS = [
         'apple-touch-icon-precomposed' => 3,
         'apple-touch-icon' => 2,
         'shortcut icon' => 1,
@@ -91,7 +91,7 @@ public static function parseShortcutIcons(string $html): array {
 
             // then by rel priority
             [function($val) {
-                return self::$iconRelWeights[$val['rel']];
+                return self::ICON_REL_WEIGHTS[$val['rel']];
             }, Misc::ORDER_DESC],
 
             // and finally by order to make the sorting stable

diff --git a/src/helpers/SimplePieFileGuzzle.php b/src/helpers/SimplePieFileGuzzle.php
@@ -21,9 +21,10 @@ class SimplePieFileGuzzle extends File {
      * @param ?array<string,string> $headers
      * @param ?string $useragent
      * @param bool $force_fsockopen
-     * @param array $curl_options
+     * @param array{'helpers\WebClient'?: WebClient} $curl_options
      */
     public function __construct($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false, $curl_options = []) {
+        assert(isset($curl_options[WebClient::class]));
         $this->webClient = $curl_options[WebClient::class];
         $this->url = $url;
         $this->permanent_url = $url;

diff --git a/src/helpers/SpoutLoader.php b/src/helpers/SpoutLoader.php
@@ -16,7 +16,7 @@
  * @author     Tobias Zeising <[email protected]>
  */
 class SpoutLoader {
-    /** @var ?array<class-string<spout>, spout> array of available spouts */
+    /** @var ?array<class-string<spout<mixed>>, spout<mixed>> array of available spouts */
     private $spouts = null;
 
     /** @var Dice dependency injection container */
@@ -29,7 +29,7 @@ public function __construct(Dice $dice) {
     /**
      * returns all available spouts
      *
-     * @return array<class-string<spout>, spout> available spouts
+     * @return array<class-string<spout<mixed>>, spout<mixed>> available spouts
      */
     public function all(): array {
         $this->readSpouts();
@@ -42,7 +42,7 @@ public function all(): array {
      *
      * @param class-string $spout a given spout type
      *
-     * @return ?spout an instance of the spout, null if this spout doesn't exist
+     * @return ?spout<mixed> an instance of the spout, null if this spout doesn't exist
      */
     public function get(string $spout): ?spout {
         if (!class_exists($spout)) {
@@ -118,8 +118,8 @@ protected function loadClasses(string $location, string $parentClassName): array
     /**
      * compare spouts by name
      *
-     * @param spout $spout1 Spout 1
-     * @param spout $spout2 Spout 2
+     * @param spout<mixed> $spout1 Spout 1
+     * @param spout<mixed> $spout2 Spout 2
      */
     private static function compareSpoutsByName(spout $spout1, spout $spout2): int {
         return strcasecmp($spout1->name, $spout2->name);

diff --git a/src/spouts/Item.php b/src/spouts/Item.php
@@ -73,6 +73,9 @@ public function getId(): string {
         return $this->id;
     }
 
+    /**
+     * @return static
+     */
     public function withId(string $id): self {
         $modified = clone $this;
         $modified->id = $id;
@@ -90,6 +93,9 @@ public function getTitle(): string {
         return $this->title;
     }
 
+    /**
+     * @return static
+     */
     public function withTitle(string $title): self {
         $modified = clone $this;
         $modified->title = $title;
@@ -107,6 +113,9 @@ public function getContent(): string {
         return $this->content;
     }
 
+    /**
+     * @return static
+     */
     public function withContent(string $content): self {
         $modified = clone $this;
         $modified->content = $content;
@@ -121,6 +130,9 @@ public function getThumbnail(): ?string {
         return $this->thumbnail;
     }
 
+    /**
+     * @return static
+     */
     public function withThumbnail(?string $thumbnail): self {
         $modified = clone $this;
         $modified->thumbnail = $thumbnail;
@@ -135,6 +147,9 @@ public function getIcon(): ?string {
         return $this->icon;
     }
 
+    /**
+     * @return static
+     */
     public function withIcon(?string $icon): self {
         $modified = clone $this;
         $modified->icon = $icon;
@@ -149,6 +164,9 @@ public function getLink(): string {
         return $this->link;
     }
 
+    /**
+     * @return static
+     */
     public function withLink(string $link): self {
         $modified = clone $this;
         $modified->link = $link;
@@ -163,6 +181,9 @@ public function getDate(): ?DateTimeInterface {
         return $this->date;
     }
 
+    /**
+     * @return static
+     */
     public function withDate(?DateTimeInterface $date = null): self {
         $modified = clone $this;
         $modified->date = $date;
@@ -179,6 +200,9 @@ public function getAuthor(): ?string {
         return $this->author;
     }
 
+    /**
+     * @return static
+     */
     public function withAuthor(?string $author): self {
         $modified = clone $this;
         $modified->author = $author;

diff --git a/src/spouts/facebook/page.php b/src/spouts/facebook/page.php
@@ -18,6 +18,8 @@
  * @license GPLv3 (https://www.gnu.org/licenses/gpl-3.0.html)
  * @author Tobias Zeising <[email protected]>
  * @author Jan Tojnar <[email protected]>
+ *
+ * @extends \spouts\spout<null>
  */
 class page extends \spouts\spout {
     /** @var string name of source */

diff --git a/src/spouts/github/commits.php b/src/spouts/github/commits.php
@@ -15,6 +15,8 @@
  * @license    GPLv3 (https://www.gnu.org/licenses/gpl-3.0.html)
  * @author     Tobias Zeising <[email protected]>
  * @author     Tim Gerundt <[email protected]>
+ *
+ * @extends \spouts\spout<null>
  */
 class commits extends \spouts\spout {
     /** @var string name of source */

diff --git a/src/spouts/reddit/reddit2.php b/src/spouts/reddit/reddit2.php
@@ -20,6 +20,8 @@
  * @copyright  Copyright (c) Tobias Zeising (http://www.aditu.de)
  * @license    GPLv3 (https://www.gnu.org/licenses/gpl-3.0.html)
  * @author     Tobias Zeising <[email protected]>
+ *
+ * @extends \spouts\spout<null>
  */
 class reddit2 extends \spouts\spout {
     /** @var string name of spout */
@@ -202,7 +204,7 @@ public function destroy(): void {
      * Sign in to reddit using the credentials in params and save a session cookie
      * for further requests.
      *
-     * @param array $params source parameters
+     * @param array<string, string> $params source parameters
      *
      * @throws GuzzleHttp\Exception\GuzzleException When an error is encountered
      * @throws \RuntimeException if the response body is not in JSON format

diff --git a/src/spouts/twitter/usertimeline.php b/src/spouts/twitter/usertimeline.php
@@ -18,6 +18,8 @@
  * @copyright  Copyright (c) Tobias Zeising (http://www.aditu.de)
  * @license    GPLv3 (https://www.gnu.org/licenses/gpl-3.0.html)
  * @author     Tobias Zeising <[email protected]>
+ *
+ * @extends \spouts\spout<null>
  */
 class usertimeline extends \spouts\spout {
     /** @var string name of source */
@@ -126,7 +128,7 @@ public function getHttpClient(
      * Assumes client property is initialized to Guzzle client configured to access Twitter.
      *
      * @param string $endpoint API endpoint to use
-     * @param array $params extra query arguments to pass to the API call
+     * @param array<string, string> $params extra query arguments to pass to the API call
      *
      * @throws \Exception when API request fails
      * @throws GuzzleHttp\Exception\GuzzleException when HTTP request fails for API-unrelated reasons

diff --git a/tests/Spouts/YouTubeTest.php b/tests/Spouts/YouTubeTest.php
@@ -60,7 +60,10 @@ public function testBasic(string $url, string $feedTitle, string $firstItemTitle
         $this->assertEquals($firstItemTitle, $yt->getItems()->current()->getTitle());
     }
 
-    public function dataProvider() {
+    /**
+     * @return array<array{url: string, feedTitle: string, firstItemTitle: string}>
+     */
+    public function dataProvider(): array {
         return [
             [
                 'url' => 'https://www.youtube.com/user/ZoggFromBetelgeuse',