class JGithubPackageRepositoriesMerging extends JGithubPackage

GitHub API Repositories Merging class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

__get( string $name)

Magic method to lazily create API objects

boolean
perform( string $owner, string $repo, string $base, string $head, string $commit_message = '')

Perform a merge.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

boolean perform( string $owner, string $repo, string $base, string $head, string $commit_message = '')

Perform a merge.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $base The name of the base branch that the head will be merged into.
string $head The head to merge. This can be a branch name or a commit SHA1.
string $commit_message Commit message to use for the merge commit. If omitted, a default message will be used.

Return Value

boolean

Exceptions

UnexpectedValueException