Skip to content

Commit a6067be

Browse files
acrobatacrobat
committed
Merge branch '2.x'
* 2.x: minor #897 phpstan level 6 fixes (acrobat, GrahamCampbell) Added AUTH_ACCESS_TOKEN to allowed methods
2 parents 42f5bfb + cb4abc1 commit a6067be

14 files changed

+94
-12
lines changed

‎lib/Github/Api/AcceptHeaderTrait.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
*/
1010
trait AcceptHeaderTrait
1111
{
12+
/** @var string */
1213
protected $acceptHeaderValue;
1314

1415
protected function get($path, array $parameters = [], array $requestHeaders = [])

‎lib/Github/Client.php‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -333,14 +333,16 @@ public function api($name)
333333
* @param string|null $authMethod One of the AUTH_* class constants
334334
*
335335
* @throws InvalidArgumentException If no authentication method was given
336+
*
337+
* @return void
336338
*/
337339
public function authenticate($tokenOrLogin, $password = null, $authMethod = null)
338340
{
339341
if (null === $password && null === $authMethod) {
340342
throw new InvalidArgumentException('You need to specify authentication method!');
341343
}
342344

343-
if (null === $authMethod && in_array($password, [self::AUTH_URL_TOKEN, self::AUTH_URL_CLIENT_ID, self::AUTH_HTTP_PASSWORD, self::AUTH_HTTP_TOKEN, self::AUTH_JWT], true)) {
345+
if (null === $authMethod && in_array($password, [self::AUTH_URL_TOKEN, self::AUTH_URL_CLIENT_ID, self::AUTH_HTTP_PASSWORD, self::AUTH_HTTP_TOKEN, self::AUTH_ACCESS_TOKEN, self::AUTH_JWT], true)) {
344346
$authMethod = $password;
345347
$password = null;
346348
}
@@ -357,6 +359,8 @@ public function authenticate($tokenOrLogin, $password = null, $authMethod = null
357359
* Sets the URL of your GitHub Enterprise instance.
358360
*
359361
* @param string $enterpriseUrl URL of the API in the form of http(s)://hostname
362+
*
363+
* @return void
360364
*/
361365
private function setEnterpriseUrl($enterpriseUrl)
362366
{
@@ -381,6 +385,8 @@ public function getApiVersion()
381385
*
382386
* @param CacheItemPoolInterface $cachePool
383387
* @param array $config
388+
*
389+
* @return void
384390
*/
385391
public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
386392
{
@@ -389,6 +395,8 @@ public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
389395

390396
/**
391397
* Remove the cache plugin.
398+
*
399+
* @return void
392400
*/
393401
public function removeCache()
394402
{
@@ -397,8 +405,7 @@ public function removeCache()
397405

398406
/**
399407
* @param string $name
400-
*
401-
* @throws BadMethodCallException
408+
* @param array $args
402409
*
403410
* @return ApiInterface
404411
*/

‎lib/Github/Exception/ApiLimitExceedException.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,17 @@
99
*/
1010
class ApiLimitExceedException extends RuntimeException
1111
{
12+
/** @var int */
1213
private $limit;
14+
/** @var int */
1315
private $reset;
1416

17+
/**
18+
* @param int $limit
19+
* @param int $reset
20+
* @param int $code
21+
* @param \Throwable|null $previous
22+
*/
1523
public function __construct($limit = 5000, $reset = 1800, $code = 0, $previous = null)
1624
{
1725
$this->limit = (int) $limit;
@@ -20,11 +28,17 @@ public function __construct($limit = 5000, $reset = 1800, $code = 0, $previous =
2028
parent::__construct(sprintf('You have reached GitHub hourly limit! Actual limit is: %d', $limit), $code, $previous);
2129
}
2230

31+
/**
32+
* @return int
33+
*/
2334
public function getLimit()
2435
{
2536
return $this->limit;
2637
}
2738

39+
/**
40+
* @return int
41+
*/
2842
public function getResetTime()
2943
{
3044
return $this->reset;

‎lib/Github/Exception/MissingArgumentException.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
*/
1010
class MissingArgumentException extends ErrorException
1111
{
12+
/**
13+
* @param string|array $required
14+
* @param int $code
15+
* @param \Throwable|null $previous
16+
*/
1217
public function __construct($required, $code = 0, $previous = null)
1318
{
1419
if (is_string($required)) {

‎lib/Github/Exception/TwoFactorAuthenticationRequiredException.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,23 @@
44

55
class TwoFactorAuthenticationRequiredException extends RuntimeException
66
{
7+
/** @var string */
78
private $type;
89

10+
/**
11+
* @param string $type
12+
* @param int $code
13+
* @param \Throwable|null $previous
14+
*/
915
public function __construct($type, $code = 0, $previous = null)
1016
{
1117
$this->type = $type;
1218
parent::__construct('Two factor authentication is enabled on this account', $code, $previous);
1319
}
1420

21+
/**
22+
* @return string
23+
*/
1524
public function getType()
1625
{
1726
return $this->type;

‎lib/Github/HttpClient/Builder.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ public function getHttpClient()
113113
* Add a new plugin to the end of the plugin chain.
114114
*
115115
* @param Plugin $plugin
116+
*
117+
* @return void
116118
*/
117119
public function addPlugin(Plugin $plugin)
118120
{
@@ -124,6 +126,8 @@ public function addPlugin(Plugin $plugin)
124126
* Remove a plugin by its fully qualified class name (FQCN).
125127
*
126128
* @param string $fqcn
129+
*
130+
* @return void
127131
*/
128132
public function removePlugin($fqcn)
129133
{
@@ -137,6 +141,8 @@ public function removePlugin($fqcn)
137141

138142
/**
139143
* Clears used headers.
144+
*
145+
* @return void
140146
*/
141147
public function clearHeaders()
142148
{
@@ -148,6 +154,8 @@ public function clearHeaders()
148154

149155
/**
150156
* @param array $headers
157+
*
158+
* @return void
151159
*/
152160
public function addHeaders(array $headers)
153161
{
@@ -160,6 +168,8 @@ public function addHeaders(array $headers)
160168
/**
161169
* @param string $header
162170
* @param string $headerValue
171+
*
172+
* @return void
163173
*/
164174
public function addHeaderValue($header, $headerValue)
165175
{
@@ -178,6 +188,8 @@ public function addHeaderValue($header, $headerValue)
178188
*
179189
* @param CacheItemPoolInterface $cachePool
180190
* @param array $config
191+
*
192+
* @return void
181193
*/
182194
public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
183195
{
@@ -190,6 +202,8 @@ public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
190202

191203
/**
192204
* Remove the cache plugin.
205+
*
206+
* @return void
193207
*/
194208
public function removeCache()
195209
{

‎lib/Github/HttpClient/Message/ResponseMediator.php‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,19 @@ public static function getPagination(ResponseInterface $response)
5656
*/
5757
public static function getApiLimit(ResponseInterface $response)
5858
{
59-
$remainingCalls = self::getHeader($response, 'X-RateLimit-Remaining');
59+
$remainingCallsHeader = self::getHeader($response, 'X-RateLimit-Remaining');
6060

61-
if (null !== $remainingCalls && 1 > $remainingCalls) {
61+
if (null === $remainingCallsHeader) {
62+
return null;
63+
}
64+
65+
$remainingCalls = (int) $remainingCallsHeader;
66+
67+
if (1 > $remainingCalls) {
6268
throw new ApiLimitExceedException($remainingCalls);
6369
}
6470

65-
return $remainingCalls;
71+
return $remainingCallsHeader;
6672
}
6773

6874
/**

‎lib/Github/HttpClient/Plugin/Authentication.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function __construct($tokenOrLogin, $password, $method)
4343
}
4444

4545
/**
46-
* {@inheritdoc}
46+
* @return Promise
4747
*/
4848
public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
4949
{

‎lib/Github/HttpClient/Plugin/GithubExceptionThrower.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
class GithubExceptionThrower implements Plugin
2121
{
2222
/**
23-
* {@inheritdoc}
23+
* @return Promise
2424
*/
2525
public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
2626
{
@@ -32,8 +32,8 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
3232
// If error:
3333
$remaining = ResponseMediator::getHeader($response, 'X-RateLimit-Remaining');
3434
if (null !== $remaining && 1 > $remaining && 'rate_limit' !== substr($request->getRequestTarget(), 1, 10)) {
35-
$limit = ResponseMediator::getHeader($response, 'X-RateLimit-Limit');
36-
$reset = ResponseMediator::getHeader($response, 'X-RateLimit-Reset');
35+
$limit = (int) ResponseMediator::getHeader($response, 'X-RateLimit-Limit');
36+
$reset = (int) ResponseMediator::getHeader($response, 'X-RateLimit-Reset');
3737

3838
throw new ApiLimitExceedException($limit, $reset);
3939
}

‎lib/Github/HttpClient/Plugin/History.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ public function getLastResponse()
2727
return $this->lastResponse;
2828
}
2929

30+
/**
31+
* @return void
32+
*/
3033
public function addSuccess(RequestInterface $request, ResponseInterface $response)
3134
{
3235
$this->lastResponse = $response;

0 commit comments

Comments
 (0)