Download the PHP package joomla/github without Composer
On this page you can find all versions of the php package joomla/github. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download joomla/github
More information about joomla/github
Files in joomla/github
Package github
Short Description Joomla Github Package
License GPL-2.0-or-later
Homepage https://github.com/joomla-framework/github-api
Informations about the package github
The GitHub Package
Using the GitHub Package
The GitHub package is designed to be a straightforward interface for working with GitHub. It is based on version 3 of the GitHub API. You can find documentation on the API at http://developer.github.com/v3/.
GitHub is built upon the Http package which provides an easy way to consume URLs and web services in a transport
independent way. Joomla\Http
currently supports streams, sockets and cURL. It is possible to create a custom
context and inject it into the GitHub class if one so desires.
Instantiating GitHub
Instantiating GitHub is easy:
This creates a basic GitHub object that can be used to access publicly available resources on github.com.
Sometimes it is necessary to specify additional options. This can be done by injecting in a Registry object with your preferred options. Support is available for optionally providing a custom GitHub account username and password, as well as a custom URL for the GitHub server (as would be the case for using a local instance of GitHub Enterprise).
A gh.token
option is also available.
Here is an example demonstrating more of the GitHub package:
Accessing the GitHub APIs
The GitHub object using magic methods to access sub-packages of the GitHub server's API that can be accessed using
the ->
object operator.
Where a result is returned by a PHP method, the result is the PHP equivalent of the JSON response that can be found in the GitHub API documentation.
Activity
See http://developer.github.com/v3/activity/.
Events
See http://developer.github.com/v3/activity/events/.
Notifications
See http://developer.github.com/v3/activity/notifications/.
Starring
See http://developer.github.com/v3/activity/starring/.
Watching
See http://developer.github.com/v3/activity/watching/.
Gists
See http://developer.github.com/v3/gists/.
Comments
See http://developer.github.com/v3/gists/comments/.
Git Data
See http://developer.github.com/v3/git/.
Blobs
See http://developer.github.com/v3/git/blobs/.
Commits
See http://developer.github.com/v3/git/commits/.
References
See http://developer.github.com/v3/git/refs/.
Tags
See http://developer.github.com/v3/git/tags/.
Trees
See http://developer.github.com/v3/git/trees/.
Issues
See http://developer.github.com/v3/issues/.
Assignees
See http://developer.github.com/v3/issues/assignees/.
Comments
See http://developer.github.com/v3/issues/comments/
Events
See http://developer.github.com/v3/issues/events/.
Labels
See http://developer.github.com/v3/issues/labels/.
Milestones
See http://developer.github.com/v3/issues/milestones/.
Miscellaneous
See http://developer.github.com/v3/misc/.
Gitignore
See http://developer.github.com/v3/gitignore/
Markdown
See http://developer.github.com/v3/markdown/.
Meta
See http://developer.github.com/v3/meta/
Ratelimit
See http://developer.github.com/v3/rate_limit/.
Organisations
See http://developer.github.com/v3/orgs/.
Members
See
Teams
See http://developer.github.com/v3/orgs/teams/.
Pull Requests
See http://developer.github.com/v3/pulls/.
Review Comments
See http://developer.github.com/v3/pulls/comments/.
TODO
See Also
The following resources contain more information: Joomla! API Reference, GitHub API Reference.
Installation via Composer
Add "joomla/github": "~2.0"
to the require block in your composer.json and then run composer install
.
Alternatively, you can simply run the following from the command line:
If you want to include the test sources, use
All versions of github with dependencies
joomla/http Version ^3.0
joomla/registry Version ^3.0
joomla/uri Version ^3.0