JGithubPackageOrgsMembers

Extends \JGithubPackage

GitHub API Orgs Members class for the Joomla Platform.

deprecated
documentation

https://developer.github.com/v3/orgs/members/

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

check(string $org, string $user) : boolean

Check if a user is, publicly or privately, a member of the organization.

throws

\UnexpectedValueException

since

3.3

Arguments

$org

stringThe name of the organization.

$user

stringThe name of the user.

Response

boolean

checkPublic

Check public membership.

checkPublic(string $org, string $user) : object
throws

\UnexpectedValueException

since

3.3

Arguments

$org

stringThe name of the organization.

$user

stringThe name of the user.

Response

object

conceal

Conceal a user’s membership.

conceal(string $org, string $user) : object
since

3.3

Arguments

$org

stringThe name of the organization.

$user

stringThe name of the user.

Response

object

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.

getList

Members list.

getList(string $org) : boolean|mixed

List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. If the requester is not a member of the organization the query will be redirected to the public members list.

throws

\UnexpectedValueException

since

3.3

Arguments

$org

stringThe name of the organization.

Response

boolean|mixed

getListPublic

Public members list.

getListPublic(string $org) : object

Members of an organization can choose to have their membership publicized or not.

since

3.3

Arguments

$org

stringThe name of the organization.

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

publicize

Publicize a user’s membership.

publicize(string $org, string $user) : object
since

3.3

Arguments

$org

stringThe name of the organization.

$user

stringThe name of the user.

Response

object

remove

Remove a member.

remove(string $org, string $user) : object

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization’s repositories.

since

3.3

Arguments

$org

stringThe name of the organization.

$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