Skip to content

Commit

Permalink
Merge pull request #45 from caseysoftware/iterator-docs
Browse files Browse the repository at this point in the history
Updated the comments to reflect the flexibility of the parameters in addition to providing some examples.
  • Loading branch information
Kevin Burke committed Mar 2, 2012
2 parents 543b613 + 4858a2a commit 8163f29
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions Services/Twilio/ListResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,24 @@ public function getSchema()
);
}

/**
* Returns an iterable list of InstanceResources
*
* @param int $page The start page
* @param int $size Number of items per page
* @param array $size Optional filters
*
* The filter array can accept full datetimes when StartTime or DateCreated
* are used. Inequalities should be within the key portion of the array and
* multiple filter parameters can be combined for more specific searches.
*
* eg.
* array('DateCreated>' => '2011-07-05 08:00:00', 'DateCreated<' => '2011-08-01')
* or
* array('StartTime<' => '2011-07-05 08:00:00')
*
* @return Services_Twilio_AutoPagingIterator An iterator
*/
public function getIterator($page = 0, $size = 50, array $filters = array())
{
return new Services_Twilio_AutoPagingIterator(
Expand Down

0 comments on commit 8163f29

Please sign in to comment.