Skip to content

Commit e047c8f

Browse files
committed
Update documentation
1 parent 4bae5d7 commit e047c8f

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,16 @@ For the v3 client, [rate limiting data](https://www.yelp.com/developers/document
7373
```php
7474
// $latestRateLimit will be null if an http request hasn't been successfully completed.
7575
$latestRateLimit = $client->getRateLimit();
76+
7677
// The maximum number of calls you can make per day
7778
$latestDailyLimit = $latestRateLimit->dailyLimit;
79+
7880
// The number of calls remaining within the current day
7981
$latestRemaining = $latestRateLimit->remaining;
82+
8083
// The time at which the current rate limiting window will expire as an ISO 8601 timestamp
8184
$latestResetTime = $latestRateLimit->resetTime;
85+
8286
// The time at which the current rate limiting data was observed as an ISO 8601 timestamp
8387
$latestCreatedAt = $latestRateLimit->createdAt;
8488
```

src/v3/Client.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,8 @@ protected function getDefaultHeaders()
192192
* the most recent HTTP request to the Yelp v3 service.
193193
*
194194
* @return RateLimit|null
195+
*
196+
* @see https://www.yelp.com/developers/documentation/v3/rate_limiting
195197
*/
196198
public function getRateLimit()
197199
{

0 commit comments

Comments
 (0)