Search
Extends AbstractPackageGitHub API Search class for the Joomla Framework.
link | |
---|---|
since |
1.0 |
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
GitHub options object.- client
\Joomla\Http\Http
The HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
since |
1.0 |
---|---|
throws |
|
Arguments
- name
string
Name of property to retrieve
Response
\Joomla\Github\AbstractPackage
GitHub API package object.
Email search.
email(string email) : object
This API call is added for compatibility reasons only. There’s no guarantee that full email searches will always be available. The @ character in the address must be left unencoded. Searches only against public email addresses (as configured on the user’s GitHub profile).
since |
1.0 |
---|---|
deprecated |
The legacy API is deprecated |
Arguments
string
The email address(es).
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, int page, int limit) : \Joomla\Uri\Uri
since |
1.0 |
---|
Arguments
- path
string
URL to inflect- page
int
Page to request- limit
int
Number of results to return per page
Response
\Joomla\Uri\Uri
issues
Search issues.
issues(string owner, string repo, string state, string keyword) : object
since |
1.0 |
---|---|
throws |
|
deprecated |
The legacy API is deprecated |
Arguments
- owner
string
The name of the owner of the repository.- repo
string
The name of the repository.- state
string
The state - open or closed.- keyword
string
The search term.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response.- expectedCode
int
The expected "good" code.
Response
mixed
repositories
Search repositories.
repositories(string keyword, string language = '', int startPage) : object
Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.
since |
1.0 |
---|---|
deprecated |
The legacy API is deprecated |
Arguments
- keyword
string
The search term.- language
string
Filter results by language https://github.com/languages- startPage
int
Page number to fetch
Response
object
users
Search users.
users(string keyword, int startPage) : object
Find users by keyword.
since |
1.0 |
---|---|
deprecated |
The legacy API is deprecated |
Arguments
- keyword
string
The search term.- startPage
int
Page number to fetch
Response
object
Properties
options
Options for the GitHub object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Http\Http
package
The package the object resides in
since |
1.0 |
---|
Type(s)
string
hookEvents
Array containing the allowed hook events
since |
1.5.2 |
---|---|
link | |
note |
From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses |
Type(s)
array