JGithubPackageUsersKeys
Extends \JGithubPackageGitHub API References class for the Joomla Platform.
| documentation | |
|---|---|
| since |
3.1.4 |
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
| 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
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $name
stringName of property to retrieve
Response
\JGithubPackageGitHub API package object.
create
Create a public key
create(string $title, string $key) : object
| since |
3.3 |
|---|
Arguments
- $title
stringThe title of the key.- $key
stringThe key.
Response
object
delete
Delete a public key.
delete(integer $id) : object
| since |
3.3 |
|---|
Arguments
- $id
integerThe id of the key.
Response
object
edit
Update a public key.
edit(integer $id, string $title, string $key) : object
| since |
3.3 |
|---|
Arguments
- $id
integerThe 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, integer $page, integer $limit) : string
| 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
Get a single public key.
get(integer $id) : object
| since |
3.3 |
|---|
Arguments
- $id
integerThe 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 |
3.3 |
|---|
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 |
3.3 |
|---|
Arguments
- $user
stringThe name of the user.
Response
object
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
| throws |
|
|---|---|
| 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
| since |
3.3 |
|---|
Type(s)
string
packages
| since |
3.3 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.