Joomla! API

Download
Launch

Search

Extends AbstractPackage

GitHub 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
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0
throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

email

Email search.

email(string email) : object
deprecated

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

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, int page, int limit) : string
inherited
since

1.0
note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

stringThe request URL.

issues

Search issues.

issues(string owner, string repo, string state, string keyword) : object
deprecated
since

1.0
throws

\UnexpectedValueException
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, int expectedCode = 200) : mixed
inherited
since

1.0
throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

repositories

Search repositories.

repositories(string keyword, string language = '', int startPage) : object
deprecated

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(string keyword, int startPage) : object
deprecated

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

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
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
  • \ Joomla
  • \ Github
  • \ Package
  • \ Search