PHPDoc and static analysis fixes

GrahamCampbell · GrahamCampbell · commit 585f0fb90dfd · 2020-07-03T22:37:39.000+01:00
diff --git a/.gitattributes b/.gitattributes
@@ -6,6 +6,8 @@
 /.gitignore export-ignore
 /.styleci.yml export-ignore
 /.travis.yml export-ignore
+/phpstan-baseline.neon export-ignore
+/phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
 /README.md export-ignore
 /UPGRADE.md export-ignore
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
-vendor/
-composer.lock
-
 .idea
+/composer.lock
+/phpstan.neon
+/phpstan.phar
+/phpunit.xml
+/vendor
diff --git a/.travis.yml b/.travis.yml
@@ -10,14 +10,13 @@ php:
 
 matrix:
   include:
-    - php: 7.3
+    - php: 7.4
       env: STATIC_ANALYSIS=yes
+      script: then php phpstan.phar analyse
 
 before_script:
-  - travis_retry composer self-update
-  - travis_retry composer update --no-interaction ${COMPOSER_FLAGS}
-  - if [ "$STATIC_ANALYSIS" != "" ]; then curl -L https://github.com/phpstan/phpstan/releases/download/0.10.8/phpstan.phar -o phpstan.phar; fi;
+  - travis_retry composer update --no-interaction
+  - if [ "$STATIC_ANALYSIS" != "" ]; then curl -L https://github.com/phpstan/phpstan/releases/download/0.12.32/phpstan.phar -o phpstan.phar; fi;
 
 script:
   - vendor/bin/phpunit --verbose --coverage-text
-  - if [ "$STATIC_ANALYSIS" != "" ]; then php phpstan.phar analyse --level=4 lib; fi;
diff --git a/composer.json b/composer.json
@@ -42,5 +42,8 @@
 	},
 	"autoload-dev": {
 		"psr-4": { "Gitlab\\Tests\\": "test/Gitlab/Tests/" }
-	}
+	},
+    "config": {
+        "preferred-install": "dist"
+    }
 }
diff --git a/lib/Gitlab/Api/AbstractApi.php b/lib/Gitlab/Api/AbstractApi.php
@@ -173,7 +173,7 @@ protected function delete($path, array $parameters = array(), $requestHeaders =
     }
 
     /**
-     * @param int $id
+     * @param string|int $id
      * @param string $path
      * @return string
      */
@@ -193,12 +193,12 @@ protected function getGroupPath($id, $path)
     }
 
     /**
-     * @param string $path
+     * @param string|int $path
      * @return string
      */
     protected function encodePath($path)
     {
-        $path = rawurlencode($path);
+        $path = rawurlencode((string) $path);
 
         return str_replace('.', '%2E', $path);
     }
@@ -239,6 +239,11 @@ private function prepareBody(array $parameters = [])
         return $stream;
     }
 
+    /**
+     * @param string $path
+     * @param array $parameters
+     * @return string
+     */
     private function preparePath($path, array $parameters = [])
     {
         if (count($parameters) > 0) {
diff --git a/lib/Gitlab/Api/Groups.php b/lib/Gitlab/Api/Groups.php
@@ -1,6 +1,7 @@
 <?php namespace Gitlab\Api;
 
 use Symfony\Component\OptionsResolver\Options;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class Groups extends AbstractApi
 {
@@ -373,6 +374,9 @@ public function removeVariable($group_id, $key)
         return $this->delete($this->getGroupPath($group_id, 'variables/'.$this->encodePath($key)));
     }
 
+    /**
+     * @return OptionsResolver
+     */
     private function getGroupSearchResolver()
     {
         $resolver = $this->createOptionsResolver();
diff --git a/lib/Gitlab/Api/Issues.php b/lib/Gitlab/Api/Issues.php
@@ -26,6 +26,11 @@ public function all($project_id = null, array $parameters = [])
         return $this->get($path, $this->createOptionsResolver()->resolve($parameters));
     }
 
+    /**
+     * @param int $group_id
+     * @param array $parameters
+     * @return mixed
+     */
     public function group($group_id, array $parameters = [])
     {
         return $this->get(
diff --git a/lib/Gitlab/Api/IssuesStatistics.php b/lib/Gitlab/Api/IssuesStatistics.php
@@ -5,21 +5,38 @@
 
 class IssuesStatistics extends AbstractApi
 {
+    /**
+     * @param array $parameters
+     * @return mixed
+     */
     public function all($parameters)
     {
         return $this->get('issues_statistics', $this->createOptionsResolver()->resolve($parameters));
     }
 
+    /**
+     * @param int $project_id
+     * @param array $parameters
+     * @return mixed
+     */
     public function project($project_id, $parameters)
     {
         return $this->get($this->getProjectPath($project_id, 'issues_statistics'), $this->createOptionsResolver()->resolve($parameters));
     }
 
+    /**
+     * @param int $group_id
+     * @param array $parameters
+     * @return mixed
+     */
     public function group($group_id, $parameters)
     {
         return $this->get($this->getGroupPath($group_id, 'issues_statistics'), $this->createOptionsResolver()->resolve($parameters));
     }
 
+    /**
+     * @return OptionsResolver
+     */
     protected function createOptionsResolver()
     {
         $resolver = new OptionsResolver();
diff --git a/lib/Gitlab/Api/Projects.php b/lib/Gitlab/Api/Projects.php
@@ -361,7 +361,7 @@ public function addMember($project_id, $user_id, $access_level)
      */
     public function saveMember($project_id, $user_id, $access_level)
     {
-        return $this->put($this->getProjectPath($project_id, 'members/'.urldecode($user_id)), array(
+        return $this->put($this->getProjectPath($project_id, 'members/'.$this->encodePath($user_id)), array(
             'access_level' => $access_level
         ));
     }
@@ -373,7 +373,7 @@ public function saveMember($project_id, $user_id, $access_level)
      */
     public function removeMember($project_id, $user_id)
     {
-        return $this->delete($this->getProjectPath($project_id, 'members/'.urldecode($user_id)));
+        return $this->delete($this->getProjectPath($project_id, 'members/'.$this->encodePath($user_id)));
     }
 
     /**
@@ -884,7 +884,7 @@ public function badges($project_id)
 
     /**
      * @param int $project_id
-     * @param string $badge_id
+     * @param int $badge_id
      * @return mixed
      */
     public function badge($project_id, $badge_id)
@@ -904,7 +904,7 @@ public function addBadge($project_id, array $parameters = array())
 
     /**
      * @param int $project_id
-     * @param string $badge_id
+     * @param int $badge_id
      * @return mixed
      */
     public function removeBadge($project_id, $badge_id)
@@ -914,7 +914,7 @@ public function removeBadge($project_id, $badge_id)
 
     /**
      * @param int $project_id
-     * @param string $badge_id
+     * @param int $badge_id
      * @param array $parameters
      * @return mixed
     */
diff --git a/lib/Gitlab/Api/Repositories.php b/lib/Gitlab/Api/Repositories.php
@@ -27,12 +27,12 @@ public function branches($project_id, array $parameters = [])
 
     /**
      * @param int $project_id
-     * @param int $branch_id
+     * @param string $branch
      * @return mixed
      */
-    public function branch($project_id, $branch_id)
+    public function branch($project_id, $branch)
     {
-        return $this->get($this->getProjectPath($project_id, 'repository/branches/'.$this->encodePath($branch_id)));
+        return $this->get($this->getProjectPath($project_id, 'repository/branches/'.$this->encodePath($branch)));
     }
 
     /**
@@ -61,27 +61,27 @@ public function deleteBranch($project_id, $branch)
 
     /**
      * @param int $project_id
-     * @param string $branch_name
+     * @param string $branch
      * @param bool $devPush
      * @param bool $devMerge
      * @return mixed
      */
-    public function protectBranch($project_id, $branch_name, $devPush = false, $devMerge = false)
+    public function protectBranch($project_id, $branch, $devPush = false, $devMerge = false)
     {
-        return $this->put($this->getProjectPath($project_id, 'repository/branches/'.$this->encodePath($branch_name).'/protect'), array(
+        return $this->put($this->getProjectPath($project_id, 'repository/branches/'.$this->encodePath($branch).'/protect'), array(
             'developers_can_push' => $devPush,
             'developers_can_merge' => $devMerge
         ));
     }
 
     /**
      * @param int $project_id
-     * @param string $branch_name
+     * @param string $branch
      * @return mixed
      */
-    public function unprotectBranch($project_id, $branch_name)
+    public function unprotectBranch($project_id, $branch)
     {
-        return $this->put($this->getProjectPath($project_id, 'repository/branches/'.$this->encodePath($branch_name).'/unprotect'));
+        return $this->put($this->getProjectPath($project_id, 'repository/branches/'.$this->encodePath($branch).'/unprotect'));
     }
 
     /**
diff --git a/lib/Gitlab/Api/Users.php b/lib/Gitlab/Api/Users.php
@@ -280,7 +280,7 @@ public function userKeys($user_id)
         return $this->get('users/'.$this->encodePath($user_id).'/keys');
     }
 
-    /*
+    /**
      * @param int $user_id
      * @param int $key_id
      * @return mixed
diff --git a/lib/Gitlab/Api/Version.php b/lib/Gitlab/Api/Version.php
@@ -2,6 +2,9 @@
 
 class Version extends AbstractApi
 {
+	/**
+	 * @return mixed
+	 */
     public function show()
     {
         return $this->get('version');
diff --git a/lib/Gitlab/Api/Wiki.php b/lib/Gitlab/Api/Wiki.php
@@ -15,7 +15,7 @@ public function create($project_id, array $params)
 
     /**
      * @param int $project_id
-     * @param int $wiki_slug
+     * @param string $wiki_slug
      * @return mixed
      */
     public function show($project_id, $wiki_slug)
@@ -34,6 +34,7 @@ public function showAll($project_id)
 
     /**
      * @param int $project_id
+     * @param string $wiki_slug
      * @param array $params
      * @return mixed
      */
@@ -44,7 +45,7 @@ public function update($project_id, $wiki_slug, array $params)
 
     /**
      * @param int $project_id
-     * @param int $wiki_slug
+     * @param string $wiki_slug
      * @return mixed
      */
     public function remove($project_id, $wiki_slug)
diff --git a/lib/Gitlab/Client.php b/lib/Gitlab/Client.php
@@ -420,9 +420,9 @@ public function api($name)
     /**
      * Authenticate a user for all next requests
      *
-     * @param string $token Gitlab private token
-     * @param string $authMethod One of the AUTH_* class constants
-     * @param string $sudo
+     * @param string      $token Gitlab private token
+     * @param string      $authMethod One of the AUTH_* class constants
+     * @param string|null $sudo
      * @return $this
      */
     public function authenticate($token, $authMethod = self::AUTH_URL_TOKEN, $sudo = null)
diff --git a/lib/Gitlab/Exception/MissingArgumentException.php b/lib/Gitlab/Exception/MissingArgumentException.php
@@ -1,18 +1,25 @@
 <?php namespace Gitlab\Exception;
 
+use Exception;
+
 /**
  * MissingArgumentException
  *
  * @author Joseph Bielawski <stloyd@gmail.com>
  */
 class MissingArgumentException extends ErrorException implements ExceptionInterface
 {
+	/**
+	 * @param string|array $required
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
     public function __construct($required, $code = 0, $previous = null)
     {
         if (is_string($required)) {
             $required = array($required);
         }
 
-        parent::__construct(sprintf('One or more of required ("%s") parameters is missing!', implode('", "', $required)), $code, $previous);
+        parent::__construct(sprintf('One or more of required ("%s") parameters is missing!', implode('", "', $required)), $code, 1, __FILE__, __LINE__, $previous);
     }
 }
diff --git a/lib/Gitlab/HttpClient/Builder.php b/lib/Gitlab/HttpClient/Builder.php
@@ -10,7 +10,6 @@
 use Http\Discovery\HttpClientDiscovery;
 use Http\Discovery\MessageFactoryDiscovery;
 use Http\Discovery\StreamFactoryDiscovery;
-use Http\Message\MessageFactory;
 use Http\Message\RequestFactory;
 use Http\Message\StreamFactory;
 
@@ -37,7 +36,7 @@ class Builder
     private $pluginClient;
 
     /**
-     * @var MessageFactory
+     * @var RequestFactory
      */
     private $requestFactory;
 
@@ -94,6 +93,7 @@ public function getHttpClient()
      * Add a new plugin to the end of the plugin chain.
      *
      * @param Plugin $plugin
+     * @return void
      */
     public function addPlugin(Plugin $plugin)
     {
@@ -105,6 +105,7 @@ public function addPlugin(Plugin $plugin)
      * Remove a plugin by its fully qualified class name (FQCN).
      *
      * @param string $fqcn
+     * @return void
      */
     public function removePlugin($fqcn)
     {
diff --git a/lib/Gitlab/HttpClient/Plugin/ApiVersion.php b/lib/Gitlab/HttpClient/Plugin/ApiVersion.php
@@ -15,6 +15,9 @@ class ApiVersion implements Plugin
 {
     use Plugin\VersionBridgePlugin;
 
+    /**
+     * @var bool
+     */
     private $redirected = false;
 
     /**
diff --git a/lib/Gitlab/Model/Project.php b/lib/Gitlab/Model/Project.php
diff --git a/lib/Gitlab/Model/User.php b/lib/Gitlab/Model/User.php
diff --git a/lib/Gitlab/ResultPager.php b/lib/Gitlab/ResultPager.php
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/phpstan.neon.dist b/phpstan.neon.dist

Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ protected function delete($path, array $parameters = array(), $requestHeaders =`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`/**`
`176`		`- * @param int $id`
	`176`	`+ * @param string\|int $id`
`177`	`177`	`* @param string $path`
`178`	`178`	`* @return string`
`179`	`179`	`*/`
`@@ -193,12 +193,12 @@ protected function getGroupPath($id, $path)`
`193`	`193`	`}`
`194`	`194`
`195`	`195`	`/**`
`196`		`- * @param string $path`
	`196`	`+ * @param string\|int $path`
`197`	`197`	`* @return string`
`198`	`198`	`*/`
`199`	`199`	`protected function encodePath($path)`
`200`	`200`	`{`
`201`		`- $path = rawurlencode($path);`
	`201`	`+ $path = rawurlencode((string) $path);`
`202`	`202`
`203`	`203`	`return str_replace('.', '%2E', $path);`
`204`	`204`	`}`
`@@ -239,6 +239,11 @@ private function prepareBody(array $parameters = [])`
`239`	`239`	`return $stream;`
`240`	`240`	`}`
`241`	`241`
	`242`	`+ /**`
	`243`	`+ * @param string $path`
	`244`	`+ * @param array $parameters`
	`245`	`+ * @return string`
	`246`	`+ */`
`242`	`247`	`private function preparePath($path, array $parameters = [])`
`243`	`248`	`{`
`244`	`249`	`if (count($parameters) > 0) {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`<?php namespace Gitlab\Api;`
`2`	`2`
`3`	`3`	`use Symfony\Component\OptionsResolver\Options;`
	`4`	`+use Symfony\Component\OptionsResolver\OptionsResolver;`
`4`	`5`
`5`	`6`	`class Groups extends AbstractApi`
`6`	`7`	`{`
`@@ -373,6 +374,9 @@ public function removeVariable($group_id, $key)`
`373`	`374`	`return $this->delete($this->getGroupPath($group_id, 'variables/'.$this->encodePath($key)));`
`374`	`375`	`}`
`375`	`376`
	`377`	`+ /**`
	`378`	`+ * @return OptionsResolver`
	`379`	`+ */`
`376`	`380`	`private function getGroupSearchResolver()`
`377`	`381`	`{`
`378`	`382`	`$resolver = $this->createOptionsResolver();`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,11 @@ public function all($project_id = null, array $parameters = [])`
`26`	`26`	`return $this->get($path, $this->createOptionsResolver()->resolve($parameters));`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ /**`
	`30`	`+ * @param int $group_id`
	`31`	`+ * @param array $parameters`
	`32`	`+ * @return mixed`
	`33`	`+ */`
`29`	`34`	`public function group($group_id, array $parameters = [])`
`30`	`35`	`{`
`31`	`36`	`return $this->get(`
Original file line number	Diff line number	Diff line change
`@@ -5,21 +5,38 @@`
`5`	`5`
`6`	`6`	`class IssuesStatistics extends AbstractApi`
`7`	`7`	`{`
	`8`	`+ /**`
	`9`	`+ * @param array $parameters`
	`10`	`+ * @return mixed`
	`11`	`+ */`
`8`	`12`	`public function all($parameters)`
`9`	`13`	`{`
`10`	`14`	`return $this->get('issues_statistics', $this->createOptionsResolver()->resolve($parameters));`
`11`	`15`	`}`
`12`	`16`
	`17`	`+ /**`
	`18`	`+ * @param int $project_id`
	`19`	`+ * @param array $parameters`
	`20`	`+ * @return mixed`
	`21`	`+ */`
`13`	`22`	`public function project($project_id, $parameters)`
`14`	`23`	`{`
`15`	`24`	`return $this->get($this->getProjectPath($project_id, 'issues_statistics'), $this->createOptionsResolver()->resolve($parameters));`
`16`	`25`	`}`
`17`	`26`
	`27`	`+ /**`
	`28`	`+ * @param int $group_id`
	`29`	`+ * @param array $parameters`
	`30`	`+ * @return mixed`
	`31`	`+ */`
`18`	`32`	`public function group($group_id, $parameters)`
`19`	`33`	`{`
`20`	`34`	`return $this->get($this->getGroupPath($group_id, 'issues_statistics'), $this->createOptionsResolver()->resolve($parameters));`
`21`	`35`	`}`
`22`	`36`
	`37`	`+ /**`
	`38`	`+ * @return OptionsResolver`
	`39`	`+ */`
`23`	`40`	`protected function createOptionsResolver()`
`24`	`41`	`{`
`25`	`42`	`$resolver = new OptionsResolver();`