Class JGithubMilestones
GitHub API Milestones class for the Joomla Platform.
-
JGithubObject
-
JGithubMilestones
Methods summary
public
array
|
#
getList( string $user, string $repo, string $state = 'open', string $sort = 'due_date', string $direction = 'desc', integer $page = 0, integer $limit = 0 )
Method to get the list of milestones for a repo.
Method to get the list of milestones for a repo.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $state
string - $state The milestone state to retrieved. Open (default) or closed.- $sort
string - $sort Sort can be due_date (default) or completeness.- $direction
string - $direction Direction is asc or desc (default).- $page
integer - $page The page number from which to get items.- $limit
integer - $limit The number of items on a page. Returns
array
Since
12.3
|
public
object
|
#
get( string $user, string $repo, integer $milestoneId )
Method to get a specific milestone.
Method to get a specific milestone.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $milestoneId
integer - $milestoneId The milestone id to get. Returns
object
Since
12.3
|
public
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.
Method to create a milestone for a repository.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $title
integer - $title The title of the milestone.- $state
string - $state Can be open (default) or closed.- $description
string - $description Optional description for milestone.- $due_on
string - $due_on Optional ISO 8601 time. Returns
object
Since
12.3
|
public
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.
Method to update a milestone.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $milestoneId
integer - $milestoneId The id of the comment to update.- $title
integer - $title Optional title of the milestone.- $state
string - $state Can be open (default) or closed.- $description
string - $description Optional description for milestone.- $due_on
string - $due_on Optional ISO 8601 time. Returns
object
Since
12.3
|
public
|
#
delete( string $user, string $repo, integer $milestoneId )
Method to delete a milestone.
Method to delete a milestone.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $milestoneId
integer - $milestoneId The id of the milestone to delete. Since
12.3
|
__construct(),
fetchUrl(),
processResponse()
Magic methods summary
Properties summary
$client,
$options
