Class JGithubCommits

GitHub API Commits class for the Joomla Platform.

JGithubCommits

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: 12.1
Located at joomla/github/commits.php

Methods summary

`public object`	# `create( string $user, string $repo, string $message, string $tree, array $parents = array() )` Method to create a commit. Method to create a commit. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$message` `string` - $message The commit message. `$tree` `string` - $tree SHA of the tree object this commit points to. `$parents` `array` - $parents Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided. For a merge commit, an array of more than one should be provided. Returns `object` Since 12.1
`public object`	# `createCommitComment( string $user, string $repo, string $sha, string $comment, integer $line, string $filepath, integer $position )` Method to create a comment on a commit. Method to create a comment on a commit. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$sha` `string` - $sha The SHA of the commit to comment on. `$comment` `string` - $comment The text of the comment. `$line` `integer` - $line The line number of the commit to comment on. `$filepath` `string` - $filepath A relative path to the file to comment on within the commit. `$position` `integer` - $position Line index in the diff to comment on. Returns `object` Since 12.1
`public object`	# `deleteCommitComment( string $user, string $repo, string $id )` Method to delete a comment on a commit. Method to delete a comment on a commit. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$id` `string` - $id The ID of the comment to edit. Returns `object` Since 12.1
`public object`	# `editCommitComment( string $user, string $repo, string $id, string $comment )` Method to edit a comment on a commit. Method to edit a comment on a commit. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$id` `string` - $id The ID of the comment to edit. `$comment` `string` - $comment The text of the comment. Returns `object` Since 12.1
`public array`	# `getCommit( string $user, string $repo, string $sha, integer $page = 0, integer $limit = 0 )` Method to get a single commit for a repository. Method to get a single commit for a repository. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$sha` `string` - $sha The SHA of the commit to retrieve. `$page` `integer` - $page Page to request `$limit` `integer` - $limit Number of results to return per page Returns `array` Since 12.1
`public array`	# `getCommitComment( string $user, string $repo, integer $id )` Method to get a single comment on a commit. Method to get a single comment on a commit. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$id` `integer` - $id ID of the comment to retrieve Returns `array` Since 12.1
`public array`	# `getCommitComments( string $user, string $repo, string $sha, integer $page = 0, integer $limit = 0 )` Method to get a list of comments for a single commit for a repository. Method to get a list of comments for a single commit for a repository. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$sha` `string` - $sha The SHA of the commit to retrieve. `$page` `integer` - $page Page to request `$limit` `integer` - $limit Number of results to return per page Returns `array` Since 12.1
`public array`	# `getDiff( string $user, string $repo, string $base, string $head )` Method to get a diff for two commits. Method to get a diff for two commits. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$base` `string` - $base The base of the diff, either a commit SHA or branch. `$head` `string` - $head The head of the diff, either a commit SHA or branch. Returns `array` Since 12.1
`public array`	# `getList( string $user, string $repo, integer $page = 0, integer $limit = 0 )` Method to list commits for a repository. Method to list commits for a repository. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$page` `integer` - $page Page to request `$limit` `integer` - $limit Number of results to return per page Returns `array` Since 12.1
`public array`	# `getListComments( string $user, string $repo, integer $page = 0, integer $limit = 0 )` Method to get a list of commit comments for a repository. Method to get a list of commit comments for a repository. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$page` `integer` - $page Page to request `$limit` `integer` - $limit Number of results to return per page Returns `array` Since 12.1

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubCommits

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Properties inherited from JGithubObject