JGithubPackageOrgsTeams

Extends \JGithubPackage

GitHub API Orgs Teams class for the Joomla Platform.

deprecated

All actions against teams require at a minimum an authenticated user who is a member of the owner’s team in the :org being managed. Additionally, OAuth users require “user” scope.

documentation

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

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.

addMember

Add team member.

addMember(integer $id, string $user) : object

In order to add a user to a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with.

since

3.3

Arguments

$id

integerThe team id.

$user

stringThe name of the user.

Response

object

addRepo

Add team repo.

addRepo(integer $id, string $owner, string $repo) : object

In order to add a repo to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repo must be owned by the organization, or a direct form of a repo owned by the organization.

If you attempt to add a repo to a team that is not owned by the organization, you get: Status: 422 Unprocessable Entity

since

3.3

Arguments

$id

integerThe team id.

$owner

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

Response

object

checkRepo

Check if the repo is managed by this team.

checkRepo(integer $id, string $repo) : object
throws

\UnexpectedValueException

since

3.3

Arguments

$id

integerThe team id.

$repo

stringThe name of the GitHub repository.

Response

object

create

Create team.

create(string $org, string $name, array $repoNames = array(), string $permission = '') : object

In order to create a team, the authenticated user must be an owner of the organization.

throws

\UnexpectedValueException

since

3.3

Arguments

$org

stringThe name of the organization.

$name

stringThe name of the team.

$repoNames

arrayRepository names.

$permission

stringThe permission. pull - team members can pull, but not push to or administer these repositories. Default push - team members can pull and push, but not administer these repositories. admin - team members can pull, push and administer these repositories.

Response

object

delete

Delete team.

delete(integer $id) : object

In order to delete a team, the authenticated user must be an owner of the org that the team is associated with.

since

3.3

Arguments

$id

integerThe team id.

Response

object

edit

Edit team.

edit(integer $id, string $name, string $permission = '') : object

In order to edit a team, the authenticated user must be an owner of the org that the team is associated with.

throws

\UnexpectedValueException

since

3.3

Arguments

$id

integerThe team id.

$name

stringThe name of the team.

$permission

stringThe permission. pull - team members can pull, but not push to or administer these repositories. Default push - team members can pull and push, but not administer these repositories. admin - team members can pull, push and administer these repositories.

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.

get

Get team.

get(integer $id) : object
since

3.3

Arguments

$id

integerThe team id.

Response

object

getList

List teams.

getList(string $org) : object
since

3.3

Arguments

$org

stringThe name of the organization.

Response

object

getListMembers

List team members.

getListMembers(integer $id) : object

In order to list members in a team, the authenticated user must be a member of the team.

since

3.3

Arguments

$id

integerThe team id.

Response

object

getListRepos

List team repos.

getListRepos(integer $id) : object
since

3.3

Arguments

$id

integerThe team id.

Response

object

isMember

Get team member.

isMember(integer $id, string $user) : object

In order to get if a user is a member of a team, the authenticated user must be a member of the team.

throws

\UnexpectedValueException

since

3.3

Arguments

$id

integerThe team id.

$user

stringThe name of the user.

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

removeMember

Remove team member.

removeMember(integer $id, string $user) : object

In order to remove a user from a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with. NOTE: This does not delete the user, it just remove them from the team.

since

3.3

Arguments

$id

integerThe team id.

$user

stringThe name of the user.

Response

object

removeRepo

Remove team repo.

removeRepo(integer $id, string $owner, string $repo) : object

In order to remove a repo from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repo, it just removes it from the team.

since

3.3

Arguments

$id

integerThe team id.

$owner

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

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