Skip to content

Commit 3c816c4

Browse files
committed
Updated doc blocks
1 parent 013dd0e commit 3c816c4

File tree

3 files changed

+19
-4
lines changed

3 files changed

+19
-4
lines changed

lib/Github/Api/AbstractApi.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function setPerPage($perPage)
6363
* @param array $parameters GET parameters.
6464
* @param array $requestHeaders Request Headers.
6565
*
66-
* @return \Guzzle\Http\EntityBodyInterface|mixed|string
66+
* @return array|string
6767
*/
6868
protected function get($path, array $parameters = array(), $requestHeaders = array())
6969
{
@@ -90,7 +90,7 @@ protected function get($path, array $parameters = array(), $requestHeaders = arr
9090
* @param array $parameters HEAD parameters.
9191
* @param array $requestHeaders Request headers.
9292
*
93-
* @return \Guzzle\Http\Message\Response
93+
* @return \Psr\Http\Message\ResponseInterface
9494
*/
9595
protected function head($path, array $parameters = array(), $requestHeaders = array())
9696
{
@@ -126,7 +126,7 @@ protected function post($path, array $parameters = array(), $requestHeaders = ar
126126
* @param string $body Request body.
127127
* @param array $requestHeaders Request headers.
128128
*
129-
* @return \Guzzle\Http\EntityBodyInterface|mixed|string
129+
* @return array|string
130130
*/
131131
protected function postRaw($path, $body, $requestHeaders = array())
132132
{

lib/Github/Api/Enterprise/ManagementConsole.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public function keys($hash)
6868
* @param string $uri the request URI
6969
* @param string $hash md5 hash of your license
7070
*
71-
* @return \Guzzle\Http\EntityBodyInterface|mixed|string
71+
* @return array|string
7272
*/
7373
protected function getWithLicenseHash($uri, $hash)
7474
{

lib/Github/HttpClient/Message/ResponseMediator.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77

88
class ResponseMediator
99
{
10+
/**
11+
* @param ResponseInterface $response
12+
*
13+
* @return array|string
14+
*/
1015
public static function getContent(ResponseInterface $response)
1116
{
1217
$body = $response->getBody()->__toString();
@@ -20,6 +25,11 @@ public static function getContent(ResponseInterface $response)
2025
return $body;
2126
}
2227

28+
/**
29+
* @param ResponseInterface $response
30+
*
31+
* @return array|null
32+
*/
2333
public static function getPagination(ResponseInterface $response)
2434
{
2535
if (!$response->hasHeader('Link')) {
@@ -39,6 +49,11 @@ public static function getPagination(ResponseInterface $response)
3949
return $pagination;
4050
}
4151

52+
/**
53+
* @param ResponseInterface $response
54+
*
55+
* @return null|string
56+
*/
4257
public static function getApiLimit(ResponseInterface $response)
4358
{
4459
$remainingCalls = self::getHeader($response, 'X-RateLimit-Remaining');

0 commit comments

Comments
 (0)