Keys
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) : mixed
| since |
1.0 |
|---|
Arguments
- options
\Joomla\Registry\RegistryGitHub options object.- client
\Joomla\Http\HttpThe HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
\Joomla\Github\AbstractPackageGitHub API package object.
create
Create a public key
create(string title, string key) : object
| since |
1.0 |
|---|
Arguments
- title
stringThe title of the key.- key
stringThe key.
Response
object
delete
Delete a public key.
delete(int id) : object
| since |
1.0 |
|---|
Arguments
- id
intThe id of the key.
Response
object
edit
Update a public key.
edit(int id, string title, string key) : object
| since |
1.0 |
|---|
Arguments
- id
intThe id of the key.- title
stringThe title of the key.- key
stringThe key.
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, int page, int 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
\Joomla\Uri\Uri
get
Get a single public key.
get(int id) : object
| since |
1.0 |
|---|
Arguments
- id
intThe id of the key.
Response
object
getList
List your public keys.
getList() : object
Lists the current user’s keys. Management of public keys via the API requires that you are authenticated through basic auth, or OAuth with the ‘user’ scope.
| since |
1.0 |
|---|
Response
object
getListUser
List public keys for a user.
getListUser(string user) : object
Lists the verified public keys for a user. This is accessible by anyone.
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the user.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
\Joomla\Http\ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
Properties
options
Options for the GitHub object.
| since |
1.0 |
|---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
| since |
1.0 |
|---|
Type(s)
\Joomla\Http\Http
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