JGithubPackageUsersFollowers

class JGithubPackageUsersFollowers 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
getList( string $user = '')

List followers of a user.

object
getListFollowedBy( string $user = '')

List users followed by another user.

boolean
check( string $user)

Check if you are following a user.

object
follow( string $user)

Follow a user.

object
unfollow( string $user)

Unfollow a user.

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 $user = '')

List followers of a user.

Parameters

string $user The name of the user. If not set the current authenticated user will be used.

Return Value

object

object getListFollowedBy( string $user = '')

List users followed by another user.

Parameters

string $user The name of the user. If not set the current authenticated user will be used.

Return Value

object

boolean check( string $user)

Check if you are following a user.

Parameters

string $user The name of the user.

Return Value

boolean

Exceptions

UnexpectedValueException

object follow( string $user)

Follow a user.

Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

Parameters

string $user The name of the user.

Return Value

object

object unfollow( string $user)

Unfollow a user.

Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

Parameters

string $user The name of the user.

Return Value

object