Refs

Extends \Joomla\Github\AbstractPackage

GitHub API References class for the Joomla Framework.

link

https://developer.github.com/v3/git/refs/

since

1.0

Methods

__construct

Constructor.

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

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

__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 Reference.

create(string $user, string $repo, string $ref, string $sha) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$ref

stringThe name of the fully qualified reference.

$sha

stringThe SHA1 value to set this reference to.

Response

object

delete

Delete a Reference

delete(string $owner, string $repo, string $ref) : object
since

1.0

Arguments

$owner

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$ref

stringThe reference to update.

Response

object

edit

Update a Reference.

edit(string $user, string $repo, string $ref, string $sha, boolean $force = false) : object
since

1.0

throws

\Joomla\Github\Package\Data\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$ref

stringThe reference to update.

$sha

stringThe SHA1 value to set the reference to.

$force

booleanWhether the update should be forced. Default to false.

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.0

note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

get

Get a Reference.

get(string $user, string $repo, string $ref) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$ref

stringThe reference to get.

Response

object

getList

Get all References.

getList(string $user, string $repo, string $namespace = '', integer $page, integer $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.

$namespace

stringOptional sub-namespace to limit the returned references.

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

object

processResponse

Process the response and decode it.

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

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe 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\Github\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

https://developer.github.com/webhooks/#events

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