Followers

Extends \Joomla\Github\AbstractPackage

GitHub API Followers class for the Joomla Framework.

link

https://developer.github.com/v3/users/followers

since

1.0

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \Joomla\Http\Http $client = null) 
inherited
since

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \Joomla\Github\AbstractPackage
inherited
since

1.0

throws

\InvalidArgumentException

Arguments

$name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

check

Check if you are following a user.

check(string $user) : boolean
since

1.0

throws

\UnexpectedValueException

Arguments

$user

stringThe name of the user.

Response

boolean

checkUserFollowing

Check if one user follows another.

checkUserFollowing(string $user, string $target) : boolean
since

1.4.0

throws

\UnexpectedValueException

Arguments

$user

stringThe name of the user.

$target

stringThe name of the user to check is being followed.

Response

boolean

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
inherited
since

1.0

note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

follow

Follow a user.

follow(string $user) : object

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

since

1.0

Arguments

$user

stringThe name of the user.

Response

object

getList

List followers of a user.

getList(string $user = '') : object
since

1.0

Arguments

$user

stringThe name of the user. If not set the current authenticated user will be used.

Response

object

getListFollowedBy

List users followed by another user.

getListFollowedBy(string $user = '') : object
since

1.0

Arguments

$user

stringThe name of the user. If not set the current authenticated user will be used.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response $response, integer $expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe expected "good" code.

Response

mixed

unfollow

Unfollow a user.

unfollow(string $user) : object

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

since

1.0

Arguments

$user

stringThe name of the user.

Response

object

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Github\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2

link

https://developer.github.com/webhooks/#events

note

From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array