Merge pull request codeigniter4#7771 from ping-yee/220804-phpstan-pag…

…er-publisher-restful Dev: Remove the `Pager`, `Publisher` and `RESTful` ignore errors in phpstan-baseline.php
datamweb · Aug 6, 2023 · 04b70af · 04b70af
2 parents eaa8f1a + 3eb083c
commit 04b70af
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 56 deletions.
diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -1321,61 +1321,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Model.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Exceptions\\\\PagerException\\:\\:forInvalidPaginationGroup\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Exceptions/PagerException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Exceptions\\\\PagerException\\:\\:forInvalidTemplate\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Exceptions/PagerException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Pager\\:\\:calculateCurrentPage\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Pager.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\Pager\\:\\:ensureGroup\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/Pager.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Pager\\\\PagerRenderer\\:\\:updatePages\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Pager/PagerRenderer.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Exceptions\\\\PublisherException\\:\\:forCollision\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Exceptions/PublisherException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Exceptions\\\\PublisherException\\:\\:forDestinationNotAllowed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Exceptions/PublisherException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Exceptions\\\\PublisherException\\:\\:forFileNotAllowed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Exceptions/PublisherException.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Publisher\\\\Publisher\\:\\:verifyAllowed\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Publisher/Publisher.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\RESTful\\\\BaseResource\\:\\:initController\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/RESTful/BaseResource.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\RESTful\\\\BaseResource\\:\\:setModel\\(\\) has no return type specified\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/RESTful/BaseResource.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Router\\\\AutoRouter\\:\\:setDirectory\\(\\) has no return type specified\\.$#',
 	'count' => 1,

diff --git a/system/Pager/Exceptions/PagerException.php b/system/Pager/Exceptions/PagerException.php
@@ -15,11 +15,21 @@
 
 class PagerException extends FrameworkException
 {
+    /**
+     * Throws when the template is invalid.
+     *
+     * @return static
+     */
     public static function forInvalidTemplate(?string $template = null)
     {
         return new static(lang('Pager.invalidTemplate', [$template]));
     }
 
+    /**
+     * Throws when the group is invalid.
+     *
+     * @return static
+     */
     public static function forInvalidPaginationGroup(?string $group = null)
     {
         return new static(lang('Pager.invalidPaginationGroup', [$group]));

diff --git a/system/Pager/Pager.php b/system/Pager/Pager.php
@@ -388,6 +388,8 @@ public function only(array $queries): self
      * Ensures that an array exists for the group specified.
      *
      * @param int $perPage
+     *
+     * @return void
      */
     protected function ensureGroup(string $group, ?int $perPage = null)
     {
@@ -414,6 +416,8 @@ protected function ensureGroup(string $group, ?int $perPage = null)
 
     /**
      * Calculating the current page
+     *
+     * @return void
      */
     protected function calculateCurrentPage(string $group)
     {

diff --git a/system/Pager/PagerRenderer.php b/system/Pager/PagerRenderer.php
@@ -289,6 +289,8 @@ public function links(): array
      * to show.
      *
      * @param int|null $count The new "surroundCount"
+     *
+     * @return void
      */
     protected function updatePages(?int $count = null)
     {

diff --git a/system/Publisher/Exceptions/PublisherException.php b/system/Publisher/Exceptions/PublisherException.php
@@ -25,6 +25,8 @@ class PublisherException extends FrameworkException
      *
      * @param string $from The source file
      * @param string $to   The destination file
+     *
+     * @return static
      */
     public static function forCollision(string $from, string $to)
     {
@@ -33,6 +35,8 @@ public static function forCollision(string $from, string $to)
 
     /**
      * Throws when given a destination that is not in the list of allowed directories.
+     *
+     * @return static
      */
     public static function forDestinationNotAllowed(string $destination)
     {
@@ -41,6 +45,8 @@ public static function forDestinationNotAllowed(string $destination)
 
     /**
      * Throws when a file fails to match the allowed pattern for its destination.
+     *
+     * @return static
      */
     public static function forFileNotAllowed(string $file, string $directory, string $pattern)
     {

diff --git a/system/Publisher/Publisher.php b/system/Publisher/Publisher.php
@@ -466,7 +466,7 @@ public function addLineBefore(string $file, string $line, string $before): bool
     /**
      * Verify this is an allowed file for its destination.
      */
-    private function verifyAllowed(string $from, string $to)
+    private function verifyAllowed(string $from, string $to): void
     {
         // Verify this is an allowed file for its destination
         foreach ($this->restrictions as $directory => $pattern) {

diff --git a/system/RESTful/BaseResource.php b/system/RESTful/BaseResource.php
@@ -39,6 +39,8 @@ abstract class BaseResource extends Controller
 
     /**
      * Constructor.
+     *
+     * @return void
      */
     public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
     {
@@ -52,6 +54,8 @@ public function initController(RequestInterface $request, ResponseInterface $res
      * Given either the name or the object, determine the other.
      *
      * @param object|string|null $which
+     *
+     * @return void
      */
     public function setModel($which = null)
     {