Skip to content

Commit 39cafe4

Browse files
cursedcodercursedcoder
authored
Merge pull request KnpLabs#452 from Nyholm/patch-5
Fixed comments and type hints
2 parents 7089069 + 164bf78 commit 39cafe4

File tree

3 files changed

+30
-22
lines changed

3 files changed

+30
-22
lines changed

‎lib/Github/Api/AbstractApi.php

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public function setPerPage($perPage)
6565
*
6666
* @return array|string
6767
*/
68-
protected function get($path, array $parameters = array(), $requestHeaders = array())
68+
protected function get($path, array $parameters = array(), array $requestHeaders = array())
6969
{
7070
if (null !== $this->perPage && !isset($parameters['per_page'])) {
7171
$parameters['per_page'] = $this->perPage;
@@ -92,7 +92,7 @@ protected function get($path, array $parameters = array(), $requestHeaders = arr
9292
*
9393
* @return \Psr\Http\Message\ResponseInterface
9494
*/
95-
protected function head($path, array $parameters = array(), $requestHeaders = array())
95+
protected function head($path, array $parameters = array(), array $requestHeaders = array())
9696
{
9797
if (array_key_exists('ref', $parameters) && is_null($parameters['ref'])) {
9898
unset($parameters['ref']);
@@ -109,8 +109,10 @@ protected function head($path, array $parameters = array(), $requestHeaders = ar
109109
* @param string $path Request path.
110110
* @param array $parameters POST parameters to be JSON encoded.
111111
* @param array $requestHeaders Request headers.
112+
*
113+
* @return array|string
112114
*/
113-
protected function post($path, array $parameters = array(), $requestHeaders = array())
115+
protected function post($path, array $parameters = array(), array $requestHeaders = array())
114116
{
115117
return $this->postRaw(
116118
$path,
@@ -128,7 +130,7 @@ protected function post($path, array $parameters = array(), $requestHeaders = ar
128130
*
129131
* @return array|string
130132
*/
131-
protected function postRaw($path, $body, $requestHeaders = array())
133+
protected function postRaw($path, $body, array $requestHeaders = array())
132134
{
133135
$response = $this->client->getHttpClient()->post(
134136
$path,
@@ -145,8 +147,10 @@ protected function postRaw($path, $body, $requestHeaders = array())
145147
* @param string $path Request path.
146148
* @param array $parameters POST parameters to be JSON encoded.
147149
* @param array $requestHeaders Request headers.
150+
*
151+
* @return array|string
148152
*/
149-
protected function patch($path, array $parameters = array(), $requestHeaders = array())
153+
protected function patch($path, array $parameters = array(), array $requestHeaders = array())
150154
{
151155
$response = $this->client->getHttpClient()->patch(
152156
$path,
@@ -163,8 +167,10 @@ protected function patch($path, array $parameters = array(), $requestHeaders = a
163167
* @param string $path Request path.
164168
* @param array $parameters POST parameters to be JSON encoded.
165169
* @param array $requestHeaders Request headers.
170+
*
171+
* @return array|string
166172
*/
167-
protected function put($path, array $parameters = array(), $requestHeaders = array())
173+
protected function put($path, array $parameters = array(), array $requestHeaders = array())
168174
{
169175
$response = $this->client->getHttpClient()->put(
170176
$path,
@@ -181,8 +187,10 @@ protected function put($path, array $parameters = array(), $requestHeaders = arr
181187
* @param string $path Request path.
182188
* @param array $parameters POST parameters to be JSON encoded.
183189
* @param array $requestHeaders Request headers.
190+
*
191+
* @return array|string
184192
*/
185-
protected function delete($path, array $parameters = array(), $requestHeaders = array())
193+
protected function delete($path, array $parameters = array(), array $requestHeaders = array())
186194
{
187195
$response = $this->client->getHttpClient()->delete(
188196
$path,

‎lib/Github/Api/AcceptHeaderTrait.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,37 @@ trait AcceptHeaderTrait
1111
{
1212
protected $acceptHeaderValue = null;
1313

14-
protected function get($path, array $parameters = array(), $requestHeaders = array())
14+
protected function get($path, array $parameters = array(), array $requestHeaders = array())
1515
{
1616
return parent::get($path, $parameters, $this->mergeHeaders($requestHeaders));
1717
}
1818

19-
protected function head($path, array $parameters = array(), $requestHeaders = array())
19+
protected function head($path, array $parameters = array(), array $requestHeaders = array())
2020
{
2121
return parent::head($path, $parameters, $this->mergeHeaders($requestHeaders));
2222
}
2323

24-
protected function post($path, array $parameters = array(), $requestHeaders = array())
24+
protected function post($path, array $parameters = array(), array $requestHeaders = array())
2525
{
2626
return parent::post($path, $parameters, $this->mergeHeaders($requestHeaders));
2727
}
2828

29-
protected function postRaw($path, $body, $requestHeaders = array())
29+
protected function postRaw($path, $body, array $requestHeaders = array())
3030
{
3131
return parent::postRaw($path, $body, $this->mergeHeaders($requestHeaders));
3232
}
3333

34-
protected function patch($path, array $parameters = array(), $requestHeaders = array())
34+
protected function patch($path, array $parameters = array(), array $requestHeaders = array())
3535
{
3636
return parent::patch($path, $parameters, $this->mergeHeaders($requestHeaders));
3737
}
3838

39-
protected function put($path, array $parameters = array(), $requestHeaders = array())
39+
protected function put($path, array $parameters = array(), array $requestHeaders = array())
4040
{
4141
return parent::put($path, $parameters, $this->mergeHeaders($requestHeaders));
4242
}
4343

44-
protected function delete($path, array $parameters = array(), $requestHeaders = array())
44+
protected function delete($path, array $parameters = array(), array $requestHeaders = array())
4545
{
4646
return parent::delete($path, $parameters, $this->mergeHeaders($requestHeaders));
4747
}

‎test/Github/Tests/Api/AbstractApiTest.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public function shouldPassGETRequestToClient()
2626
$client->expects($this->any())
2727
->method('getHttpClient')
2828
->willReturn($httpClient);
29-
29+
3030
$api = $this->getAbstractApiObject($client);
3131

3232
$this->assertEquals($expectedArray, $api->get('/path', array('param1' => 'param1value'), array('header1' => 'header1value')));
@@ -229,47 +229,47 @@ class AbstractApiTestInstance extends AbstractApi
229229
/**
230230
* {@inheritDoc}
231231
*/
232-
public function get($path, array $parameters = array(), $requestHeaders = array())
232+
public function get($path, array $parameters = array(), array $requestHeaders = array())
233233
{
234234
return parent::get($path, $parameters, $requestHeaders);
235235
}
236236

237237
/**
238238
* {@inheritDoc}
239239
*/
240-
public function post($path, array $parameters = array(), $requestHeaders = array())
240+
public function post($path, array $parameters = array(), array $requestHeaders = array())
241241
{
242242
return parent::post($path, $parameters, $requestHeaders);
243243
}
244244

245245
/**
246246
* {@inheritDoc}
247247
*/
248-
public function postRaw($path, $body, $requestHeaders = array())
248+
public function postRaw($path, $body, array $requestHeaders = array())
249249
{
250250
return parent::postRaw($path, $body, $requestHeaders);
251251
}
252252

253253
/**
254254
* {@inheritDoc}
255255
*/
256-
public function patch($path, array $parameters = array(), $requestHeaders = array())
256+
public function patch($path, array $parameters = array(), array $requestHeaders = array())
257257
{
258258
return parent::patch($path, $parameters, $requestHeaders);
259259
}
260260

261261
/**
262262
* {@inheritDoc}
263263
*/
264-
public function put($path, array $parameters = array(), $requestHeaders = array())
264+
public function put($path, array $parameters = array(), array $requestHeaders = array())
265265
{
266266
return parent::put($path, $parameters, $requestHeaders);
267267
}
268268

269269
/**
270270
* {@inheritDoc}
271271
*/
272-
public function delete($path, array $parameters = array(), $requestHeaders = array())
272+
public function delete($path, array $parameters = array(), array $requestHeaders = array())
273273
{
274274
return parent::delete($path, $parameters, $requestHeaders);
275275
}
@@ -283,7 +283,7 @@ class ExposedAbstractApiTestInstance extends AbstractApi
283283
/**
284284
* {@inheritDoc}
285285
*/
286-
public function get($path, array $parameters = array(), $requestHeaders = array())
286+
public function get($path, array $parameters = array(), array $requestHeaders = array())
287287
{
288288
return parent::get($path, $parameters, $requestHeaders);
289289
}

0 commit comments

Comments
 (0)