Référence de la classe JGithubPackageDataRefs

Graphe d'héritage de JGithubPackageDataRefs:

Fonctions membres publiques
	get ($user, $repo, $ref)
	getList ($user, $repo, $namespace='', $page=0, $limit=0)
	create ($user, $repo, $ref, $sha)
	edit ($user, $repo, $ref, $sha, $force=false)
	delete ($owner, $repo, $ref)
Fonctions membres publiques hérités de JGithubPackage
	__get ($name)
Fonctions membres publiques hérités de JGithubObject
	__construct (Registry $options=null, JGithubHttp $client=null)

Membres hérités additionnels
Fonctions membres protégées hérités de JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
Attributs protégés hérités de JGithubPackage
	$name = ''
	$packages = array()
Attributs protégés hérités de JGithubObject
	$options
	$client

Description détaillée

GitHub API References class for the Joomla Platform.

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

Depuis

1.7.3

Obsolète:

4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

create()

create	(		$user,
			$repo,
			$ref,
			$sha
	)

Method to create a ref.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$ref	The name of the fully qualified reference.
string	$sha	The SHA1 value to set this reference to.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

object

Références $data, $path, $user, et json_encode.

delete()

delete	(		$owner,
			$repo,
			$ref
	)

Delete a Reference

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$ref	The reference to update.

Depuis

3.3 (CMS)

Renvoie

object

Références $path.

edit()

edit	(		$user,
			$repo,
			$ref,
			$sha,
			$force = false
	)

Method to update a reference.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$ref	The reference to update.
string	$sha	The SHA1 value to set the reference to.
boolean	$force	Whether the update should be forced. Default to false.

Exceptions

DomainException

Depuis

1.7.3

Renvoie

object

Références $data, $path, $user, et json_encode.

get()

get	(		$user,
			$repo,
			$ref
	)

Method to get a reference.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$ref	The reference to get.

Renvoie

object

Depuis

1.7.3

Références $path, et $user.

getList()

getList	(		$user,
			$repo,
			$namespace = '',
			$page = 0,
			$limit = 0
	)

Method to list references for a repository.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$namespace	Optional sub-namespace to limit the returned references.
integer	$page	Page to request
integer	$limit	Number of results to return per page

Renvoie

array

Depuis

1.7.3

Références $limit, $path, et $user.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• package/data/refs.php