JGithubPackageDataRefs

Extends \JGithubPackage

GitHub API References class for the Joomla Platform.

deprecated
documentation

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

since

1.7.3

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

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

\DomainException

since

1.7.3

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

3.3

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

Method to update a reference.

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

\DomainException

since

1.7.3

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

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

1.7.3

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

Method to list references for a repository.

getList(string $user, string $repo, string $namespace = '', integer $page, integer $limit) : array
since

1.7.3

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

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