Skip to content

Commit 7e2d2f3

Browse files
Flyingmanaacrobat
authored andcommitted
Update rate_limits.md to reflect actual implementation (#808)
* Update rate_limits.md * Update rate_limits.md
1 parent 157bd55 commit 7e2d2f3

File tree

1 file changed

+60
-1
lines changed

1 file changed

+60
-1
lines changed

doc/rate_limits.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,68 @@ Get rate limit wrappers from [GitHub Rate Limit API](http://developer.github.com
55

66
#### Get All Rate Limits
77

8+
##### new way
89
```php
910
/** @var \Github\Api\RateLimit\RateLimitResource[] $rateLimits */
10-
$rateLimits = $client->api('rate_limit')->getLimits();
11+
$rateLimits = $client->api('rate_limit')->getResources();
12+
```
13+
14+
var_dump() output:
15+
```
16+
array(4) {
17+
["core"]=>
18+
object(Github\Api\RateLimit\RateLimitResource)#30 (4) {
19+
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
20+
string(4) "core"
21+
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
22+
int(5000)
23+
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
24+
int(1566137712)
25+
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
26+
int(5000)
27+
}
28+
["search"]=>
29+
object(Github\Api\RateLimit\RateLimitResource)#32 (4) {
30+
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
31+
string(6) "search"
32+
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
33+
int(30)
34+
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
35+
int(1566134172)
36+
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
37+
int(30)
38+
}
39+
["graphql"]=>
40+
object(Github\Api\RateLimit\RateLimitResource)#43 (4) {
41+
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
42+
string(7) "graphql"
43+
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
44+
int(5000)
45+
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
46+
int(1566137712)
47+
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
48+
int(5000)
49+
}
50+
["integration_manifest"]=>
51+
object(Github\Api\RateLimit\RateLimitResource)#44 (4) {
52+
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
53+
string(20) "integration_manifest"
54+
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
55+
int(5000)
56+
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
57+
int(1566137712)
58+
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
59+
int(5000)
60+
}
61+
}
62+
```
63+
64+
65+
##### deprecated way
66+
67+
```php
68+
/** @var array $rateLimits */
69+
$rateLimits = $client->api('rate_limit')->getRateLimits();
1170
```
1271

1372
#### Get Core Rate Limit

0 commit comments

Comments
 (0)