JGithubPackagePullsComments

Extends \JGithubPackage

GitHub API Pulls Comments class for the Joomla Platform.

deprecated
documentation

https://developer.github.com/v3/pulls/comments/

since

3.3

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.

create

Method to create a comment on a pull request.

create(string $user, string $repo, integer $pullId, string $body, string $commitId, string $filePath, string $position) : object
throws

\DomainException

since

1.7.3

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$body

stringThe comment body text.

$commitId

stringThe SHA1 hash of the commit to comment on.

$filePath

stringThe Relative path of the file to comment on.

$position

stringThe line index in the diff to comment on.

Response

object

createReply

Method to create a comment in reply to another comment.

createReply(string $user, string $repo, integer $pullId, string $body, integer $inReplyTo) : object
throws

\DomainException

since

1.7.3

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$body

stringThe comment body text.

$inReplyTo

integerThe id of the comment to reply to.

Response

object

delete

Method to delete a comment on a pull request.

delete(string $user, string $repo, integer $commentId) : void
throws

\DomainException

since

1.7.3

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$commentId

integerThe id of the comment to delete.

edit

Method to update a comment on a pull request.

edit(string $user, string $repo, integer $commentId, string $body) : object
throws

\DomainException

since

1.7.3

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$commentId

integerThe 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, 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.

get

Method to get a specific comment on a pull request.

get(string $user, string $repo, integer $commentId) : object
throws

\DomainException

since

1.7.3

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$commentId

integerThe comment id to get.

Response

object

getList

Method to get the list of comments on a pull request.

getList(string $user, string $repo, integer $pullId, integer $page, integer $limit) : array
throws

\DomainException

since

1.7.3

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$pullId

integerThe pull request number.

$page

integerThe page number from which to get items.

$limit

integerThe number of items on a page.

Response

array

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

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