Name Mode Size
lib 040000
tests 040000
.gitignore 100644 0 kb
.travis.yml 100644 0 kb
LICENSE 100644 1 kb
README.md 100644 2 kb
composer.json 100644 1 kb
composer.lock 100644 30 kb
phpunit.xml.dist 100755 1 kb
README.md
# Gitter [![Build Status](https://secure.travis-ci.org/klaussilveira/gitter.png)](http://travis-ci.org/klaussilveira/gitter) Gitter allows you to interact in an object oriented manner with Git repositories via PHP. The main goal of the library is not to replace the system `git` command, but provide a coherent, stable and performatic object oriented interface. Most commands are sent to the system's `git` command, parsed and then interpreted by Gitter. Everything is transparent to you, so you don't have to worry about a thing. ## Requirements * git (http://git-scm.com) (tested with 1.7.5.4) ## Authors and contributors * [Klaus Silveira](http://www.klaussilveira.com) (Creator, developer) ## License [New BSD license](http://www.opensource.org/licenses/bsd-license.php) ## Usage Gitter is very easy to use and you'll just need a few method calls to get started. For example, to create a new repository: $client = new Gitter\Client; $repository = $client->createRepository('/home/user/test'); Or a bare repository: $client = new Gitter\Client; $repository = $client->createRepository('/home/user/test', true); Or to open an existing repository: $client = new Gitter\Client; $repository = $client->getRepository('/home/user/anothertest'); Both methods will return a `Repository` object, which has various methods that allow you to interact with that repository. ### Getting a list of commits Once you get hold of the `Repository` object, you can use: $commits = $repository->getCommits(); print_r($commits); To get a list of various commits. ### Getting a single commit Given a specific commit hash, you can find information about that commit: $commit = $repository->getCommit('920be98a05'); print_r($commit); ### Getting statistics for repository Statistics aggregators can be added to the repository: $repository->addStatistics(array( new Gitter\Statistics\Contributors, new Gitter\Statistics\Date, new Gitter\Statistics\Day, new Gitter\Statistics\Hour )); print_r($repository->getStatistics());