Orgs
Extends AbstractPackageGitHub 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) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
edit
Edit an organization.
edit( org, billingEmail = '', company = '', email = '', location = '', name = '') :
| since |
1.0 |
|---|
Arguments
- org
stringThe organization name.- billingEmail
stringBilling email address. This address is not publicized.- company
stringThe company name.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( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
get
Get an organization.
get( org) :
| since |
1.0 |
|---|
Arguments
- org
stringThe organization name.
Response
object
getList
List user organizations.
getList( user = '') :
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, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
Properties
hooks
members
teams
package
The package the object resides in
| since |
1.0 |
|---|
Type(s)
string
hookEvents
Array containing the allowed hook events
| 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<string|int, mixed>