Skip to content

Updated comments documentation #114

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

Merged
merged 1 commit into from
Jan 31, 2014
+51 −4
Merged

Updated comments documentation #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 51 additions & 4 deletions doc/issue/comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,24 @@ Wraps [GitHub Issue Comments API](http://developer.github.com/v3/issues/comments
$comments = $client->api('issue')->comments()->all('KnpLabs', 'php-github-api', 4);
```

List an issue comments by username, repo and issue number.
Returns an array of issues.
* `KnpLabs` : the owner of the repository
* `php-github-api` : the name of the repository
* `4` : the id of the issue
* You can select another page of comments using one more parameter (default: 1)

Returns an array of comments.


### Show an issue comment

```php
$comment = $client->api('issue')->comments()->show('KnpLabs', 'php-github-api', 33793831);
```

* `KnpLabs` : the owner of the repository
* `php-github-api` : the name of the repository
* `33793831` : the id of the comment


### Add a comment on an issue

Expand All @@ -23,5 +39,36 @@ Returns an array of issues.
$client->api('issue')->comments()->create('KnpLabs', 'php-github-api', 4, array('body' => 'My new comment'));
```

Add a comment to the issue by username, repo and issue number and array with comment data: `body`
and optionally `title`.
* `KnpLabs` : the owner of the repository
* `php-github-api` : the name of the repository
* `4` : the id of the issue
* You can set a `body` and optionally a `title`


### Update a comment on an issue

> **Note:**

> Requires [authentication](../security.md).

```php
$client->api('issue')->comments()->create('KnpLabs', 'php-github-api', 33793831, array('body' => 'My updated comment'));
```

* `KnpLabs` : the owner of the repository
* `php-github-api` : the name of the repository
* `33793831` : the id of the comment

### Remove a comment on an issue

> **Note:**

> Requires [authentication](../security.md).

```php
$client->api('issue')->comments()->remove('KnpLabs', 'php-github-api', 33793831);
```

* `KnpLabs` : the owner of the repository
* `php-github-api` : the name of the repository
* `33793831` : the id of the comment