139 lines
4.1 KiB
PHP
139 lines
4.1 KiB
PHP
<?php
|
|
|
|
namespace Github\Api\Issue;
|
|
|
|
use Github\Api\AbstractApi;
|
|
use Github\Exception\MissingArgumentException;
|
|
|
|
/**
|
|
* @link http://developer.github.com/v3/issues/milestones/
|
|
*
|
|
* @author Joseph Bielawski <stloyd@gmail.com>
|
|
*/
|
|
class Milestones extends AbstractApi
|
|
{
|
|
/**
|
|
* Get all milestones for a repository.
|
|
*
|
|
* @link https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
*
|
|
* @param string $username
|
|
* @param string $repository
|
|
* @param array $params
|
|
*
|
|
* @return array
|
|
*/
|
|
public function all($username, $repository, array $params = [])
|
|
{
|
|
if (isset($params['state']) && !in_array($params['state'], ['open', 'closed', 'all'])) {
|
|
$params['state'] = 'open';
|
|
}
|
|
if (isset($params['sort']) && !in_array($params['sort'], ['due_date', 'completeness'])) {
|
|
$params['sort'] = 'due_date';
|
|
}
|
|
if (isset($params['direction']) && !in_array($params['direction'], ['asc', 'desc'])) {
|
|
$params['direction'] = 'asc';
|
|
}
|
|
|
|
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones', array_merge([
|
|
'page' => 1,
|
|
'state' => 'open',
|
|
'sort' => 'due_date',
|
|
'direction' => 'asc',
|
|
], $params));
|
|
}
|
|
|
|
/**
|
|
* Get a milestone for a repository.
|
|
*
|
|
* @link https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
|
|
*
|
|
* @param string $username
|
|
* @param string $repository
|
|
* @param int $id
|
|
*
|
|
* @return array
|
|
*/
|
|
public function show($username, $repository, $id)
|
|
{
|
|
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.$id);
|
|
}
|
|
|
|
/**
|
|
* Create a milestone for a repository.
|
|
*
|
|
* @link https://developer.github.com/v3/issues/milestones/#create-a-milestone
|
|
*
|
|
* @param string $username
|
|
* @param string $repository
|
|
* @param array $params
|
|
*
|
|
* @throws \Github\Exception\MissingArgumentException
|
|
*
|
|
* @return array
|
|
*/
|
|
public function create($username, $repository, array $params)
|
|
{
|
|
if (!isset($params['title'])) {
|
|
throw new MissingArgumentException('title');
|
|
}
|
|
if (isset($params['state']) && !in_array($params['state'], ['open', 'closed'])) {
|
|
$params['state'] = 'open';
|
|
}
|
|
|
|
return $this->post('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones', $params);
|
|
}
|
|
|
|
/**
|
|
* Update a milestone for a repository.
|
|
*
|
|
* @link https://developer.github.com/v3/issues/milestones/#update-a-milestone
|
|
*
|
|
* @param string $username
|
|
* @param string $repository
|
|
* @param int $id
|
|
* @param array $params
|
|
*
|
|
* @return array
|
|
*/
|
|
public function update($username, $repository, $id, array $params)
|
|
{
|
|
if (isset($params['state']) && !in_array($params['state'], ['open', 'closed'])) {
|
|
$params['state'] = 'open';
|
|
}
|
|
|
|
return $this->patch('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.$id, $params);
|
|
}
|
|
|
|
/**
|
|
* Delete a milestone for a repository.
|
|
*
|
|
* @link https://developer.github.com/v3/issues/milestones/#delete-a-milestone
|
|
*
|
|
* @param string $username
|
|
* @param string $repository
|
|
* @param int $id
|
|
*
|
|
* @return array|string
|
|
*/
|
|
public function remove($username, $repository, $id)
|
|
{
|
|
return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.$id);
|
|
}
|
|
|
|
/**
|
|
* Get the labels of a milestone.
|
|
*
|
|
* @link https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
|
|
*
|
|
* @param string $username
|
|
* @param string $repository
|
|
* @param int $id
|
|
*
|
|
* @return array
|
|
*/
|
|
public function labels($username, $repository, $id)
|
|
{
|
|
return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/milestones/'.$id.'/labels');
|
|
}
|
|
}
|