Merge pull request #763 from acrobat/add-missing-parameter-types

acrobat · web-flow · commit c842fcc89a38 · 2018-12-18T18:59:44.000+01:00
Add missing parameter types
diff --git a/lib/Github/Api/Authorizations.php b/lib/Github/Api/Authorizations.php
@@ -24,7 +24,7 @@ public function all()
     /**
      * Show a single authorization.
      *
-     * @param $clientId
+     * @param string $clientId
      *
      * @return array
      */
@@ -51,8 +51,8 @@ public function create(array $params, $OTPCode = null)
     /**
      * Update an authorization.
      *
-     * @param $clientId
-     * @param array $params
+     * @param string $clientId
+     * @param array  $params
      *
      * @return array
      */
@@ -64,7 +64,7 @@ public function update($clientId, array $params)
     /**
      * Remove an authorization.
      *
-     * @param $clientId
+     * @param string $clientId
      *
      * @return array
      */
@@ -76,8 +76,8 @@ public function remove($clientId)
     /**
      * Check an authorization.
      *
-     * @param $clientId
-     * @param $token
+     * @param string $clientId
+     * @param string $token
      *
      * @return array
      */
@@ -89,8 +89,8 @@ public function check($clientId, $token)
     /**
      * Reset an authorization.
      *
-     * @param $clientId
-     * @param $token
+     * @param string $clientId
+     * @param string $token
      *
      * @return array
      */
@@ -102,8 +102,8 @@ public function reset($clientId, $token)
     /**
      * Remove an authorization.
      *
-     * @param $clientId
-     * @param $token
+     * @param string $clientId
+     * @param string $token
      */
     public function revoke($clientId, $token)
     {
@@ -113,7 +113,7 @@ public function revoke($clientId, $token)
     /**
      * Revoke all authorizations.
      *
-     * @param $clientId
+     * @param string $clientId
      */
     public function revokeAll($clientId)
     {
diff --git a/lib/Github/Api/Issue/Events.php b/lib/Github/Api/Issue/Events.php
@@ -41,9 +41,9 @@ public function all($username, $repository, $issue = null, $page = 1)
      *
      * @link https://developer.github.com/v3/issues/events/#get-a-single-event
      *
-     * @param $username
-     * @param $repository
-     * @param $event
+     * @param string $username
+     * @param string $repository
+     * @param string $event
      *
      * @return array
      */
diff --git a/lib/Github/Api/Organization.php b/lib/Github/Api/Organization.php
@@ -91,9 +91,9 @@ public function teams()
     /**
      * @link http://developer.github.com/v3/issues/#list-issues
      *
-     * @param $organization
-     * @param array $params
-     * @param int   $page
+     * @param string $organization
+     * @param array  $params
+     * @param int    $page
      *
      * @return array
      */
diff --git a/lib/Github/Api/PullRequest/Comments.php b/lib/Github/Api/PullRequest/Comments.php
@@ -21,7 +21,7 @@ class Comments extends AbstractApi
      * @link https://developer.github.com/v3/pulls/comments/#custom-media-types
      *
      * @param string|null $bodyType
-     * @param string|null @apiVersion
+     * @param string|null $apiVersion
      *
      * @return self
      */
diff --git a/lib/Github/Api/Repository/Collaborators.php b/lib/Github/Api/Repository/Collaborators.php
@@ -14,9 +14,9 @@ class Collaborators extends AbstractApi
     /**
      * @link https://developer.github.com/v3/repos/collaborators/#list-collaborators
      *
-     * @param $username
-     * @param $repository
-     * @param array $params
+     * @param string $username
+     * @param string $repository
+     * @param array  $params
      *
      * @return array|string
      */
@@ -28,9 +28,9 @@ public function all($username, $repository, array $params = [])
     /**
      * @link https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator
      *
-     * @param $username
-     * @param $repository
-     * @param $collaborator
+     * @param string $username
+     * @param string $repository
+     * @param string $collaborator
      *
      * @return array|string
      */
@@ -42,10 +42,10 @@ public function check($username, $repository, $collaborator)
     /**
      * @link https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator
      *
-     * @param $username
-     * @param $repository
-     * @param $collaborator
-     * @param array $params
+     * @param string $username
+     * @param string $repository
+     * @param string $collaborator
+     * @param array  $params
      *
      * @return array|string
      */
@@ -57,9 +57,9 @@ public function add($username, $repository, $collaborator, array $params = [])
     /**
      * @link https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator
      *
-     * @param $username
-     * @param $repository
-     * @param $collaborator
+     * @param string $username
+     * @param string $repository
+     * @param string $collaborator
      *
      * @return array|string
      */
@@ -71,9 +71,9 @@ public function remove($username, $repository, $collaborator)
     /**
      * @link https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level
      *
-     * @param $username
-     * @param $repository
-     * @param $collaborator
+     * @param string $username
+     * @param string $repository
+     * @param string $collaborator
      *
      * @return array|string
      */
diff --git a/lib/Github/Api/Repository/Releases.php b/lib/Github/Api/Repository/Releases.php
@@ -16,8 +16,8 @@ class Releases extends AbstractApi
     /**
      * Get the latest release.
      *
-     * @param $username
-     * @param $repository
+     * @param string $username
+     * @param string $repository
      *
      * @return array
      */
@@ -29,9 +29,9 @@ public function latest($username, $repository)
     /**
      * List releases for a tag.
      *
-     * @param $username
-     * @param $repository
-     * @param $tag
+     * @param string $username
+     * @param string $repository
+     * @param string $tag
      *
      * @return array
      */
diff --git a/lib/Github/Client.php b/lib/Github/Client.php
@@ -361,7 +361,7 @@ public function getApiVersion()
     /**
      * Add a cache plugin to cache responses locally.
      *
-     * @param CacheItemPoolInterface $cache
+     * @param CacheItemPoolInterface $cachePool
      * @param array                  $config
      */
     public function addCache(CacheItemPoolInterface $cachePool, array $config = [])

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function all()`
`24`	`24`	`/**`
`25`	`25`	`* Show a single authorization.`
`26`	`26`	`*`
`27`		`- * @param $clientId`
	`27`	`+ * @param string $clientId`
`28`	`28`	`*`
`29`	`29`	`* @return array`
`30`	`30`	`*/`
`@@ -51,8 +51,8 @@ public function create(array $params, $OTPCode = null)`
`51`	`51`	`/**`
`52`	`52`	`* Update an authorization.`
`53`	`53`	`*`
`54`		`- * @param $clientId`
`55`		`- * @param array $params`
	`54`	`+ * @param string $clientId`
	`55`	`+ * @param array $params`
`56`	`56`	`*`
`57`	`57`	`* @return array`
`58`	`58`	`*/`
`@@ -64,7 +64,7 @@ public function update($clientId, array $params)`
`64`	`64`	`/**`
`65`	`65`	`* Remove an authorization.`
`66`	`66`	`*`
`67`		`- * @param $clientId`
	`67`	`+ * @param string $clientId`
`68`	`68`	`*`
`69`	`69`	`* @return array`
`70`	`70`	`*/`
`@@ -76,8 +76,8 @@ public function remove($clientId)`
`76`	`76`	`/**`
`77`	`77`	`* Check an authorization.`
`78`	`78`	`*`
`79`		`- * @param $clientId`
`80`		`- * @param $token`
	`79`	`+ * @param string $clientId`
	`80`	`+ * @param string $token`
`81`	`81`	`*`
`82`	`82`	`* @return array`
`83`	`83`	`*/`
`@@ -89,8 +89,8 @@ public function check($clientId, $token)`
`89`	`89`	`/**`
`90`	`90`	`* Reset an authorization.`
`91`	`91`	`*`
`92`		`- * @param $clientId`
`93`		`- * @param $token`
	`92`	`+ * @param string $clientId`
	`93`	`+ * @param string $token`
`94`	`94`	`*`
`95`	`95`	`* @return array`
`96`	`96`	`*/`
`@@ -102,8 +102,8 @@ public function reset($clientId, $token)`
`102`	`102`	`/**`
`103`	`103`	`* Remove an authorization.`
`104`	`104`	`*`
`105`		`- * @param $clientId`
`106`		`- * @param $token`
	`105`	`+ * @param string $clientId`
	`106`	`+ * @param string $token`
`107`	`107`	`*/`
`108`	`108`	`public function revoke($clientId, $token)`
`109`	`109`	`{`
`@@ -113,7 +113,7 @@ public function revoke($clientId, $token)`
`113`	`113`	`/**`
`114`	`114`	`* Revoke all authorizations.`
`115`	`115`	`*`
`116`		`- * @param $clientId`
	`116`	`+ * @param string $clientId`
`117`	`117`	`*/`
`118`	`118`	`public function revokeAll($clientId)`
`119`	`119`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,9 +41,9 @@ public function all($username, $repository, $issue = null, $page = 1)`
`41`	`41`	`*`
`42`	`42`	`* @link https://developer.github.com/v3/issues/events/#get-a-single-event`
`43`	`43`	`*`
`44`		`- * @param $username`
`45`		`- * @param $repository`
`46`		`- * @param $event`
	`44`	`+ * @param string $username`
	`45`	`+ * @param string $repository`
	`46`	`+ * @param string $event`
`47`	`47`	`*`
`48`	`48`	`* @return array`
`49`	`49`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -91,9 +91,9 @@ public function teams()`
`91`	`91`	`/**`
`92`	`92`	`* @link http://developer.github.com/v3/issues/#list-issues`
`93`	`93`	`*`
`94`		`- * @param $organization`
`95`		`- * @param array $params`
`96`		`- * @param int $page`
	`94`	`+ * @param string $organization`
	`95`	`+ * @param array $params`
	`96`	`+ * @param int $page`
`97`	`97`	`*`
`98`	`98`	`* @return array`
`99`	`99`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class Comments extends AbstractApi`
`21`	`21`	`* @link https://developer.github.com/v3/pulls/comments/#custom-media-types`
`22`	`22`	`*`
`23`	`23`	`* @param string\|null $bodyType`
`24`		`- * @param string\|null @apiVersion`
	`24`	`+ * @param string\|null $apiVersion`
`25`	`25`	`*`
`26`	`26`	`* @return self`
`27`	`27`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ class Releases extends AbstractApi`
`16`	`16`	`/**`
`17`	`17`	`* Get the latest release.`
`18`	`18`	`*`
`19`		`- * @param $username`
`20`		`- * @param $repository`
	`19`	`+ * @param string $username`
	`20`	`+ * @param string $repository`
`21`	`21`	`*`
`22`	`22`	`* @return array`
`23`	`23`	`*/`
`@@ -29,9 +29,9 @@ public function latest($username, $repository)`
`29`	`29`	`/**`
`30`	`30`	`* List releases for a tag.`
`31`	`31`	`*`
`32`		`- * @param $username`
`33`		`- * @param $repository`
`34`		`- * @param $tag`
	`32`	`+ * @param string $username`
	`33`	`+ * @param string $repository`
	`34`	`+ * @param string $tag`
`35`	`35`	`*`
`36`	`36`	`* @return array`
`37`	`37`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -361,7 +361,7 @@ public function getApiVersion()`
`361`	`361`	`/**`
`362`	`362`	`* Add a cache plugin to cache responses locally.`
`363`	`363`	`*`
`364`		`- * @param CacheItemPoolInterface $cache`
	`364`	`+ * @param CacheItemPoolInterface $cachePool`
`365`	`365`	`* @param array $config`
`366`	`366`	`*/`
`367`	`367`	`public function addCache(CacheItemPoolInterface $cachePool, array $config = [])`