library git-wrapper

carrlabs/git-wrapper

A wrapper for the git command line executable, based on YiiGit (https://github.com/phpnode/YiiGit). Allows access to all git commands via a simple object oriented interface.

Introduction

A wrapper for the git command line executable, based on YiiGit. Allows access to all git commands via a simple object oriented interface., _(*1)

Usage examples

Add some files and folders to git, _(*2)

$repository = new \CarrLabs\GitWrapper\GitRepository('path/to/your/git/repo');
$repository->add('somefile.txt');
$repository->add('somedirectory');

Commit some files with git, _(*3)

$repository->commit('Added some files');

Checkout an existing branch, _(*4)

$repository->checkout('some-existing-branch');
echo $repository->getActiveBranch()->name; // some-existing-branch

Checkout a new branch, _(*5)

$repository->checkout('some-new-branch', TRUE);
echo $repository->getActiveBranch()->name; // some-new-branch

List all branches, _(*6)

foreach($repository->getBranches() as $branch)
{
    echo $branch->name . "\n";
}

List all tags with metadata, _(*7)

foreach($repository->getTags() as $tag)
{
    echo $tag->name . "\n";
    echo $tag->getAuthorName() . "\n";
    echo $tag->getAuthorEmail() . "\n";
    echo $tag->getMessage() . "\n";
}

List all the commits on the current branch, _(*8)

foreach($repository->getActiveBranch()->getCommits() as $commit)
{
    echo $commit->getAuthorName() . ' at ' . $commit->getTime() . "\n";
    echo $commit->getMessage() . "\n";
    echo str_repeat('-', 50) . "\n";
}

List all the files affected by the latest commit, _(*9)

foreach($repository->getActiveBranch()->getLastCommit()->getFiles() as $file)
{
    echo $file . "\n";
}

Check if a tag exists on the default remote ('origin'), _(*10)

$repository->getRemote()->hasTag('myTag');

List all branches on a remote repository called 'upstream', _(*11)

foreach($repository->getRemote('upstream')->getBranches() as $branch)
{
    echo $branch . "\n";
}

API

\CarrLabs\GitWrapper\GitRepository, _(*12)

setPath($path, $createIfEmpty = false, $initialize = false)
getPath()
run($command)
add($file)
rm($file, $force = false)
commit($message = null, $addFiles = false, $amend = false)
status()
describe($options = '')
checkout($branchName, $create = false, $force = false)
clean($deleteDirectories = false, $force = false)
cloneTo($targetDirectory)
cloneFrom($targetDirectory)
cloneRemote($sourceUrl)
push($remote, $branch = "master", $force = false)
fetch($repository)
getActiveBranch()
getBranches()
hasBranch($branch)
createBranch($branchName)
deleteBranch($branchName, $force = false)
getCommit($hash)
getTags()
getTag($name)
hasTag($tag)
addTag($name, $message, $hash = null)
removeTag($tag)
getRemotes()
getRemote($remote = null)
hasCommit($hash)

\CarrLabs\GitWrapper\GitCommit, _(*13)

getAuthorName()
getAuthorEmail()
getTime()
getSubject()
getMessage()
getNotes()
getParents()
getFiles()

\CarrLabs\GitWrapper\GitBranch, _(*14)

getCommits()
getCommit($hash)
getLastCommit()

\CarrLabs\GitWrapper\GitTag, _(*15)

push($remote = null)
getAuthorName()
getAuthorEmail()
getMessage()
getCommit()

\CarrLabs\GitWrapper\GitRemote, _(*16)

getBranches()
hasBranch($branch)
deleteBranch($branchName)
getTags()
hasTag($tag)