JGithubPackageIssuesMilestones

Extends \JGithubPackage

GitHub API Milestones class for the Joomla Platform.

deprecated
documentation

https://developer.github.com/v3/issues/milestones/

since

3.1.4

deprecated

4.0 Use the joomla/github package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null) 
inherited
since

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubPackage
inherited
since

3.3

throws

\RuntimeException

Arguments

$name

stringName of property to retrieve

Response

\JGithubPackageGitHub API package object.

create

Method to create a milestone for a repository.

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

\DomainException

since

3.1.4

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$title

integerThe title of the milestone.

$state

stringCan be open (default) or closed.

$description

stringOptional description for milestone.

$due_on

stringOptional ISO 8601 time.

Response

object

delete

Method to delete a milestone.

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

\DomainException

since

3.1.4

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$milestoneId

integerThe id of the milestone to delete.

edit

Method to update a milestone.

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

\DomainException

since

3.1.4

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$milestoneId

integerThe id of the comment to update.

$title

integerOptional title of the milestone.

$state

stringCan be open (default) or closed.

$description

stringOptional description for milestone.

$due_on

stringOptional ISO 8601 time.

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, integer $page, integer $limit) : string
inherited
since

1.7.3

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

get

Method to get a specific milestone.

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

\DomainException

since

3.1.4

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$milestoneId

integerThe milestone id to get.

Response

object

getList

Method to get the list of milestones for a repo.

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

\DomainException

since

3.1.4

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

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

array

processResponse

Process the response and decode it.

processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
inherited
throws

\DomainException

since

3.3.0

Arguments

$response

\JHttpResponseThe response.

$expectedCode

integerThe expected "good" code.

$decode

booleanIf the should be response be JSON decoded.

Response

mixed

Properties

name

inherited
since

3.3

Type(s)

string

packages

inherited
since

3.3

Type(s)

array

options

Options for the GitHub object.

inherited
since

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.7.3

Type(s)

\JGithubHttp