* @author Tobias Nyholm */ class Comments extends AbstractApi { use AcceptHeaderTrait; /** * Configure the body type. * * @link https://developer.github.com/v3/issues/comments/#custom-media-types * * @param string|null $bodyType * * @return $this */ public function configure($bodyType = null) { if (!in_array($bodyType, ['raw', 'text', 'html'])) { $bodyType = 'full'; } $this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $this->getApiVersion(), $bodyType); return $this; } /** * Get all comments for an issue. * * @link https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue * * @param string $username * @param string $repository * @param int $issue * @param array $params * * @return array */ public function all($username, $repository, $issue, array $params = []) { return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/'.$issue.'/comments', $params); } /** * Get a comment for an issue. * * @link https://developer.github.com/v3/issues/comments/#get-a-single-comment * * @param string $username * @param string $repository * @param int $comment * * @return array */ public function show($username, $repository, $comment) { return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/comments/'.$comment); } /** * Create a comment for an issue. * * @link https://developer.github.com/v3/issues/comments/#create-a-comment * * @param string $username * @param string $repository * @param int $issue * @param array $params * * @throws \Github\Exception\MissingArgumentException * * @return array */ public function create($username, $repository, $issue, array $params) { if (!isset($params['body'])) { throw new MissingArgumentException('body'); } return $this->post('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/'.$issue.'/comments', $params); } /** * Update a comment for an issue. * * @link https://developer.github.com/v3/issues/comments/#edit-a-comment * * @param string $username * @param string $repository * @param int $comment * @param array $params * * @throws \Github\Exception\MissingArgumentException * * @return array */ public function update($username, $repository, $comment, array $params) { if (!isset($params['body'])) { throw new MissingArgumentException('body'); } return $this->patch('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/comments/'.$comment, $params); } /** * Delete a comment for an issue. * * @link https://developer.github.com/v3/issues/comments/#delete-a-comment * * @param string $username * @param string $repository * @param int $comment * * @return array */ public function remove($username, $repository, $comment) { return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/comments/'.$comment); } }