JGithubPackageSearch

Extends \JGithubPackage

GitHub API Search class for the Joomla Platform.

deprecated
documentation

https://developer.github.com/v3/search

since

3.1.4

deprecated

4.0 Use the joomla/github package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null) 
inherited
since

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubPackage
inherited
since

3.3

throws

\RuntimeException

Arguments

$name

stringName of property to retrieve

Response

\JGithubPackageGitHub API package object.

email

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

3.3

Arguments

$email

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(string $path, integer $page, integer $limit) : string
inherited
since

1.7.3

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

issues

Search issues.

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

\UnexpectedValueException

since

3.3

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(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
inherited
throws

\DomainException

since

3.3.0

Arguments

$response

\JHttpResponseThe response.

$expectedCode

integerThe expected "good" code.

$decode

booleanIf the should be response be JSON decoded.

Response

mixed

repositories

Search repositories.

repositories(string $keyword, string $language = '', integer $start_page) : 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

3.3

Arguments

$keyword

stringThe search term.

$language

stringFilter results by language https://github.com/languages

$start_page

integerPage number to fetch

Response

object

users

Search users.

users(string $keyword, integer $start_page) : object

Find users by keyword.

since

3.3

Arguments

$keyword

stringThe search term.

$start_page

integerPage number to fetch

Response

object

Properties

name

inherited
since

3.3

Type(s)

string

packages

inherited
since

3.3

Type(s)

array

options

Options for the GitHub object.

inherited
since

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.7.3

Type(s)

\JGithubHttp