JGithubPackageActivityStarring

class JGithubPackageActivityStarring extends JGithubPackage

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

List Stargazers.

object
getRepositories( string $user = '')

List repositories being starred.

object
check( string $owner, string $repo)

Check if you are starring a repository.

object
star( string $owner, string $repo)

Star a repository.

object
unstar( string $owner, string $repo)

Unstar a repository.

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

mixed getList( string $owner, string $repo)

List Stargazers.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

mixed

object getRepositories( string $user = '')

List repositories being starred.

List repositories being starred by a user.

Parameters

string $user User name.

Return Value

object

object check( string $owner, string $repo)

Check if you are starring a repository.

Requires for the user to be authenticated.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

object

Exceptions

UnexpectedValueException

object star( string $owner, string $repo)

Star a repository.

Requires for the user to be authenticated.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

object

object unstar( string $owner, string $repo)

Unstar a repository.

Requires for the user to be authenticated.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

object