Class JGithubPackagePulls

GitHub API Pull Requests class for the Joomla Platform.

JGithubPackagePulls

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.3
Documentation: https://developer.github.com/v3/pulls
Located at joomla/github/package/pulls.php

Methods summary

`public object`	# `create( string $user, string $repo, string $title, string $base, string $head, string $body = '' )` Method to create a pull request. Method to create a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$title` `string` - $title The title of the new pull request. `$base` `string` - $base The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo. `$head` `string` - $head The branch (or git ref) where your changes are implemented. `$body` `string` - $body The body text for the new pull request. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `createFromIssue( string $user, string $repo, integer $issueId, string $base, string $head )` Method to create a pull request from an existing issue. Method to create a pull request from an existing issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue number for which to attach the new pull request. `$base` `string` - $base The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo. `$head` `string` - $head The branch (or git ref) where your changes are implemented. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `edit( string $user, string $repo, integer $pullId, string $title = null, string $body = null, string $state = null )` Method to update a pull request. Method to update a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$title` `string` - $title The optional new title for the pull request. `$body` `string` - $body The optional new body text for the pull request. `$state` `string` - $state The optional new state for the pull request. [open, closed] Returns `object` Throws `DomainException` Since 11.3
`public object`	# `get( string $user, string $repo, integer $pullId )` Method to get a single pull request. Method to get a single pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. Returns `object` Throws `DomainException` Since 11.3
`public array`	# `getCommits( string $user, string $repo, integer $pullId, integer $page = 0, integer $limit = 0 )` Method to get a list of commits for a pull request. Method to get a list of commits for a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public array`	# `getFiles( string $user, string $repo, integer $pullId, integer $page = 0, integer $limit = 0 )` Method to get a list of files for a pull request. Method to get a list of files for a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public array`	# `getList( string $user, string $repo, string $state = 'open', integer $page = 0, integer $limit = 0 )` Method to list pull requests. Method to list pull requests. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$state` `string` - $state The optional state to filter requests by. [open, closed] `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Throws `DomainException` Since 11.3
`public boolean`	# `isMerged( string $user, string $repo, integer $pullId )` Method to check if a pull request has been merged. Method to check if a pull request has been merged. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. The pull request number. Returns `boolean` - True if the pull request has been merged. Throws `DomainException` Since 11.3
`public object`	# `merge( string $user, string $repo, integer $pullId, string $message = '' )` Method to merge a pull request. Method to merge a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$message` `string` - $message The message that will be used for the merge commit. Returns `object` Throws `DomainException` Since 11.3
`public object`	# `createComment( string $user, string $repo, integer $pullId, string $body, string $commitId, string $filePath, string $position )` Method to create a comment on a pull request. Method to create a comment on a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$body` `string` - $body The comment body text. `$commitId` `string` - $commitId The SHA1 hash of the commit to comment on. `$filePath` `string` - $filePath The Relative path of the file to comment on. `$position` `string` - $position The line index in the diff to comment on. Returns `object` Since 11.3
`public object`	# `createCommentReply( string $user, string $repo, integer $pullId, string $body, integer $inReplyTo )` Method to create a comment in reply to another comment. Method to create a comment in reply to another comment. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$body` `string` - $body The comment body text. `$inReplyTo` `integer` - $inReplyTo The id of the comment to reply to. Returns `object` Since 11.3
`public`	# `deleteComment( string $user, string $repo, integer $commentId )` Method to delete a comment on a pull request. Method to delete a comment on a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$commentId` `integer` - $commentId The id of the comment to delete. Since 11.3
`public object`	# `editComment( string $user, string $repo, integer $commentId, string $body )` Method to update a comment on a pull request. Method to update a comment on a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$commentId` `integer` - $commentId The id of the comment to update. `$body` `string` - $body The new body text for the comment. Returns `object` Since 11.3
`public object`	# `getComment( string $user, string $repo, integer $commentId )` Method to get a specific comment on a pull request. Method to get a specific comment on a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$commentId` `integer` - $commentId The comment id to get. Returns `object` Since 11.3
`public array`	# `getComments( string $user, string $repo, integer $pullId, integer $page = 0, integer $limit = 0 )` Method to get the list of comments on a pull request. Method to get the list of comments on a pull request. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$pullId` `integer` - $pullId The pull request number. `$page` `integer` - $page The page number from which to get items. `$limit` `integer` - $limit The number of items on a page. Returns `array` Since 11.3

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

`protected string`	`$name`	# Since 3.3 (CMS)
`protected array`	`$packages`	# Since 3.3 (CMS)

Properties inherited from JGithubObject

$client, $options

Magic properties

`public read-only JGithubPackagePullsComments`	`$comments`		# GitHub API object for comments. GitHub API object for comments.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackagePulls

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Since

Since

Properties inherited from JGithubObject

Magic properties