JGithubPackageOrgsMembers

class JGithubPackageOrgsMembers extends JGithubPackage

GitHub API Orgs Members 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
boolean|mixed
getList( string $org)

Members list.

boolean
check( string $org, string $user)

Check membership.

object
remove( string $org, string $user)

Remove a member.

object
getListPublic( string $org)

Public members list.

object
checkPublic( string $org, string $user)

Check public membership.

object
publicize( string $org, string $user)

Publicize a user’s membership.

object
conceal( string $org, string $user)

Conceal a user’s membership.

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

boolean|mixed getList( string $org)

Members list.

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.

Parameters

string $org The name of the organization.

Return Value

boolean|mixed

Exceptions

UnexpectedValueException

boolean check( string $org, string $user)

Check membership.

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

Parameters

string $org The name of the organization.
string $user The name of the user.

Return Value

boolean

Exceptions

UnexpectedValueException

object remove( string $org, string $user)

Remove a member.

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.

Parameters

string $org The name of the organization.
string $user The name of the user.

Return Value

object

object getListPublic( string $org)

Public members list.

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

Parameters

string $org The name of the organization.

Return Value

object

object checkPublic( string $org, string $user)

Check public membership.

Parameters

string $org The name of the organization.
string $user The name of the user.

Return Value

object

Exceptions

UnexpectedValueException

object publicize( string $org, string $user)

Publicize a user’s membership.

Parameters

string $org The name of the organization.
string $user The name of the user.

Return Value

object

object conceal( string $org, string $user)

Conceal a user’s membership.

Parameters

string $org The name of the organization.
string $user The name of the user.

Return Value

object