Class JGithubForks

Description
Description | Vars | Methods (details)

GitHub API Forks class for the Joomla Platform.

  • since: 11.3

Located in /libraries/joomla/github/forks.php (line 19) 

JGithubObject
   |
   --JGithubForks
Method Summary
Description | Vars | Methods (details)
object create (string $user, string $repo, [string $org = ''])
array getList (string $user, string $repo, [integer $page = 0], [integer $limit = 0])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
 JGithubObject::$options
Methods
Description | Vars Methods (details)
create (line 33)

Method to fork a repository.

  • since: 11.4
  • throws: DomainException
  • access: public
object create (string $user, string $repo, [string $org = ''])
  • 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.
getList (line 76)

Method to list forks for a repository.

  • since: 11.4
  • throws: DomainException
  • access: public
array getList (string $user, string $repo, [integer $page = 0], [integer $limit = 0])
  • 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

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()

Documentation generated on Tue, 19 Nov 2013 15:03:29 +0100 by phpDocumentor 1.4.3