Improve phpdoc annotations (#81)

vjik · web-flow · commit 74af81eb7406 · 2021-09-08T18:16:16.000+03:00
diff --git a/composer.json b/composer.json
@@ -24,7 +24,7 @@
         "phpunit/phpunit": "^9.4",
         "roave/infection-static-analysis-plugin": "^1.5",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.9"
+        "vimeo/psalm": "^4.10"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/Paginator/KeysetPaginator.php b/src/Paginator/KeysetPaginator.php
@@ -130,8 +130,6 @@ public function read(): iterable
     }
 
     /**
-     * @return $this
-     *
      * @psalm-mutation-free
      */
     public function withPreviousPageToken(?string $token): self
@@ -143,8 +141,6 @@ public function withPreviousPageToken(?string $token): self
     }
 
     /**
-     * @return $this
-     *
      * @psalm-mutation-free
      */
     public function withNextPageToken(?string $token): self
@@ -172,8 +168,6 @@ public function getNextPageToken(): ?string
     }
 
     /**
-     * @return $this
-     *
      * @psalm-mutation-free
      */
     public function withPageSize(int $pageSize): self
diff --git a/src/Paginator/OffsetPaginator.php b/src/Paginator/OffsetPaginator.php
@@ -73,8 +73,6 @@ public function getCurrentPage(): int
     }
 
     /**
-     * @return $this
-     *
      * @psalm-mutation-free
      */
     public function withCurrentPage(int $page): self
@@ -89,7 +87,7 @@ public function withCurrentPage(int $page): self
     }
 
     /**
-     * @return $this
+     * @return self
      *
      * @psalm-mutation-free
      */
@@ -154,7 +152,7 @@ public function getPreviousPageToken(): ?string
     }
 
     /**
-     * @return $this
+     * @return self
      *
      * @psalm-mutation-free
      */
@@ -164,7 +162,7 @@ public function withNextPageToken(?string $token): self
     }
 
     /**
-     * @return $this
+     * @return self
      *
      * @psalm-mutation-free
      */
diff --git a/src/Paginator/PaginatorInterface.php b/src/Paginator/PaginatorInterface.php
@@ -33,21 +33,21 @@ public function getNextPageToken(): ?string;
     public function getPreviousPageToken(): ?string;
 
     /**
-     * @return $this
+     * @return static
      *
      * @psalm-mutation-free
      */
     public function withNextPageToken(?string $token): self;
 
     /**
-     * @return $this
+     * @return static
      *
      * @psalm-mutation-free
      */
     public function withPreviousPageToken(?string $token): self;
 
     /**
-     * @return $this
+     * @return static
      *
      * @psalm-mutation-free
      */

Original file line number	Diff line number	Diff line change
`@@ -73,8 +73,6 @@ public function getCurrentPage(): int`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`/**`
`76`		`- * @return $this`
`77`		`- *`
`78`	`76`	`* @psalm-mutation-free`
`79`	`77`	`*/`
`80`	`78`	`public function withCurrentPage(int $page): self`
`@@ -89,7 +87,7 @@ public function withCurrentPage(int $page): self`
`89`	`87`	`}`
`90`	`88`
`91`	`89`	`/**`
`92`		`- * @return $this`
	`90`	`+ * @return self`
`93`	`91`	`*`
`94`	`92`	`* @psalm-mutation-free`
`95`	`93`	`*/`
`@@ -154,7 +152,7 @@ public function getPreviousPageToken(): ?string`
`154`	`152`	`}`
`155`	`153`
`156`	`154`	`/**`
`157`		`- * @return $this`
	`155`	`+ * @return self`
`158`	`156`	`*`
`159`	`157`	`* @psalm-mutation-free`
`160`	`158`	`*/`
`@@ -164,7 +162,7 @@ public function withNextPageToken(?string $token): self`
`164`	`162`	`}`
`165`	`163`
`166`	`164`	`/**`
`167`		`- * @return $this`
	`165`	`+ * @return self`
`168`	`166`	`*`
`169`	`167`	`* @psalm-mutation-free`
`170`	`168`	`*/`