PHP Classes

PHP Git Library Provider: Manipulate Git repositories using the git command

Recommend this page to a friend!
     
  Info   View files Example   View files View files (18)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2024-01-10 (3 days ago) RSS 2.0 feedNot enough user ratingsTotal: 147 This week: 1All time: 9,095 This week: 348Up
Version License PHP version Categories
git-provider 0.11BSD License5.4PHP 5, Files and Folders, Project Man...
Description 

Author

Maik Greubel

This class is a wrapper around the git command to manipulate Git repositories.

It can execute the git command to execute several types of operations with Git repositories. Currently it can:

- Create a repository
- Set the repository name and author
- Check if repository files are staged
- Commit changed files
- Remove files from the repository
- Clone repository from given URL
- Check if a repository is empty
- Check if a branch name exists
- Push changes to the origin repository
- Pull changes from an origin repository
- Create branch
- Checkout branch

Picture of Maik Greubel
  Performance   Level  
Name: Maik Greubel <contact>
Classes: 10 packages by
Country: Germany Germany

Level 4 StarStarStarStar

 Innovation award
Innovation award
Nominee: 4x

Example

<?php
use Nkey\GitProvider\GitProvider;

set_include_path(get_include_path() . PATH_SEPARATOR . __DIR__ . "/../src" . PATH_SEPARATOR . __DIR__ . "/../vendor");

require 'autoload.php';

try {
    // Create a provider instance
    $bare = new GitProvider("./test.git");

    // Create a bare repository
    $bare->create(true, true);

    // Set the project name
    $bare->setProjectName("This is only a test repository");

    // Now we can clone it...

    // First create a provider for the workspace repository
    $workspace = new GitProvider("./test-workspace");
    // Clone the bare repository
    $workspace->cloneFrom($bare->getPath());
    // First set author to be able to commit
    $workspace->setAuthor("John Doe", "john@doe.tld");

    // Add some crucial data to workspace
    $fd = fopen($workspace->getPath() . "/I-am-some-stupid-file.txt", "w");
    if ($fd) {
        fputs($fd, "Hello repository", 16);
        fflush($fd);
        fclose($fd);
    }

    // Add the crucial data to index
    $workspace->addToIndex("*.txt");

    // Commit the changes
    $workspace->commit("Added some super mandatory file with high security content!");

    // Push everything back to origin
    $workspace->push();

    // If you want you can destroy it...
    // $workspace->destroy();
    // $bare->destroy();
    // Or you examine the folders test.git and test-workspace inside example folder
    // using regular git commands to check if everything has worked as expected.
} catch (GitProviderException $ex) {
    echo $ex->getMessage();
    echo "\n";
    echo $ex->getTraceAsString();
}

Details

Build Status Coverage Status

phpGitProvider

This package provides an easy to use git client class for PHP. Here a small example to show the features:

$path = "/path/to/where/you/want/to/work/on/your/repo";

$provider = new GitProvider($path);

// Create a shared bare repository
$provider->create(true, true);
// Set the author of the repo
$provider->setAuthor("John Doe", "john@doe.tld");
// Provide a project name
$provider->setProjectName('A test repository');

// Some data to repository (file must exist)
$provider->addToIndex("README.md");

// Commit your changes with a speaking message
$provider->commit("Added README");

  Files folder image Files  
File Role Description
Files folder imagecontrib (2 files)
Files folder imageexample (2 files)
Files folder imagesrc (2 files)
Files folder imagetests (1 directory)
Accessible without login Plain text file .gitignore Data git ignore configuration
Accessible without login Plain text file .travis.yml Data Travis Ci configuration
Accessible without login Plain text file build.xml Data Ant build script
Accessible without login Plain text file composer.json Data Composer control file
Accessible without login Plain text file LICENSE Lic. License
Accessible without login Plain text file phpcs.xml Data PHP Codesniffer configuration
Accessible without login Plain text file phpdox.xml Data phpdox configuration
Accessible without login Plain text file phpmd.xml Data PHP Messdetection configuration
Accessible without login Plain text file phpunit.xml Data PHPUnit configuration
Accessible without login Plain text file README.md Data Readme

  Files folder image Files  /  contrib  
File Role Description
  Accessible without login Plain text file phpcs.xsd Data Contributed schema for code sniffer configuration
  Accessible without login Plain text file phpunit.xsd Data Contributed schema for phpunit configuration

  Files folder image Files  /  example  
File Role Description
  Accessible without login Plain text file .gitignore Data git ignore
  Accessible without login Plain text file basic-example.php Example Basic example

  Files folder image Files  /  src  
File Role Description
  Accessible without login Plain text file GitProvider.php Class The main class
  Accessible without login Plain text file GitProviderException.php Class Derived exception

  Files folder image Files  /  tests  
File Role Description
Files folder imageprovider-tests (2 files)

  Files folder image Files  /  tests  /  provider-tests  
File Role Description
  Accessible without login Plain text file FailureTest.php Test Unit test
  Accessible without login Plain text file GitProviderTest.php Test Unit test

Downloadgit-provider-2024-01-10.zip 15KB
Downloadgit-provider-2024-01-10.tar.gz 11KB
Install with ComposerInstall with Composer
Needed packages  
Class DownloadWhy it is needed Dependency
PHP Generics Download .zip .tar.gz Several general purpose classes such as Directory and logging exists already there Required
 Version Control Unique User Downloads Download Rankings  
 100%
Total:147
This week:1
All time:9,095
This week:348Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.


  Related pages  
Dynamic generated API documentation
Unit test code coverage statistics