Milestones
Extends AbstractPackageGitHub API Milestones class for the Joomla Framework.
link | |
---|---|
since |
1.0 |
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
GitHub options object.- client
\Joomla\Http\Http
The HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
since |
1.0 |
---|---|
throws |
|
Arguments
- name
string
Name of property to retrieve
Response
\Joomla\Github\AbstractPackage
GitHub API package object.
create
Create a milestone.
create(string user, string repo, int title, string state = null, string description = null, string dueOn = null) : object
note |
As of 2.0 the $dueOn parameter will be typehinted to a \DateTime object |
---|---|
since |
1.0 |
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- title
int
The title of the milestone.- state
string
Can be open (default) or closed.- description
string
Optional description for milestone.- dueOn
string
The milestone due date. This is a timestamp in ISO 8601 format.
Response
object
delete
Delete a milestone.
delete(string user, string repo, int milestoneId) : void
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- milestoneId
int
The id of the milestone to delete.
edit
Update a milestone.
edit(string user, string repo, int milestoneId, int title = null, string state = null, string description = null, string dueOn = null) : object
note |
As of 2.0 the $dueOn parameter will be typehinted to a \DateTime object |
---|---|
since |
1.0 |
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- milestoneId
int
The id of the comment to update.- title
int
Optional title of the milestone.- state
string
Can be open (default) or closed.- description
string
Optional description for milestone.- dueOn
string
The milestone due date. This is a timestamp in ISO 8601 format.
Response
object
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string path, int page, int limit) : \Joomla\Uri\Uri
since |
1.0 |
---|
Arguments
- path
string
URL to inflect- page
int
Page to request- limit
int
Number of results to return per page
Response
\Joomla\Uri\Uri
get
Get a single milestone.
get(string user, string repo, int milestoneId) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- milestoneId
int
The milestone id to get.
Response
object
getList
List milestones for a repository.
getList(string user, string repo, string state = 'open', string sort = 'due_date', string direction = 'desc', int page, int limit) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- state
string
The milestone state to retrieved. Open (default) or closed.- sort
string
Sort can be due_date (default) or completeness.- direction
string
Direction is asc or desc (default).- page
int
The page number from which to get items.- limit
int
The number of items on a page.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response.- expectedCode
int
The expected "good" code.
Response
mixed
Properties
options
Options for the GitHub object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Http\Http
package
The package the object resides in
since |
1.0 |
---|
Type(s)
string
hookEvents
Array containing the allowed hook events
since |
1.5.2 |
---|---|
link | |
note |
From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses |
Type(s)
array