class JGithubForks extends JGithubObject

GitHub API Forks class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

object
create( string $user, string $repo, string $org = '')

Method to fork a repository.

array
getList( string $user, string $repo, integer $page, integer $limit)

Method to list forks for a repository.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

object create( string $user, string $repo, string $org = '')

Method to fork a repository.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $org The organization to fork the repo into. By default it is forked to the current user.

Return Value

object

Exceptions

DomainException

array getList( string $user, string $repo, integer $page, integer $limit)

Method to list forks for a repository.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $page Page to request
integer $limit Number of results to return per page

Return Value

array

Exceptions

DomainException