JGithubPackageOrgs

class JGithubPackageOrgs extends JGithubPackage

GitHub API Activity 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
object
getList( string $user = '')

List User Organizations.

object
get( string $org)

Get an Organization.

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

Edit an Organization.

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

object getList( string $user = '')

List User Organizations.

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

Parameters

string $user The user name.

Return Value

object

object get( string $org)

Get an Organization.

Parameters

string $org The organization name.

Return Value

object

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

Edit an Organization.

Parameters

string $org The organization name.
string $billingEmail Billing email address. This address is not publicized.
string $company The company name.
string $email The email address.
string $location The location name.
string $name The name.

Return Value

object