PHP Stream Wrapper for Git下载 - PHP Stream Wrapper for Git源代码下载

PHP Stream Wrapper for Git

其他类别

3.0.0

下载

PHP 的 Git 流包装器

Git Stream Wrapper for PHP是一个 PHP 库，允许 PHP 代码与应用程序内的一个或多个 Git 存储库进行交互。该库由一个 Git 存储库抽象组成，可用于以编程方式访问 Git 存储库，还包含一个流包装器，可连接到 PHP 流基础设施，以允许开发人员直接对 Git 存储库中的文件使用文件和目录访问功能。该库提供了访问 Git 存储库状态信息的方法，例如日志、当前存储库状态或提交信息。

PHP 核心的 Git Stream Wrapper是 Git 命令行二进制文件的包装器，因此需要在运行 PHP 代码的计算机上安装 Git。 PHP 的 Git Stream Wrapper不包含 Git 协议抽象，它的所有功能都依赖于 Git 命令行二进制文件。

该代码当前运行稳定（请参阅下面 Windows 上的注释）并且应该是 API 稳定的。但它的功能并不完整 - 因此请随时请求您需要的功能。

示例

使用存储库抽象

 use TQ  Git  Repository  Repository ;
// open an already initialized repository
$ git = Repository:: open ( ' /path/to/your/repository ' , ' /usr/bin/git ' );

// open repository and create path and init repository if necessary
$ git = Repository:: open ( ' /path/to/your/repository ' , ' /usr/bin/git ' , 0755 );

// get current branch
$ branch = $ git -> getCurrentBranch ();

// get status of working directory
$ status = $ git -> getStatus ();
// are there uncommitted changes in the staging area or in the working directory
$ isDirty = $ git -> isDirty ();

// retrieve the commit log limited to $limit entries skipping the first $skip
$ log = $ git -> getLog ( $ limit , $ skip );

// retrieve the second to last commit
$ commit = $ git -> showCommit ( ' HEAD^ ' );

// list the directory contents two commits before
$ list  = $ git -> listDirectory ( ' . ' , ' HEAD^^ ' );

// show contents of file $file at commit abcd123...
$ contents = $ git -> showFile ( $ file , ' abcd123 ' );

// write a file and commit the changes
$ commit = $ git -> writeFile ( ' test.txt ' , ' Test ' , ' Added test.txt ' );

// remove multiple files
$ commit = $ git -> removeFile ( ' file_* ' , ' Removed all files not needed any more ' );

// rename a file
$ commit = $ c -> renameFile ( ' test.txt ' , ' test.txt-old ' , ' Made a backup copy ' );

// do some file operations and commit all changes at once
$ result = $ git -> transactional ( function ( TQ  Vcs  Repository  Transaction $ t ) {
    file_put_contents ( $ t -> getRepositoryPath (). ' /text1.txt ' , ' Test 1 ' );
    file_put_contents ( $ t -> getRepositoryPath (). ' /text2.txt ' , ' Test 2 ' );

    unlink ( $ t -> resolvePath ( ' old.txt ' ));
    rename ( $ t -> resolvePath ( ' to_keep.txt ' ), $ t -> resolvePath ( ' test3.txt ' ));

    $ t -> setCommitMsg ( ' Don ' t know what to write here ' );

    // if we throw an exception from within the callback the changes are discarded
    // throw new Exception('No we don't want to make these changes');
    // note: the exception will be re-thrown by the repository so you have to catch
    // the exception yourself outside the transactional scope.
});

使用流包装器

 use TQ  Git  StreamWrapper  StreamWrapper ;

// register the wrapper
StreamWrapper:: register ( ' git ' , ' /usr/bin/git ' );

// read the contents of a file
$ content = file_get_contents ( ' git:///path/to/your/repository/file_0.txt ' );

// show contents of a file at commit abcd123...
$ content = file_get_contents ( ' git:///path/to/your/repository/file_0.txt#abcd123 ' );

// show contents of a file two commits before
$ content = file_get_contents ( ' git:///path/to/your/repository/file_0.txt#HEAD^^ ' );

// show the directory information two commits before
$ directory = file_get_contents ( ' git:///path/to/your/repository/#HEAD^^ ' );

// list directory contents two commits before
$ dir = opendir ( ' git:///path/to/your/repository/subdir#HEAD^^ ' );
while ( $ f = readdir ( $ dir )) {
    echo $ f . PHP_EOL ;
}
closedir ( $ dir );

// recursively traverse the repository two commits before
$ dir = new RecursiveDirectoryIterator ( ' git:///path/to/your/repository#HEAD^^ ' );
$ it  = new RecursiveIteratorIterator ( $ dir , RecursiveIteratorIterator:: SELF_FIRST );
foreach ( $ it as $ fileInfo ) {
    echo str_repeat ( ' ' , $ it -> getDepth () * 3 ). $ fileInfo -> getFilename (). PHP_EOL ;
}

// retrieve the second to last commit
$ commit = file_get_contents ( ' git:///path/to/your/repository?commit&ref=HEAD^^ ' );

// retrieve the commit log limited to 5entries skipping the first 2
$ log = file_get_contents ( ' git:///path/to/your/repository?log&limit=5&skip=2 ' );

// remove a file - change is committed to the repository
unlink ( ' git:///path/to/your/repository/file_to_delete.txt ' );

// rename a file - change is committed to the repository
rename ( ' git:///path/to/your/repository/old.txt ' , ' git:///path/to/your/repository/new.txt ' );

// remove a directory - change is committed to the repository
rmdir ( ' git:///path/to/your/repository/directory_to_delete ' );

// create a directory - change is committed to the repository
// this creates a .gitkeep file in new_directory because Git does not track directories
mkdir ( ' git:///path/to/your/repository/new_directory ' );

// write to a file - change is committed to the repository when file is closed
$ file = fopen ( ' git:///path/to/your/repository/test.txt ' , ' w ' );
fwrite ( $ file , ' Test ' );
fclose ( $ file );

// support for stream context
$ context = stream_context_create ( array (
    ' git '   => array (
        ' commitMsg ' => ' Hello World ' ,
        ' author '    => ' Luke Skywalker <[email protected]> '
    )
));
$ file = fopen ( ' git:///path/to/your/repository/test.txt ' , ' w ' , false , $ context );
fwrite ( $ file , ' Test ' );
fclose ( $ file ); // file gets committed with the preset commit message and author

// append to a file using file_put_contents using a custom author and commit message
$ context = stream_context_create ( array (
    ' git '   => array (
        ' commitMsg ' => ' Hello World ' ,
        ' author '    => ' Luke Skywalker <[email protected]> '
    )
));
file_put_contents ( ' git:///path/to/your/repository/test.txt ' , ' Test ' , FILE_APPEND , $ context );

// it is now possible to register repository-specific paths on the stream wrapper
StreamWrapper:: getRepositoryRegistry ()-> addRepositories (
    array (
        ' repo1 ' => Repository:: open ( ' /path/to/repository/1 ' , ' /usr/bin/git ' , false ),
        ' repo2 ' => Repository:: open ( ' /path/to/repository/2 ' , ' /usr/bin/git ' , false ),
    )
);
$ content1 = file_get_contents ( ' git://repo1/file_0.txt ' );
$ content2 = file_get_contents ( ' git://repo2/file_0.txt ' );

// unregister the wrapper if needed
StreamWrapper:: unregister ();

要求

PHP >= 8.0.0
Composer 可用于包含依赖项
Git 安装在运行 PHP 代码的机器上
如果要使用 SVN 组件，请在运行 PHP 代码的计算机上安装 SVN

运行测试

克隆存储库
运行composer install来安装依赖项并创建自动加载器
将phpunit.xml.dist复制到phpunit.xml
将phpunit.xml中的GIT_BINARY 、 SVN_BINARY和SVN_ADMIN_BINARY常量调整为 Git 二进制文件的路径
从克隆的项目文件夹中运行phpunit

请注意，该库已在捆绑 PHP 8.0.27、8.1.14 和 8.2.1（git 版本 2.39.1）的 Mac OS X 12.6 以及多个 Ubuntu Linux 安装上进行了测试。由于目前未知的原因，测试在 Windows 上运行有点不稳定。所有测试都应该是绿色的，但在清理过程中，可能会出现一些访问限制随机启动并阻止清理代码删除测试目录的可能性。

单元测试套件在 PHP 8.0、8.1、8.2 和 8.3 上使用 GitHub Actions 进行持续测试，当前状态为：