Data
Extends \Joomla\Github\AbstractPackageGitHub API DB class for the Joomla Framework.
| link | |
|---|---|
| since |
1.0 |
| property-read |
GitHub API object for blobs. GitHub API object for commits. GitHub API object for refs. GitHub API object for tags. GitHub API object for trees. |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \Joomla\Http\Http $client = null)
| since |
1.0 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGitHub options object.- $client
\Joomla\Http\HttpThe HTTP client object.
__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, integer $page, integer $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
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response $response, integer $expectedCode = 200) : mixed
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- $response
\Joomla\Http\ResponseThe response.- $expectedCode
integerThe expected "good" code.
Response
mixed
Properties
client
The HTTP client object to use in sending HTTP requests.
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
blobs
GitHub API object for blobs.
Type(s)
\Joomla\Github\Package\Data\Blobs
commits
GitHub API object for commits.
Type(s)
\Joomla\Github\Package\Data\Commits
refs
GitHub API object for refs.
Type(s)
\Joomla\Github\Package\Data\Refs
tags
GitHub API object for tags.
Type(s)
\Joomla\Github\Package\Data\Tags
trees
GitHub API object for trees.
Type(s)
\Joomla\Github\Package\Data\Trees