PHP Stream Wrapper for Git -Download - PHP Stream Wrapper for Git -Quellcode-Download

PHP Stream Wrapper for Git

Andere Kategorien

3.0.0

Herunterladen

Git Stream Wrapper für PHP

Git Stream Wrapper für PHP ist eine PHP-Bibliothek, die es PHP-Code ermöglicht, innerhalb einer Anwendung mit einem oder mehreren Git-Repositorys zu interagieren. Die Bibliothek besteht aus einer Git-Repository-Abstraktion, die für den programmgesteuerten Zugriff auf Git-Repositorys verwendet werden kann, und aus einem Stream-Wrapper, der in die PHP-Stream-Infrastruktur eingebunden werden kann, um dem Entwickler die Verwendung von Datei- und Verzeichniszugriffsfunktionen direkt auf Dateien in einem Git-Repository zu ermöglichen. Die Bibliothek bietet die Möglichkeit, auf Statusinformationen in einem Git-Repository zuzugreifen, beispielsweise auf das Protokoll, den aktuellen Repository-Status oder Commit-Informationen.

Der Git Stream Wrapper für den PHP- Kern ist ein Wrapper um die Git-Befehlszeilenbinärdatei. Daher muss Git auf dem Computer installiert sein, auf dem der PHP-Code ausgeführt wird. Git Stream Wrapper für PHP enthält keine Git-Protokollabstraktion , sondern ist für seine gesamte Funktionalität auf die Git-Befehlszeilenbinärdatei angewiesen.

Der Code läuft derzeit stabil (siehe Kommentare zu Windows unten) und sollte API-stabil sein. Der Funktionsumfang ist jedoch nicht vollständig. Sie können also jederzeit die gewünschten Funktionen anfordern.

Beispiele

Verwendung der Repository-Abstraktion

 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.
});

Verwendung des Streamwrappers

 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 ();

Anforderungen

PHP >= 8.0.0
Composer verfügbar, um die Abhängigkeiten einzuschließen
Git ist auf dem Computer installiert, auf dem der PHP-Code ausgeführt wird
Wenn Sie die SVN-Komponente verwenden möchten, muss SVN auf dem Computer installiert sein, auf dem der PHP-Code ausgeführt wird

Führen Sie Tests durch

Klonen Sie das Repository
Führen Sie composer install aus, um Abhängigkeiten zu installieren und den Autoloader zu erstellen
Kopieren Sie phpunit.xml.dist nach phpunit.xml
Passen Sie die Konstanten GIT_BINARY , SVN_BINARY und SVN_ADMIN_BINARY in phpunit.xml an den Pfad zu Ihrer Git-Binärdatei an
Führen Sie phpunit aus dem geklonten Projektordner aus

Bitte beachten Sie, dass die Bibliothek auf einem Mac OS Aus derzeit unbekannten Gründen lief der Test unter Windows etwas instabil. Alle Tests sollten grün sein, aber während der Bereinigung besteht möglicherweise die Möglichkeit, dass zufällig einige Zugriffsbeschränkungen wirksam werden und verhindern, dass der Bereinigungscode die Testverzeichnisse entfernt.

Die Unit-Test-Suite wird kontinuierlich mit GitHub Actions auf PHP 8.0, 8.1, 8.2 und 8.3 getestet und hat den aktuellen Status:

Beitragen

Bitte nutzen Sie gerne die Git-Problemverfolgung, um etwaige Probleme oder Fehler zu melden. Wir empfehlen Ihnen, das Repository zu klonen und Pull-Requests zu senden, wenn Sie aktiv an der Entwicklung der Bibliothek mitwirken möchten.

Lizenz

Hiermit wird jeder Person, die eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die „Software“) erhält, kostenlos die Erlaubnis erteilt, mit der Software ohne Einschränkung zu handeln, einschließlich und ohne Einschränkung der Rechte zur Nutzung, zum Kopieren, Ändern und Zusammenführen , Kopien der Software zu veröffentlichen, zu verteilen, unterzulizenzieren und/oder zu verkaufen und Personen, denen die Software zur Verfügung gestellt wird, dies zu gestatten, vorbehaltlich der folgenden Bedingungen:

Der obige Urheberrechtshinweis und dieser Genehmigungshinweis müssen in allen Kopien oder wesentlichen Teilen der Software enthalten sein.

DIE SOFTWARE WIRD „WIE BESEHEN“ ZUR VERFÜGUNG GESTELLT, OHNE JEGLICHE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG, EINSCHLIESSLICH, ABER NICHT BESCHRÄNKT AUF DIE GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND NICHTVERLETZUNG. IN KEINEM FALL SIND DIE AUTOREN ODER COPYRIGHT-INHABER HAFTBAR FÜR JEGLICHE ANSPRÜCHE, SCHÄDEN ODER ANDERE HAFTUNG, WEDER AUS EINER VERTRAGLICHEN HANDLUNG, AUS unerlaubter Handlung ODER ANDERWEITIG, DIE SICH AUS, AUS ODER IN ZUSAMMENHANG MIT DER SOFTWARE ODER DER NUTZUNG ODER ANDEREN HANDELN IN DER SOFTWARE ERGEBEN SOFTWARE.

Expandieren

Zusätzliche Informationen