JGithubForks
Extends \JGithubObjectGitHub API References class for the Joomla Platform.
| package |
Joomla.Platform |
|---|---|
| subpackage |
GitHub |
| since |
11.3 |
Methods
__construct
Constructor.
__construct(\JRegistry &$options = null, \JGithubHttp $client = null)
create
Method to create an issue.
create(string $user, string $repo, string $org = '') : object
| since |
11.4 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $org
stringThe organization to fork the repo into. By default it is forked to the current user.
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, integer $page, integer $limit) : string
| since |
11.3 |
|---|
Arguments
- $path
stringURL to inflect- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
getList
Method to list forks for a repository.
getList(string $user, string $repo, integer $page, integer $limit) : array
| since |
11.4 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
array
Properties
client
The HTTP client object to use in sending HTTP requests.