JGithubPackageUsersFollowers

Extends \JGithubPackage

GitHub API References class for the Joomla Platform.

deprecated
documentation

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

since

3.1.4

deprecated

4.0 Use the joomla/github package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

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

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubPackage
inherited
since

3.3

throws

\RuntimeException

Arguments

$name

stringName of property to retrieve

Response

\JGithubPackageGitHub API package object.

check

Check if you are following a user.

check(string $user) : boolean
throws

\UnexpectedValueException

since

3.3

Arguments

$user

stringThe name of the user.

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.7.3

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

3.3

Arguments

$user

stringThe name of the user.

Response

object

getList

List followers of a user.

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

3.3

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

3.3

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(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
inherited
throws

\DomainException

since

3.3.0

Arguments

$response

\JHttpResponseThe response.

$expectedCode

integerThe expected "good" code.

$decode

booleanIf the should be response be JSON decoded.

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

3.3

Arguments

$user

stringThe name of the user.

Response

object

Properties

name

inherited
since

3.3

Type(s)

string

packages

inherited
since

3.3

Type(s)

array

options

Options for the GitHub object.

inherited
since

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.7.3

Type(s)

\JGithubHttp