Milestones

Extends AbstractPackage

GitHub 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
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0

throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub 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

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

title

intThe title of the milestone.

state

stringCan be open (default) or closed.

description

stringOptional description for milestone.

dueOn

stringThe 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

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

milestoneId

intThe 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

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

milestoneId

intThe id of the comment to update.

title

intOptional title of the milestone.

state

stringCan be open (default) or closed.

description

stringOptional description for milestone.

dueOn

stringThe 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
inherited
since

1.0

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber 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

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

milestoneId

intThe 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

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

state

stringThe milestone state to retrieved. Open (default) or closed.

sort

stringSort can be due_date (default) or completeness.

direction

stringDirection is asc or desc (default).

page

intThe page number from which to get items.

limit

intThe number of items on a page.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
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