Skip to content

Commit

Permalink
minor #843 further detail on ResultPager parameters (sepiariver)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.13.x-dev branch.

Discussion
----------

What changed?

Documentation file result_pager.md

Why?

Previously it was non-obvious how parameters were passed to called methods. Making it more obvious enables users to implement ResultPager with greater ease and confidence.

Commits
-------

05cdb4d further detail on ResultPager parameters
  • Loading branch information
acrobat authored Apr 19, 2020
2 parents 4f388bc + 05cdb4d commit 67794ac
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/result_pager.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ Parameters of the `fetchAll` method:
* The method of the API object you're using
* The parameters of the method

Parameters are passed to the API method via [call_user_func_array](https://www.php.net/manual/en/function.call-user-func-array.php).

```php
$parameters = array('github', 'all', 1); // $organization, $type, $page
```

#### Get the first page

```php
Expand Down

0 comments on commit 67794ac

Please sign in to comment.