JGithubMilestones

class JGithubMilestones extends JGithubObject

GitHub API Milestones class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
array
getList( string $user, string $repo, string $state = 'open', string $sort = 'due_date', string $direction = 'desc', integer $page, integer $limit)

Method to get the list of milestones for a repo.

object
get( string $user, string $repo, integer $milestoneId)

Method to get a specific milestone.

object
create( string $user, string $repo, integer $title, string $state = null, string $description = null, string $due_on = null)

Method to create a milestone for a repository.

object
edit( string $user, string $repo, integer $milestoneId, integer $title = null, string $state = null, string $description = null, string $due_on = null)

Method to update a milestone.

void
delete( string $user, string $repo, integer $milestoneId)

Method to delete a milestone.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

array getList( string $user, string $repo, string $state = 'open', string $sort = 'due_date', string $direction = 'desc', integer $page, integer $limit)

Method to get the list of milestones for a repo.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $state The milestone state to retrieved. Open (default) or closed.
string $sort Sort can be due_date (default) or completeness.
string $direction Direction is asc or desc (default).
integer $page The page number from which to get items.
integer $limit The number of items on a page.

Return Value

array

object get( string $user, string $repo, integer $milestoneId)

Method to get a specific milestone.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $milestoneId The milestone id to get.

Return Value

object

object create( string $user, string $repo, integer $title, string $state = null, string $description = null, string $due_on = null)

Method to create a milestone for a repository.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $title The title of the milestone.
string $state Can be open (default) or closed.
string $description Optional description for milestone.
string $due_on Optional ISO 8601 time.

Return Value

object

object edit( string $user, string $repo, integer $milestoneId, integer $title = null, string $state = null, string $description = null, string $due_on = null)

Method to update a milestone.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $milestoneId The id of the comment to update.
integer $title Optional title of the milestone.
string $state Can be open (default) or closed.
string $description Optional description for milestone.
string $due_on Optional ISO 8601 time.

Return Value

object

void delete( string $user, string $repo, integer $milestoneId)

Method to delete a milestone.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $milestoneId The id of the milestone to delete.

Return Value

void