JGithubPackageSearch

class JGithubPackageSearch extends JGithubPackage

GitHub API Search class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
issues( string $owner, string $repo, string $state, string $keyword)

Search issues.

object
repositories( string $keyword, string $language = '', integer $start_page)

Search repositories.

object
users( string $keyword, integer $start_page)

Search users.

object
email( string $email)

Email search.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object issues( string $owner, string $repo, string $state, string $keyword)

Search issues.

Parameters

string $owner The name of the owner of the repository.
string $repo The name of the repository.
string $state The state - open or closed.
string $keyword The search term.

Return Value

object

Exceptions

UnexpectedValueException

object repositories( string $keyword, string $language = '', integer $start_page)

Search repositories.

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.

Parameters

string $keyword The search term.
string $language Filter results by language https://github.com/languages
integer $start_page Page number to fetch

Return Value

object

object users( string $keyword, integer $start_page)

Search users.

Find users by keyword.

Parameters

string $keyword The search term.
integer $start_page Page number to fetch

Return Value

object

object email( string $email)

Email search.

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).

Parameters

string $email The email address(es).

Return Value

object