Docs For Class JGithubMilestones

Description

GitHub API Milestones class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/github/milestones.php (line 19)

JGithubObject
   |
   --JGithubMilestones

Method Summary

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

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

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

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

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

Variables

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
JGithubObject::$options

Methods

create (line 103)

Method to create a milestone for a repository.

since: 12.3
access: public

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

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.

delete (line 214)

Method to delete a milestone.

since: 12.3
access: public

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

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.

edit (line 159)

Method to update a milestone.

since: 12.3
access: public

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

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.

get (line 70)

Method to get a specific milestone.

since: 12.3
access: public

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

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.

getList (line 36)

Method to get the list of milestones for a repo.

since: 12.3
access: public

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

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.

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()