Joomla! API

Download
Launch

Comments

Extends AbstractPackage

GitHub API Comments class for the Joomla Framework.

The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.

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.

create

Create a comment.

create(string user, string repo, int issueId, string body) : object
since

1.0
throws

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

issueId

intThe issue number.

body

stringThe comment body text.

Response

object

delete

Delete a comment.

delete(string user, string repo, int commentId) : bool
since

1.0
throws

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

commentId

intThe id of the comment to delete.

Response

bool

edit

Edit a comment.

edit(string user, string repo, int commentId, string body) : object
since

1.0
throws

\DomainException

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

commentId

intThe id of the comment to update.

body

stringThe new body text for the comment.

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) : \Joomla\Uri\Uri
inherited
since

1.0

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

\Joomla\Uri\Uri

get

Get a single comment.

get(string owner, string repo, int id) : object
since

1.0
throws

\DomainException

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

id

intThe comment id.

Response

object

getList

List comments on an issue.

getList(string owner, string repo, int issueId, int page, int limit, \DateTimeInterface since = null) : object
since

1.0
throws

\DomainException

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

issueId

intThe issue number.

page

intThe page number from which to get items.

limit

intThe number of items on a page.

since

\DateTimeInterfaceOnly comments updated at or after this time are returned.

Response

object

getRepositoryList

List comments in a repository.

getRepositoryList(string owner, string repo, string sort = 'created', string direction = 'asc', \DateTimeInterface since = null) : object
since

1.0
throws

\UnexpectedValueException

\DomainException

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

sort

stringThe sort field - created or updated.

direction

stringThe sort order- asc or desc. Ignored without sort parameter.

since

\DateTimeInterfaceOnly comments updated at or after this time are returned.

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

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
  • \ Issues
  • \ Comments