Joomla! API

Download
Launch

Starring

Extends AbstractPackage

GitHub API Activity Events 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.

check

Check if you are starring a repository.

check(string owner, string repo) : bool

Requires for the user to be authenticated.

since

1.0
throws

\UnexpectedValueException

Arguments

owner

stringRepository owner.

repo

stringRepository name.

Response

bool

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.

getList

List Stargazers.

getList(string owner, string repo) : mixed
since

1.0

Arguments

owner

stringRepository owner.

repo

stringRepository name.

Response

mixed

getRepositories

List repositories being starred.

getRepositories(string user = '', string sort = 'created', string direction = 'desc') : object

List repositories being starred by a user.

since

1.0
throws

\InvalidArgumentException

Arguments

user

stringUser name.

sort

stringOne of created (when the repository was starred) or updated (when it was last pushed to).

direction

stringOne of asc (ascending) or desc (descending).

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

star

Star a repository.

star(string owner, string repo) : object

Requires for the user to be authenticated.

since

1.0

Arguments

owner

stringRepository owner.

repo

stringRepository name.

Response

object

unstar

Unstar a repository.

unstar(string owner, string repo) : object

Requires for the user to be authenticated.

since

1.0

Arguments

owner

stringRepository owner.

repo

stringRepository name.

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
  • \ Activity
  • \ Starring