Events

Extends \Joomla\Github\AbstractPackage

GitHub API Activity Events class for the Joomla Framework.

link

https://developer.github.com/v3/activity/events/

since

1.0

Methods

__construct

Constructor.

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

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

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

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

note

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

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

getByUser

List events performed by a user.

getByUser(string $user) : object

If you are authenticated as the given user, you will see your private events. Otherwise, you’ll only see public events.

since

1.0

Arguments

$user

stringUser name.

Response

object

getByUserPublic

List public events performed by a user.

getByUserPublic(string $user) : object
since

1.0

Arguments

$user

stringUser name.

Response

object

getIssue

List issue events for a repository.

getIssue(string $owner, string $repo) : object
since

1.0

Arguments

$owner

stringRepository owner.

$repo

stringRepository name.

Response

object

getNetwork

List public events for a network of repositories.

getNetwork(string $owner, string $repo) : object
since

1.0

Arguments

$owner

stringRepository owner.

$repo

stringRepository name.

Response

object

getOrg

List public events for an organization.

getOrg(string $org) : object
since

1.0

Arguments

$org

stringOrganization.

Response

object

getPublic

List public events.

getPublic() : object
since

1.0

Response

object

getRepository

List repository events.

getRepository(string $owner, string $repo) : object
since

1.0

Arguments

$owner

stringRepository owner.

$repo

stringRepository name.

Response

object

getUser

List events that a user has received.

getUser(string $user) : object

These are events that you’ve received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.

since

1.0

Arguments

$user

stringUser name.

Response

object

getUserOrg

List events for an organization.

getUserOrg(string $user, string $org) : object

This is the user’s organization dashboard. You must be authenticated as the user to view this.

since

1.0

Arguments

$user

stringUser name.

$org

stringOrganisation.

Response

object

getUserPublic

List public events that a user has received.

getUserPublic(string $user) : object
since

1.0

Arguments

$user

stringUser name.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response $response, integer $expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe expected "good" code.

Response

mixed

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\Github\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

https://developer.github.com/webhooks/#events

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