Joomla! API

Download
Launch

Orgs

Extends AbstractPackage

GitHub API Activity class for the Joomla Framework.

since

1.0
documentation

http://developer.github.com/v3/orgs/
property-read Hooks

GitHub API object for hooks.

GitHub API object for members.

GitHub API object for teams.
package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0
throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

edit

Edit an organization.

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

1.0

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, int page, int limit) : string
inherited
since

1.0
note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

stringThe request URL.

get

Get an organization.

get(string org) : object
since

1.0

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

1.0

Arguments

user

stringThe user name.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
inherited
since

1.0
throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2
link
note

From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array

hooks

GitHub API object for hooks.

Type(s)

\Joomla\Github\Package\Orgs\Hooks

members

GitHub API object for members.

Type(s)

\Joomla\Github\Package\Orgs\Members

teams

GitHub API object for teams.

Type(s)

\Joomla\Github\Package\Orgs\Teams
  • \ Joomla
  • \ Github
  • \ Package
  • \ Orgs