Manage a Git repository with PHP. Provide an object oriented wrapper to run any Git command.
- PHP >= 5.2 (PHP 5.3 works fine)
- Git >= 1.5
$repo = new phpGitRepo('/path/to/the/git/repo');
It does NOT create a Git repo, but a PHP object to manipulate an existing Git repo.
If the Git repository does not exist yet on filesystem, phpGitRepo can create it for you.
$repo = phpGitRepo::create('/path/to/the/git/repo');
It runs git init
and returns a phpGitRepo object.
git commands can be run with the same syntax as in the CLI. Some examples:
// change current branch to master
$repo->git('checkout master');
// pull from a remote
$repo->git('pull origin master');
// add a remote repo
$repo->git('remote add origin git://github.com/ornicar/php-git-repo.git');
There is no limitation, you can run any git command.
The git() method returns the output string:
echo $repo->git('log --oneline');
e30b70b Move test repo to system tmp dir, introduce phpGitRepoCommand
01fabb1 Add test repo
12a95e6 Add base class with basic unit test
58e7769 Fix readme
c14c9ec Initial commit
The git() method throws a GitRuntimeException if the command is invalid:
$repo->git('wtf'); // this git command does NOT exist: throw GitRuntimeException
Some shortcut methods are provided to deal with branches in a convenient way.
$branches = $repo->getBranches();
// returns array('master', 'other_branch')
$branch = $repo->getCurrentBranch();
// returns 'master'
$hasBranch = $repo->hasBranch('master');
// returns true
$tags = $repo->getTags();
// returns array('first_release', 'v2')
You can get an array of the last commits on the current branch.
$commits = $repo->getCommits(15);
// returns an array of the 15 last commits
Internally, this methods run git log
with formatted output. The return value should look like:
Array
(
[0] => Array
(
[id] => affb0e84a11b4180b0fa0e5d36bdac73584f0d71
[tree] => 4b825dc642cb6eb9a060e54bf8d69288fbee4904
[author] => Array
(
[name] => ornicar
[email] => myemail@gmail.com
)
[authored_date] => 2010-09-22 19:17:35 +0200
[commiter] => Array
(
[name] => ornicar
[email] => myemail@gmail.com
)
[committed_date] => 2010-09-22 19:17:35 +0200
[message] => My commit message
)
[1] => Array
(
...
The first commit is the more recent one.
phpGitRepo
constructor second parameter lets you enable debug mode.
When debug mode is on, commands and their output are displayed.
$repo = new phpGitRepo('/path/to/the/git/repo', true);
phpGitRepo
can be configured by passing an array of options to the constructor third parameter.
You may need to provide the path to the git executable.
$repo = new phpGitRepo('/path/to/the/git/repo', false, array('git_executable' => '/usr/bin/git'));
On most Unix system, it's /usr/bin/git
. On Windows, it may be C:\Program Files\Git\bin
.
By default, phpGitRepo
will use phpGitRepoCommand
class to implement Git commands.
By replacing this option, you can use your own command implementation:
$repo = new phpGitRepo('/path/to/the/git/repo', false, array('command_class' => 'myGitCommand'));
All code is fully unit tested. To run tests on your server, from a CLI, run
php /path/to/php-git-repo/prove.php