Skip to content

Add support for retrieving a single notification info using his ID #489

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 11 commits into from
Dec 20, 2016
Merged

Add support for retrieving a single notification info using his ID #489

Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f546d50
Add support for retrieving a single notification info using his ID
m1guelpf Dec 19, 2016
146316b
Syntax
m1guelpf Dec 19, 2016
d1e6e3d
StyleCI
m1guelpf Dec 19, 2016
66f04ec
Apply fixes from StyleCI
m1guelpf Dec 19, 2016
19661c5
Merge pull request #1 from m1guelpf/analysis-8Q06Rm
m1guelpf Dec 19, 2016
322a53f
Fix input type
m1guelpf Dec 19, 2016
ef8794c
Fix as said
m1guelpf Dec 20, 2016
e7ca7b9
Apply fixes from StyleCI
m1guelpf Dec 20, 2016
c648e9f
Merge pull request #2 from m1guelpf/analysis-XanBNZ
m1guelpf Dec 20, 2016
68d4a42
Remove undocumented
m1guelpf Dec 20, 2016
7288434
Add documentation
m1guelpf Dec 20, 2016
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
15 changes: 15 additions & 0 deletions lib/Github/Api/Notification.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,19 @@ public function markRead(DateTime $since = null)

$this->put('/notifications', $parameters);
}
/**
* [UNDOCUMENTED] Gets a single notification using his ID
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why "UNDOCUMENTED"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't in this library documentation

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to remove "[UNDOCUMENTED]" and add some documentation instead =)

*
* @link https://developer.github.com/v3/activity/notifications/#view-a-single-thread
*
* @param ID|integer $id
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be @param int $id

*/
public function id($id)
{
if (!is_numeric($id)) {
// Error
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do I do here?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's okey if you remove this if statement. If someone uses a string they will get a 404 back.

}

return $this->get('/notifications/threads/'.$id);
}
}