Class JGithubObject

Description

GitHub API object class for the Joomla Platform.

  • abstract:
  • since: 11.3

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


	
			
Direct descendents
Class Description
JGithubRefs GitHub API References class for the Joomla Platform.
JGithubGists GitHub API Gists class for the Joomla Platform.
JGithubIssues GitHub API Issues class for the Joomla Platform.
JGithubForks GitHub API References class for the Joomla Platform.
JGithubPulls GitHub API Pull Requests class for the Joomla Platform.
Variable Summary
Method Summary
JGithubObject __construct ([JRegistry &$options = null], [JGithubHttp $client = null])
string fetchUrl (string $path, [integer $page = 0], [integer $limit = 0])
Variables
JGithubHttp $client (line 31)
  • var: The HTTP client object to use in sending HTTP requests.
  • since: 11.3
  • access: protected
JRegistry $options (line 25)
  • var: Options for the GitHub object.
  • since: 11.3
  • access: protected
Methods
Constructor __construct (line 41)

Constructor.

  • since: 11.3
  • access: public
JGithubObject __construct ([JRegistry &$options = null], [JGithubHttp $client = null])
fetchUrl (line 60)

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.

  • return: The request URL.
  • since: 11.3
  • access: protected
string fetchUrl (string $path, [integer $page = 0], [integer $limit = 0])
  • string $path: URL to inflect
  • integer $page: Page to request
  • integer $limit: Number of results to return per page

Documentation generated on Mon, 25 Jun 2012 13:58:19 -0500 by phpDocumentor 1.4.4