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

Improve to can specify parameters on issue comments api. #815

Merged
merged 3 commits into from Nov 1, 2019
Merged

Improve to can specify parameters on issue comments api. #815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1824da1
Improve to can specify properties on issue comments api.
Oct 4, 2019
1048364
fix typo.
Oct 8, 2019
6b2f88d
Add message which tell deprecated.
Oct 17, 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
21 changes: 14 additions & 7 deletions lib/Github/Api/Issue/Comments.php
View file
Open in desktop
Expand Up @@ -41,18 +41,25 @@ public function configure($bodyType = null)
*
* @link https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
*
* @param string $username
* @param string $repository
* @param int $issue
* @param int $page
* @param string $username
* @param string $repository
* @param int $issue
* @param int|array $page Passing integer is deprecated and will throw an exception in php-github-api version 3.0. Pass an array instead.
*
* @return array
*/
public function all($username, $repository, $issue, $page = 1)
{
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/'.rawurlencode($issue).'/comments', [
'page' => $page,
]);
if (is_array($page)) {
$parameters = $page;
} else {
@trigger_error(sprintf('Passing integer to the "page" argument in "%s" is deprecated and will throw an exception in php-github-api version 3.0. Pass an array instead.', __METHOD__), E_USER_DEPRECATED);
$parameters = [
t-kuni marked this conversation as resolved.
Show resolved Hide resolved
'page' => $page,
];
}

return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/'.rawurlencode($issue).'/comments', $parameters);
}

/**
Expand Down
18 changes: 18 additions & 0 deletions test/Github/Tests/Api/Issue/CommentsTest.php
View file
Open in desktop
Expand Up @@ -22,6 +22,24 @@ public function shouldGetAllIssueComments()
$this->assertEquals($expectedValue, $api->all('KnpLabs', 'php-github-api', 123));
}

/**
* @test
*/
public function shouldGetAllIssueCommentsBySpecifyParameters()
{
$expectedValue = [['comment1data'], ['comment2data']];

$api = $this->getApiMock();
$api->expects($this->once())
->method('get')
->with('/repos/KnpLabs/php-github-api/issues/123/comments', ['since' => '1990-08-03T00:00:00Z'])
->will($this->returnValue($expectedValue));

$this->assertEquals($expectedValue, $api->all('KnpLabs', 'php-github-api', 123, [
'since' => '1990-08-03T00:00:00Z',
]));
}

/**
* @test
*/
Expand Down