Activity
Extends AbstractPackageGitHub API Activity class for the Joomla Framework.
| since |
1.0 |
|---|---|
| documentation |
http://developer.github.com/v3/activity/ |
| property-read Events |
GitHub API object for events. GitHub API object for feeds. GitHub API object for notifications. GitHub API object for starring. GitHub API object for watching. |
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
| 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
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
\Joomla\Github\AbstractPackageGitHub API package 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
| 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.
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
\Joomla\Http\ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
Properties
options
Options for the GitHub object.
| since |
1.0 |
|---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
| since |
1.0 |
|---|
Type(s)
\Joomla\Http\Http
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
events
GitHub API object for events.
Type(s)
\Joomla\Github\Package\Activity\Events
feeds
GitHub API object for feeds.
Type(s)
\Joomla\Github\Package\Activity\Feeds
notifications
GitHub API object for notifications.
Type(s)
\Joomla\Github\Package\Activity\Notifications
starring
GitHub API object for starring.
Type(s)
\Joomla\Github\Package\Activity\Starring
watching
GitHub API object for watching.
Type(s)
\Joomla\Github\Package\Activity\Watching