Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update rate_limits.md to reflect actual implementation #808

Merged
merged 2 commits into from Nov 1, 2019
Merged

Update rate_limits.md to reflect actual implementation #808

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d75b44b
Update rate_limits.md
Flyingmana Aug 18, 2019
a96fb18
Update rate_limits.md
Flyingmana Aug 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 60 additions & 1 deletion doc/rate_limits.md
View file
Open in desktop
Expand Up @@ -5,9 +5,68 @@ Get rate limit wrappers from [GitHub Rate Limit API](http://developer.github.com

#### Get All Rate Limits

##### new way
```php
/** @var \Github\Api\RateLimit\RateLimitResource[] $rateLimits */
$rateLimits = $client->api('rate_limit')->getLimits();
$rateLimits = $client->api('rate_limit')->getResources();
```

var_dump() output:
```
array(4) {
["core"]=>
object(Github\Api\RateLimit\RateLimitResource)#30 (4) {
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
string(4) "core"
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
int(5000)
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
int(1566137712)
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
int(5000)
}
["search"]=>
object(Github\Api\RateLimit\RateLimitResource)#32 (4) {
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
string(6) "search"
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
int(30)
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
int(1566134172)
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
int(30)
}
["graphql"]=>
object(Github\Api\RateLimit\RateLimitResource)#43 (4) {
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
string(7) "graphql"
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
int(5000)
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
int(1566137712)
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
int(5000)
}
["integration_manifest"]=>
object(Github\Api\RateLimit\RateLimitResource)#44 (4) {
["name":"Github\Api\RateLimit\RateLimitResource":private]=>
string(20) "integration_manifest"
["limit":"Github\Api\RateLimit\RateLimitResource":private]=>
int(5000)
["reset":"Github\Api\RateLimit\RateLimitResource":private]=>
int(1566137712)
["remaining":"Github\Api\RateLimit\RateLimitResource":private]=>
int(5000)
}
}
```


##### deprecated way

```php
/** @var array $rateLimits */
$rateLimits = $client->api('rate_limit')->getRateLimits();
```

#### Get Core Rate Limit
Expand Down