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) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
Email search.
email( email) :
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
stringThe 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( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
issues
Search issues.
issues( owner, repo, state, keyword) :
| since |
1.0 |
|---|---|
| throws |
|
| deprecated |
The legacy API is deprecated |
Arguments
- owner
stringThe name of the owner of the repository.- repo
stringThe name of the repository.- state
stringThe state - open or closed.- keyword
stringThe search term.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
repositories
Search repositories.
repositories( keyword, language = '', startPage) :
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
stringThe search term.- language
stringFilter results by language https://github.com/languages- startPage
intPage number to fetch
Response
object
users
Search users.
users( keyword, startPage) :
Find users by keyword.
| since |
1.0 |
|---|---|
| deprecated |
The legacy API is deprecated |
Arguments
- keyword
stringThe search term.- startPage
intPage number to fetch
Response
object
Properties
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<string|int, mixed>