JGithubPackageUsersKeys

class JGithubPackageUsersKeys extends JGithubPackage

GitHub API References class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
getListUser( string $user)

List public keys for a user.

object
getList()

List your public keys.

object
get( integer $id)

Get a single public key.

object
create( string $title, string $key)

Create a public key

object
edit( integer $id, string $title, string $key)

Update a public key.

object
delete( integer $id)

Delete a public key.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object getListUser( string $user)

List public keys for a user.

Lists the verified public keys for a user. This is accessible by anyone.

Parameters

string $user The name of the user.

Return Value

object

object getList()

List your public keys.

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.

Return Value

object

object get( integer $id)

Get a single public key.

Parameters

integer $id The id of the key.

Return Value

object

object create( string $title, string $key)

Create a public key

Parameters

string $title The title of the key.
string $key The key.

Return Value

object

object edit( integer $id, string $title, string $key)

Update a public key.

Parameters

integer $id The id of the key.
string $title The title of the key.
string $key The key.

Return Value

object

object delete( integer $id)

Delete a public key.

Parameters

integer $id The id of the key.

Return Value

object