JGithubPackageRepositoriesKeys

class JGithubPackageRepositoriesKeys extends JGithubPackage

GitHub API Forks 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
getList( string $owner, string $repo)

List keys in a repository.

object
get( string $owner, string $repo, integer $id)

Get a key.

object
create( string $owner, string $repo, string $title, string $key)

Create a key.

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

Edit a key.

boolean
delete( string $owner, string $repo, integer $id)

Delete a 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 getList( string $owner, string $repo)

List keys in a repository.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.

Return Value

object

object get( string $owner, string $repo, integer $id)

Get a key.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $id The id of the key.

Return Value

object

object create( string $owner, string $repo, string $title, string $key)

Create a key.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $title The key title.
string $key The key.

Return Value

object

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

Edit a key.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $id The id of the key.
string $title The key title.
string $key The key.

Return Value

object

boolean delete( string $owner, string $repo, integer $id)

Delete a key.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $id The id of the key.

Return Value

boolean