JGithubPackageOrgs

Extends \JGithubPackage

GitHub API Activity class for the Joomla Platform.

deprecated
since

3.3

deprecated

4.0 Use the joomla/github package via Composer instead

documentation

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

property-read

GitHub API object for members.

GitHub API object for teams.

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.

edit

Edit an Organization.

edit(string $org, string $billingEmail = '', string $company = '', string $email = '', string $location = '', string $name = '') : object
since

3.3

Arguments

$org

stringThe organization name.

$billingEmail

stringBilling email address. This address is not publicized.

$company

stringThe company name.

$email

stringThe email address.

$location

stringThe location name.

$name

stringThe name.

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 an Organization.

get(string $org) : object
since

3.3

Arguments

$org

stringThe organization name.

Response

object

getList

List User Organizations.

getList(string $user = '') : object

If a user name is given, public and private organizations for the authenticated user will be listed.

since

3.3

Arguments

$user

stringThe user name.

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

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

members

GitHub API object for members.

Type(s)

\JGithubPackageOrgsMembers

teams

GitHub API object for teams.

Type(s)

\JGithubPackageOrgsTeams