PHP Stream Wrapper for Git
3.0.0
Git Stream Wrapper สำหรับ PHP เป็นไลบรารี PHP ที่อนุญาตให้โค้ด PHP โต้ตอบกับที่เก็บ Git หนึ่งหรือหลายรายการจากภายในแอปพลิเคชัน ไลบรารีประกอบด้วยนามธรรมที่เก็บ Git ที่สามารถใช้เพื่อเข้าถึงที่เก็บ Git โดยทางโปรแกรมและ wrapper สตรีมที่สามารถเชื่อมต่อกับโครงสร้างพื้นฐานสตรีม PHP เพื่อให้นักพัฒนาสามารถใช้ฟังก์ชันการเข้าถึงไฟล์และไดเร็กทอรีกับไฟล์ในที่เก็บ Git ได้โดยตรง ไลบรารีจัดเตรียมวิธีการเข้าถึงข้อมูลสถานะบนที่เก็บ Git เช่น บันทึก สถานะที่เก็บปัจจุบัน หรือส่งข้อมูลเช่นกัน
Git Stream Wrapper สำหรับแกน PHP เป็นตัวหุ้มรอบไบนารีบรรทัดคำสั่ง Git ดังนั้นจึงจำเป็นต้องติดตั้ง Git บนเครื่องที่ใช้โค้ด PHP Git Stream Wrapper สำหรับ PHP ไม่รวม Git protocol abstraction มันอาศัยไบนารีบรรทัดคำสั่ง 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 ();composer install เพื่อติดตั้งการพึ่งพาและสร้างตัวโหลดอัตโนมัติphpunit.xml.dist ไปยัง phpunit.xmlGIT_BINARY , SVN_BINARY และ SVN_ADMIN_BINARY ใน phpunit.xml ไปยังเส้นทางไปยังไบนารี Git ของคุณphpunit จากภายในโฟลเดอร์โครงการที่โคลนโปรดทราบว่าไลบรารีได้รับการทดสอบบน Mac OS X 12.6 พร้อมด้วย PHP 8.0.27, 8.1.14 และ 8.2.1 (git เวอร์ชัน 2.39.1) ที่แถมมาให้ และบนการติดตั้ง Ubuntu Linux หลายตัว เนื่องจากเหตุผลที่ไม่ทราบสาเหตุในขณะนี้ การทดสอบจึงทำงานไม่เสถียรเล็กน้อยบน Windows การทดสอบทั้งหมดควรเป็น สีเขียว แต่ในระหว่างการล้างข้อมูล อาจมีความเป็นไปได้ที่ข้อจำกัดการเข้าถึงบางอย่างจะสุ่มเข้ามาและป้องกันไม่ให้โค้ดการล้างข้อมูลลบไดเร็กทอรีการทดสอบ
ชุดทดสอบหน่วยได้รับการทดสอบอย่างต่อเนื่องด้วย GitHub Actions บน PHP 8.0, 8.1, 8.2 และ 8.3 และสถานะปัจจุบันคือ:
โปรดใช้การติดตามปัญหา Git เพื่อรายงานปัญหาหรือข้อผิดพลาดกลับมา ขอแนะนำให้คุณโคลนพื้นที่เก็บข้อมูลและส่งคำขอดึงข้อมูลหากคุณต้องการมีส่วนร่วมอย่างจริงจังในการพัฒนาไลบรารี
ลิขสิทธิ์ (C) 2023 โดย TEQneers GmbH & Co. KG
อนุญาตให้บุคคลใดก็ตามที่ได้รับสำเนาของซอฟต์แวร์นี้และไฟล์เอกสารที่เกี่ยวข้อง ("ซอฟต์แวร์") อนุญาตโดยไม่เสียค่าใช้จ่าย เพื่อจัดการกับซอฟต์แวร์โดยไม่มีข้อจำกัด รวมถึงแต่ไม่จำกัดเพียงสิทธิ์ในการใช้ คัดลอก ปรับเปลี่ยน ผสาน เผยแพร่ แจกจ่าย ให้อนุญาตช่วง และ/หรือขายสำเนาของซอฟต์แวร์ และอนุญาตให้บุคคลที่ได้รับซอฟต์แวร์นี้สามารถทำได้ ภายใต้เงื่อนไขต่อไปนี้:
ประกาศเกี่ยวกับลิขสิทธิ์ข้างต้นและประกาศการอนุญาตนี้จะรวมอยู่ในสำเนาทั้งหมดหรือส่วนสำคัญของซอฟต์แวร์
ซอฟต์แวร์นี้มีให้ "ตามที่เป็น" โดยไม่มีการรับประกันใดๆ ทั้งโดยชัดแจ้งหรือโดยนัย ซึ่งรวมถึงแต่ไม่จำกัดเพียงการรับประกันความสามารถในการค้าขาย ความเหมาะสมสำหรับวัตถุประสงค์เฉพาะ และการไม่ละเมิด ไม่ว่าในกรณีใดผู้เขียนหรือผู้ถือลิขสิทธิ์จะต้องรับผิดต่อการเรียกร้องค่าเสียหายหรือความรับผิดอื่นใดไม่ว่าในการกระทำของสัญญาการละเมิดหรืออย่างอื่นที่เกิดขึ้นจากหรือเกี่ยวข้องกับซอฟต์แวร์หรือการใช้งานหรือข้อตกลงอื่น ๆ ใน ซอฟต์แวร์.
