PHPGit - A Git wrapper for PHP5.3+

Requirements

PHP5.3
Git

Installation

Update your composer.json and run composer update

{
    "require": {
        "kzykhys/git": "dev-master"
    }
}

Basic Usage

<?php

require __DIR__ . '/vendor/autoload.php';

$git = new PHPGit\Git();
$git->clone('https://github.com/kzykhys/PHPGit.git', '/path/to/repo');
$git->setRepository('/path/to/repo');
$git->remote->add('production', 'git://example.com/your/repo.git');
$git->add('README.md');
$git->commit('Adds README.md');
$git->checkout('release');
$git->merge('master');
$git->push();
$git->push('production', 'release');
$git->tag->create('v1.0.1', 'release');

foreach ($git->tree('release') as $object) {
    if ($object['type'] == 'blob') {
        echo $git->show($object['file']);
    }
}

API

Git commands

git add
- $git->add(string|array|\Traversable $file, array $options = [])
git archive
- $git->archive(string $file, string $tree = null, string|array|\Traversable $path = null, array $options = [])
git branch
- $git->branch(array $options = [])
- $git->branch->create(string $branch, string $startPoint = null, array $options = [])
- $git->branch->move(string $branch, string $newBranch, array $options = [])
- $git->branch->delete(string $branch, array $options = [])
git cat-file
- $git->cat->blob(string $object)
- $git->cat->type(string $object)
- $git->cat->size(string $object)
git checkout
- $git->checkout(string $branch, array $options = [])
- $git->checkout->create(string $branch, string $startPoint = null, array $options = [])
- $git->checkout->orphan(string $branch, string $startPoint = null, array $options = [])
git clone
- $git->clone(string $repository, string $path = null, array $options = [])
git commit
- $git->commit(string $message, array $options = [])
git config
- $git->config(array $options = [])
- $git->config->set(string $name, string $value, array $options = [])
- $git->config->add(string $name, string $value, array $options = [])
git describe
- $git->describe(string $committish = null, array $options = [])
- $git->describe->tags(string $committish = null, array $options = [])
git fetch
- $git->fetch(string $repository, string $refspec = null, array $options = [])
- $git->fetch->all(array $options = [])
git init
- $git->init(string $path, array $options = [])
git log
- $git->log(string $revRange = '', string $path = null, array $options = [])
git merge
- $git->merge(string|array|\Traversable $commit, string $message = null, array $options = [])
- $git->merge->abort()
git mv
- $git->mv(string|array|\Iterator $source, string $destination, array $options = [])
git pull
- $git->pull(string $repository = null, string $refspec = null, array $options = [])
git push
- $git->push(string $repository = null, string $refspec = null, array $options = [])
git rebase
- $git->rebase(string $upstream = null, string $branch = null, array $options = [])
- $git->rebase->continues()
- $git->rebase->abort()
- $git->rebase->skip()
git remote
- $git->remote()
- $git->remote->add(string $name, string $url, array $options = [])
- $git->remote->rename(string $name, string $newName)
- $git->remote->rm(string $name)
- $git->remote->show(string $name)
- $git->remote->prune(string $name = null)
- $git->remote->head(string $name, string $branch = null)
- $git->remote->head->set(string $name, string $branch)
- $git->remote->head->delete(string $name)
- $git->remote->head->remote(string $name)
- $git->remote->branches(string $name, array $branches)
- $git->remote->branches->set(string $name, array $branches)
- $git->remote->branches->add(string $name, array $branches)
- $git->remote->url(string $name, string $newUrl, string $oldUrl = null, array $options = [])
- $git->remote->url->set(string $name, string $newUrl, string $oldUrl = null, array $options = [])
- $git->remote->url->add(string $name, string $newUrl, array $options = [])
- $git->remote->url->delete(string $name, string $url, array $options = [])
git reset
- $git->reset(string|array|\Traversable $paths, string $commit = null)
- $git->reset->soft(string $commit = null)
- $git->reset->mixed(string $commit = null)
- $git->reset->hard(string $commit = null)
- $git->reset->merge(string $commit = null)
- $git->reset->keep(string $commit = null)
- $git->reset->mode(string $mode, string $commit = null)
git rm
- $git->rm(string|array|\Traversable $file, array $options = [])
- $git->rm->cached(string|array|\Traversable $file, array $options = [])
git shortlog
- $git->shortlog(string|array|\Traversable $commits = HEAD)
- $git->shortlog->summary(string $commits = HEAD)
git show
- $git->show(string $object, array $options = [])
git stash
- $git->stash()
- $git->stash->save(string $message = null, array $options = [])
- $git->stash->lists(array $options = [])
- $git->stash->show(string $stash = null)
- $git->stash->drop(string $stash = null)
- $git->stash->pop(string $stash = null, array $options = [])
- $git->stash->apply(string $stash = null, array $options = [])
- $git->stash->branch(string $name, string $stash = null)
- $git->stash->clear()
- $git->stash->create()
git status
- $git->status(array $options = [])
git tag
- $git->tag()
- $git->tag->create(string $tag, string $commit = null, array $options = [])
- $git->tag->delete(string|array|\Traversable $tag)
- $git->tag->verify(string|array|\Traversable $tag)
git ls-tree
- $git->tree(string $branch = master, string $path = '')

git add

$git->add(string|array|\Traversable $file, array $options = [])

Add file contents to the index

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->add('file.txt');
$git->add('file.txt', ['force' => false, 'ignore-errors' => false);

Options

force (boolean) Allow adding otherwise ignored files
ignore-errors (boolean) Do not abort the operation

git archive

$git->archive(string $file, string $tree = null, string|array|\Traversable $path = null, array $options = [])

Create an archive of files from a named tree

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->archive('repo.zip', 'master', null, ['format' => 'zip']);

Options

format (boolean) Format of the resulting archive: tar or zip
prefix (boolean) Prepend prefix/ to each filename in the archive

git branch

$git->branch(array $options = [])

Returns an array of both remote-tracking branches and local branches

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$branches = $git->branch();

Output Example

[
    'master' => ['current' => true, 'name' => 'master', 'hash' => 'bf231bb', 'title' => 'Initial Commit'],
    'origin/master' => ['current' => false, 'name' => 'origin/master', 'alias' => 'remotes/origin/master']
]

Options

all (boolean) List both remote-tracking branches and local branches
remotes (boolean) List the remote-tracking branches

$git->branch->create(string $branch, string $startPoint = null, array $options = [])

Creates a new branch head named $branch which points to the current HEAD, or $startPoint if given

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->branch->create('bugfix');              // from current HEAD
$git->branch->create('patch-1', 'a092bf7s'); // from commit
$git->branch->create('1.0.x-fix', 'v1.0.2'); // from tag

Options

force (boolean) Reset $branch to $startPoint if $branch exists already

$git->branch->move(string $branch, string $newBranch, array $options = [])

Move/rename a branch and the corresponding reflog

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->branch->move('bugfix', '2.0');

Options

force (boolean) Move/rename a branch even if the new branch name already exists

$git->branch->delete(string $branch, array $options = [])

Delete a branch

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->branch->delete('2.0');

The branch must be fully merged in its upstream branch, or in HEAD if no upstream was set with --track or --set-upstream.

Options

force (boolean) Delete a branch irrespective of its merged status

git cat-file

$git->cat->blob(string $object)

Returns the contents of blob object

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$contents = $git->cat->blob('e69de29bb2d1d6434b8b29ae775ad8');

$git->cat->type(string $object)

Returns the object type identified by $object

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$type = $git->cat->type('e69de29bb2d1d6434b8b29ae775ad8');

$git->cat->size(string $object)

Returns the object size identified by $object

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$type = $git->cat->size('e69de29bb2d1d6434b8b29ae775ad8');

git checkout

$git->checkout(string $branch, array $options = [])

Switches branches by updating the index, working tree, and HEAD to reflect the specified branch or commit

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->checkout('develop');

Options

force (boolean) Proceed even if the index or the working tree differs from HEAD
merge (boolean) Merges local modification

$git->checkout->create(string $branch, string $startPoint = null, array $options = [])

Create a new branch and checkout

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->checkout->create('patch-1');
$git->checkout->create('patch-2', 'develop');

Options

force (boolean) Proceed even if the index or the working tree differs from HEAD

$git->checkout->orphan(string $branch, string $startPoint = null, array $options = [])

Create a new orphan branch, named <new_branch>, started from <start_point> and switch to it

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->checkout->orphan('gh-pages');

Options

force (boolean) Proceed even if the index or the working tree differs from HEAD

git clone

$git->clone(string $repository, string $path = null, array $options = [])

Clone a repository into a new directory

$git = new PHPGit\Git();
$git->clone('https://github.com/kzykhys/PHPGit.git', '/path/to/repo');

Options

shared (boolean) Starts out without any object of its own
bare (boolean) Make a bare GIT repository

git commit

$git->commit(string $message, array $options = [])

Record changes to the repository

$git = new PHPGit\Git();
$git->clone('https://github.com/kzykhys/PHPGit.git', '/path/to/repo');
$git->setRepository('/path/to/repo');
$git->add('README.md');
$git->commit('Fixes README.md');

Options

all (boolean) Stage files that have been modified and deleted
reuse-message (string) Take an existing commit object, and reuse the log message and the authorship information (including the timestamp) when creating the commit
squash (string) Construct a commit message for use with rebase --autosquash
author (string) Override the commit author
date (string) Override the author date used in the commit
cleanup (string) Can be one of verbatim, whitespace, strip, and default
amend (boolean) Used to amend the tip of the current branch

git config

$git->config(array $options = [])

Returns all variables set in config file

Options

global (boolean) Read or write configuration options for the current user
system (boolean) Read or write configuration options for all users on the current machine

$git->config->set(string $name, string $value, array $options = [])

Set an option

Options

global (boolean) Read or write configuration options for the current user
system (boolean) Read or write configuration options for all users on the current machine

$git->config->add(string $name, string $value, array $options = [])

Adds a new line to the option without altering any existing values

Options

global (boolean) Read or write configuration options for the current user
system (boolean) Read or write configuration options for all users on the current machine

git describe

$git->describe(string $committish = null, array $options = [])

Returns the most recent tag that is reachable from a commit

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->tag->create('v1.0.0');
$git->commit('Fixes #14');
echo $git->describe('HEAD', ['tags' => true]);

Output Example

v1.0.0-1-g7049efc

Options

all (boolean) Enables matching any known branch, remote-tracking branch, or lightweight tag
tags (boolean) Enables matching a lightweight (non-annotated) tag
always (boolean) Show uniquely abbreviated commit object as fallback

$git->describe->tags(string $committish = null, array $options = [])

Equivalent to $git->describe($committish, ['tags' => true]);

git fetch

$git->fetch(string $repository, string $refspec = null, array $options = [])

Fetches named heads or tags from one or more other repositories, along with the objects necessary to complete them

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'git://your/repo.git');
$git->fetch('origin');

Options

append (boolean) Append ref names and object names of fetched refs to the existing contents of .git/FETCH_HEAD
keep (boolean) Keep downloaded pack
prune (boolean) After fetching, remove any remote-tracking branches which no longer exist on the remote

$git->fetch->all(array $options = [])

Fetch all remotes

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'git://your/repo.git');
$git->remote->add('release', 'git://your/another_repo.git');
$git->fetch->all();

Options

append (boolean) Append ref names and object names of fetched refs to the existing contents of .git/FETCH_HEAD
keep (boolean) Keep downloaded pack
prune (boolean) After fetching, remove any remote-tracking branches which no longer exist on the remote

git init

$git->init(string $path, array $options = [])

Create an empty git repository or reinitialize an existing one

$git = new PHPGit\Git();
$git->init('/path/to/repo1');
$git->init('/path/to/repo2', array('shared' => true, 'bare' => true));

Options

shared (boolean) Specify that the git repository is to be shared amongst several users
bare (boolean) Create a bare repository

git log

$git->log(string $revRange = '', string $path = null, array $options = [])

Returns the commit logs

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$logs = $git->log(array('limit' => 10));

Output Example

[
    0 => [
        'hash'  => '1a821f3f8483747fd045eb1f5a31c3cc3063b02b',
        'name'  => 'John Doe',
        'email' => 'john@example.com',
        'date'  => 'Fri Jan 17 16:32:49 2014 +0900',
        'title' => 'Initial Commit'
    ],
    1 => [
        //...
    ]
]

Options

limit (integer) Limits the number of commits to show
skip (integer) Skip number commits before starting to show the commit output

git merge

$git->merge(string|array|\Traversable $commit, string $message = null, array $options = [])

Incorporates changes from the named commits into the current branch

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->merge('1.0');
$git->merge('1.1', 'Merge message', ['strategy' => 'ours']);

Options

no-ff (boolean) Do not generate a merge commit if the merge resolved as a fast-forward, only update the branch pointer
rerere-autoupdate (boolean) Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible
squash (boolean) Allows you to create a single commit on top of the current branch whose effect is the same as merging another branch
strategy (string) Use the given merge strategy
strategy-option (string) Pass merge strategy specific option through to the merge strategy

$git->merge->abort()

Abort the merge process and try to reconstruct the pre-merge state

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
try {
    $git->merge('dev');
} catch (PHPGit\Exception\GitException $e) {
    $git->merge->abort();
}

git mv

$git->mv(string|array|\Iterator $source, string $destination, array $options = [])

Move or rename a file, a directory, or a symlink

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->mv('UPGRADE-1.0.md', 'UPGRADE-1.1.md');

Options

force (boolean) Force renaming or moving of a file even if the target exists

git pull

$git->pull(string $repository = null, string $refspec = null, array $options = [])

Fetch from and merge with another repository or a local branch

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->pull('origin', 'master');

git push

$git->push(string $repository = null, string $refspec = null, array $options = [])

Update remote refs along with associated objects

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->push('origin', 'master');

git rebase

$git->rebase(string $upstream = null, string $branch = null, array $options = [])

Forward-port local commits to the updated upstream head

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->fetch('origin');
$git->rebase('origin/master');

Options

onto (string) Starting point at which to create the new commits
no-verify (boolean) Bypasses the pre-rebase hook
force-rebase (boolean) Force the rebase even if the current branch is a descendant of the commit you are rebasing onto

$git->rebase->continues()

Restart the rebasing process after having resolved a merge conflict

$git->rebase->abort()

Abort the rebase operation and reset HEAD to the original branch

$git->rebase->skip()

Restart the rebasing process by skipping the current patch

git remote

$git->remote()

Returns an array of existing remotes

$git = new PHPGit\Git();
$git->clone('https://github.com/kzykhys/Text.git', '/path/to/repo');
$git->setRepository('/path/to/repo');
$remotes = $git->remote();

Output Example

[
    'origin' => [
        'fetch' => 'https://github.com/kzykhys/Text.git',
        'push'  => 'https://github.com/kzykhys/Text.git'
    ]
]

$git->remote->add(string $name, string $url, array $options = [])

Adds a remote named $name for the repository at $url

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->fetch('origin');

Options

tags (boolean) With this option, git fetch <name> imports every tag from the remote repository
no-tags (boolean) With this option, git fetch <name> does not import tags from the remote repository

$git->remote->rename(string $name, string $newName)

Rename the remote named $name to $newName

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->rename('origin', 'upstream');

$git->remote->rm(string $name)

Remove the remote named $name

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->rm('origin');

$git->remote->show(string $name)

Gives some information about the remote $name

$git = new PHPGit\Git();
$git->clone('https://github.com/kzykhys/Text.git', '/path/to/repo');
$git->setRepository('/path/to/repo');
echo $git->remote->show('origin');

Output Example

\* remote origin
  Fetch URL: https://github.com/kzykhys/Text.git
  Push  URL: https://github.com/kzykhys/Text.git
  HEAD branch: master
  Remote branch:
    master tracked
  Local branch configured for 'git pull':
    master merges with remote master
  Local ref configured for 'git push':
    master pushes to master (up to date)

$git->remote->prune(string $name = null)

Deletes all stale remote-tracking branches under $name

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->prune('origin');

$git->remote->head(string $name, string $branch = null)

Alias of set()

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->head('origin');

$git->remote->head->set(string $name, string $branch)

Sets the default branch for the named remote

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->head->set('origin');

$git->remote->head->delete(string $name)

Deletes the default branch for the named remote

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->head->delete('origin');

$git->remote->head->remote(string $name)

Determine the default branch by querying remote

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->head->remote('origin');

$git->remote->branches(string $name, array $branches)

Alias of set()

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->branches('origin', array('master', 'develop'));

$git->remote->branches->set(string $name, array $branches)

Changes the list of branches tracked by the named remote

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->branches->set('origin', array('master', 'develop'));

$git->remote->branches->add(string $name, array $branches)

Adds to the list of branches tracked by the named remote

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->branches->add('origin', array('master', 'develop'));

$git->remote->url(string $name, string $newUrl, string $oldUrl = null, array $options = [])

Alias of set()

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->url('origin', 'https://github.com/text/Text.git');

Options

push (boolean) Push URLs are manipulated instead of fetch URLs

$git->remote->url->set(string $name, string $newUrl, string $oldUrl = null, array $options = [])

Sets the URL remote to $newUrl

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->url->set('origin', 'https://github.com/text/Text.git');

Options

push (boolean) Push URLs are manipulated instead of fetch URLs

$git->remote->url->add(string $name, string $newUrl, array $options = [])

Adds new URL to remote

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->url->add('origin', 'https://github.com/text/Text.git');

Options

push (boolean) Push URLs are manipulated instead of fetch URLs

$git->remote->url->delete(string $name, string $url, array $options = [])

Deletes all URLs matching regex $url

$git = new PHPGit\Git();
$git->setRepository('/path/to/repo');
$git->remote->add('origin', 'https://github.com/kzykhys/Text.git');
$git->remote->url->delete('origin', 'https://github.com');

Options

push (boolean) Push URLs are manipulated instead of fetch URLs

git reset