Refs
Extends AbstractPackageGitHub API References 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) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
create
Create a Reference.
create( user, repo, ref, sha) :
| since |
1.0 |
|---|---|
| throws |
|
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( owner, repo, ref) :
| 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( user, repo, ref, sha, force = false) :
| since |
1.0 |
|---|---|
| throws |
|
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
boolWhether 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( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
get
Get a Reference.
get( user, repo, ref) :
| since |
1.0 |
|---|---|
| throws |
|
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( user, repo, namespace = '', page, limit) :
| since |
1.0 |
|---|---|
| throws |
|
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
intPage to request- limit
intNumber of results to return per page
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
Properties
package
The package the object resides in
| since |
1.0 |
|---|
Type(s)
string
hookEvents
Array containing the allowed hook events
| 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<string|int, mixed>