GitElephant
An abstraction layer for git written in PHP
Install / Use
/learn @matteosister/GitElephantREADME
GitElephant is an abstraction layer to manage your git repositories with php
This library officially supports git >= 1.8, older version are supported as well, but with some caveat.
How it works
GitElephant mostly rely on the git binary to retrieve information about the repository, read the output and create an OOP layer to interact with
Some parts are (or will be) implemented by reading directly inside the .git folder
The api is completely transparent to the end user. You don't have to worry about which method is used.
Requirements
- php >=
7.2 - *nix system with git installed
*For php 7.1, please use GitElephant version 3.x
*For php 7.0, please use GitElephant version 2.x
*For php 5.x please use GitElephant version 1.x
This library is tested on linux, but it should work well with any unix system, as far as a git binary is available. For windows support, well.. if someone want to help?!
Installation
composer
To install GitElephant with composer you simply need to create a composer.json in your project root and add:
{
"require": {
"cypresslab/gitelephant": "~4.0"
}
}
Then run
$ curl -s https://getcomposer.org/installer | php
$ composer install
You have now GitElephant installed in vendor/cypresslab/gitelephant
And an handy autoload file to include in you project in vendor/autoload.php
How to use
use GitElephant\Repository;
$repo = new Repository('/path/to/git/repository');
// or the factory method
$repo = Repository::open('/path/to/git/repository');
By default GitElephant try to use the git binary on your system.
the Repository class is the main class where you can find every method you need...
Read repository
// get the current status
$repo->getStatusOutput(); // returns an array of lines of the status message
branches
$repo->getBranches(); // return an array of Branch objects
$repo->getMainBranch(); // return the Branch instance of the current checked out branch
$repo->getBranch('master'); // return a Branch instance by its name
$develop = Branch::checkout($repo, 'develop');
$develop = Branch::checkout($repo, 'develop', true); // create and checkout
tags
$repo->getTags(); // array of Tag instances
$repo->getTag('v1.0'); // a Tag instance by name
Tag::pick($repo, 'v1.0'); // a Tag instance by name
// last tag by date
$repo->getLastTag();
commits
$repo->getCommit(); // get a Commit instance of the current HEAD
$repo->getCommit('v1.0'); // get a Commit instance for a tag
$repo->getCommit('1ac370d'); // full sha or part of it
// or directly create a commit object
$commit = new Commit($repo, '1ac370d');
$commit = new Commit($repo, '1ac370d'); // head commit
// count commits
$repo->countCommits('1ac370d'); // number of commits to arrive at 1ac370d
// commit is countable, so, with a commit object, you can do
$commit->count();
// as well as
count($commit);
remotes
$repo->getRemote('origin'); // a Remote object
$repo->getRemotes(); // array of Remote objects
// Log contains a collection of commit objects
// syntax: getLog(<tree-ish>, path = null, limit = 15, offset = null)
$log = $repo->getLog();
$log = $repo->getLog('master', null, 5);
$log = $repo->getLog('v0.1', null, 5, 10);
// or directly create a log object
$log = new Log($repo);
$log = new Log($repo, 'v0.1', null, 5, 10);
// countable
$log->count();
count($log);
// iterable
foreach ($log as $commit) {
echo $commit->getMessage();
}
status
If you build a GitElephant\Status\Status class, you will get a nice api for getting the actual state of the working tree and staging area.
$status = $repo->getStatus();
$status = GitElephant\Status\Status::get($repo); // it's the same...
$status->all(); // A Sequence of StatusFile objects
$status->untracked();
$status->modified();
$status->added();
$status->deleted();
$status->renamed();
$status->copied();
all this methods returns a Sequence of StatusFile objects, credit to PhpCollection
a StatusFile instance has all the information about the tree node changes. File names (and new file names for renamed objects), index and working tree status, and also a "git style" description like: added to index or deleted in work tree
Manage repository
You could also use GitElephant to manage your git repositories via PHP.
Your web server user (like www-data) needs to have access to the folder of the git repository
$repo->init(); // init
$repo->cloneFrom("git://github.com/matteosister/GitElephant.git"); // clone
// stage changes
$repo->stage('file1.php');
$repo->stage(); // stage all
// commit
$repo->commit('my first commit');
$repo->commit('my first commit', true); // commit and stage every pending changes in the working tree
// remotes
$repo->addRemote('awesome', 'git://github.com/matteosister/GitElephant.git');
// checkout
$repo->checkout($repo->getTag('v1.0')); // checkout a tag
$repo->checkout('master'); // checkout master
// manage branches
$repo->createBranch('develop'); // create a develop branch from current checked out branch
$repo->createBranch('develop', 'master'); // create a develop branch from master
$repo->deleteBranch('develop'); // delete the develop branch
$repo->checkoutAllRemoteBranches('origin'); // checkout all the branches from the remote repository
// manage tags
// create a tag named v1.0 from master with the given tag message
$repo->createTag('v1.0', 'master', 'my first release!');
// create a tag named v1.0 from the current checked out branch with the given tag message
$repo->createTag('v1.0', null, 'my first release!');
// create a tag from a Commit object
$repo->createTag($repo->getCommit());
Remote repositories
If you need to access remote repository you have to install the ssh2 extension and pass a new Caller to the repository. this is a new feature...consider this in a testing phase
$repo = new Repository('/path/to/git/repository');
$connection = ssh_connect('host', 'port');
// authorize the connection with the method you want
ssh2_auth_password($connection, 'user', 'password');
$caller = new CallerSSH2($connection, '/path/to/git/binary/on/server');
$repo = Repository::open('/path/to/git/repository');
$repo->setCaller($caller);
A versioned tree of files
A git repository is a tree structure versioned in time. So if you need to represent a repository in a, let's say, web browser, you will need a tree representation of the repository, at a given point in history.
Tree class
$tree = $repo->getTree(); // retrieve the actual *HEAD* tree
$tree = $repo->getTree($repo->getCommit('1ac370d')); // retrieve a tree for a given commit
$tree = $repo->getTree('master', 'lib/vendor'); // retrieve a tree for a given path
// generate a tree
$tree = new Tree($repo);
The Tree class implements ArrayAccess, Countable and Iterator interfaces.
You can use it as an array of git objects.
foreach ($tree as $treeObject) {
echo $treeObject;
}
A Object instance is a php representation of a node in a git tree
echo $treeObject; // the name of the object (folder, file or link)
$treeObject->getType(); // one class constant of Object::TYPE_BLOB, Object::TYPE_TREE and Object::TYPE_LINK
$treeObject->getSha();
$treeObject->getSize();
$treeObject->getName();
$treeObject->getSize();
$treeObject->getPath();
You can also pass a tree object to the repository to get its subtree
$subtree = $repo->getTree('master', $treeObject);
Diffs
If you want to check a Diff between two commits the Diff class comes in
// get the diff between the given commit and it parent
$diff = $repo->getDiff($repo->getCommit());
// get the diff between two commits
$diff = $repo->getDiff($repo->getCommit('1ac370d'), $repo->getCommit('8fb7281'));
// same as before for a given path
$diff = $repo->getDiff($repo->getCommit('1ac370d'), $repo->getCommit('8fb7281'), 'lib/vendor');
// or even pass a Object
$diff = $repo->getDiff($repo->getCommit('1ac370d'), $repo->getCommit('8fb7281'), $treeObject);
// alternatively
