Läsa repositorier

Visa som Markdown Redigera på GitHub Dokumentation på bfe242f

Pitmaster läser git-repositorier genom att tolka formaten på disk direkt: lösa objekt (zlib-komprimerade filer i .git/objects/), packfiler (.git/objects/pack/), refs (filer i .git/refs/ och packed-refs) och indexet (.git/index).

Öppna ett repository

PHP

use Pitmaster\Pitmaster;

$repo = Pitmaster::open('/path/to/project');

Pitmaster stöder tre repository-layouter:

Vanliga repositorier: .git är en katalog i projektroten.
Länkade arbetsträd: .git är en fil som innehåller gitdir: <path> som pekar på .git/worktrees/<name>/.
Bare-repositorier: själva sökvägen innehåller HEAD, objects/ osv.

PHP

// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Läsa objekt

Varje datadel i ett git-repository lagras som ett objekt som identifieras med sin hash: SHA-1 (40 hextecken) som standard, eller SHA-256 (64 hextecken) i repositorier som skapats med Pitmaster::init($path, 'sha256'). Det finns fyra objekttyper: blob, träd, incheckning och tagg.

Hashmetoderna nedan kräver hela hexhashen; förkortade hashvärden accepteras inte.

readObject

PHP

use Pitmaster\Object\Blob;
use Pitmaster\Object\Tree;
use Pitmaster\Object\Commit;
use Pitmaster\Object\Tag;

$object = $repo->readObject('a1b2c3d4e5f6...');

match (true) {
    $object instanceof Blob   => handleBlob($object),
    $object instanceof Tree   => handleTree($object),
    $object instanceof Commit => handleCommit($object),
    $object instanceof Tag    => handleTag($object),
};

Objekt söks först i den lösa lagringen och därefter i packfiler. Vid sökning i packfiler används .idx-fanouttabellen för binärsökning i O(log n).

catFile

För enkel hämtning av innehåll utan typkontroll:

PHP

$content = $repo->catFile('a1b2c3d4e5f6...');
echo $content;

objectExists

PHP

if ($repo->objectExists('a1b2c3d4e5f6...')) {
    // Object is in the repository
}

listObjects

PHP

$hashes = $repo->listObjects();
// ['a1b2c3d4...', 'f6e5d4c3...', ...]

Returnerar hexhashar för alla objekt (lösa och packade).

Arbeta med blobbar

En blob innehåller rått filinnehåll.

PHP

$blob = $repo->readObject($hash);
echo $blob->content;     // Raw file bytes
echo $blob->size();      // Content length
echo $blob->id->hex;     // Object hash

Arbeta med träd

Ett träd är en kataloglista. Varje post har ett läge, ett namn och en hash.

PHP

$tree = $repo->readObject($hash);

foreach ($tree->entries as $entry) {
    echo "{$entry->mode} {$entry->name} {$entry->hash->hex}\n";
    // 100644 README.md abc123...
    // 40000 src def456...
    // 100755 deploy.sh 789012...

    if ($entry->isTree()) {
        // Recurse into subdirectory (mode 40000)
    } elseif ($entry->isExecutable()) {
        // Executable file (mode 100755)
    } elseif ($entry->isBlob()) {
        // Regular file (any 10xxxx mode, so executables match too)
    } elseif ($entry->isSymlink()) {
        // Symbolic link (mode 120000)
    } elseif ($entry->isGitlink()) {
        // Submodule (mode 160000)
    }
}

Arbeta med incheckningar

En incheckning länkar en trädögonblicksbild till dess föräldrar och metadata.

PHP

$commit = $repo->head();

echo $commit->id->hex;      // Full object hash
echo $commit->tree->hex;    // Tree object hash
echo $commit->author;       // "Name <email> timestamp tz"
echo $commit->committer;    // "Name <email> timestamp tz"
echo $commit->message;      // Full commit message

// Parent commits
foreach ($commit->parents as $parentId) {
    $parent = $repo->readObject($parentId->hex);
}

// Merge detection
if ($commit->isMerge()) {
    // Two or more parents
}

Arbeta med taggar

Annoterade taggar är objekt med ett mål, en typ, ett namn, en taggare och ett meddelande.

PHP

$tag = $repo->readObject($hash);

echo $tag->object->hex;           // Target object hash
echo $tag->objectType->value;     // 'commit', 'tree', 'blob', or 'tag'
echo $tag->name;            // Tag name
echo $tag->tagger;          // "Name <email> timestamp tz"
echo $tag->message;         // Tag message

Läsa refs

Aktuell HEAD

PHP

$commit = $repo->head();

Slår upp HEAD (följer symboliska refs som HEAD -> refs/heads/main -> commit hash) och returnerar incheckningsobjektet.

Aktuell gren

PHP

$branch = $repo->branch();  // 'main' or null if detached

Lista grenar och taggar

PHP

$branches = $repo->branches();  // ['bugfix/typo', 'feature/login', 'main']
$tags = $repo->tags();          // ['v1.0.0', 'v1.1.0']

Alla refs

PHP

$refs = $repo->allRefs();
// [
//     'refs/heads/main' => 'abc123...',
//     'refs/heads/feature' => 'def456...',
//     'refs/tags/v1.0.0' => '789012...',
//     'refs/remotes/origin/main' => 'abc123...',
// ]

Lösa revisioner

PHP

$id = $repo->resolve('HEAD');
$id = $repo->resolve('main');
$id = $repo->resolve('v1.0.0');
$id = $repo->resolve('HEAD~3');
$id = $repo->resolve('main^2');
$id = $repo->resolve('3f2c1e0b9d6a4f8e7c5b2a1d0e9f8c7b6a5d4e3f');

Revisionsparsern stöder operatorerna ~N (förfader) och ^N (förälder), som kan kedjas godtyckligt. Hashar måste anges i sin helhet.

Gå igenom incheckningshistoriken

log

Incheckningar returneras med den senaste först, sorterade efter incheckarens tidsstämpel.

PHP

// Last 20 commits from HEAD
$commits = $repo->log(20);

foreach ($commits as $commit) {
    $short = substr($commit->id->hex, 0, 7);
    echo "{$short} {$commit->message}\n";
}

log från en specifik incheckning

PHP

$from = $repo->resolve('feature/login');
$commits = $repo->log(10, $from);

log filtrerad efter filsökväg

PHP

$commits = $repo->logPath('src/Repository.php', 20);

Returnerar endast incheckningar där den angivna filen ändrades (lades till, ändrades, togs bort eller bytte namn) jämfört med den första föräldern. Sökvägen måste vara en exakt filsökväg; kataloger matchar inte. Endast de senaste 5 * $limit incheckningarna granskas, så äldre matchningar kan saknas (#7).

show

PHP

$result = $repo->show('HEAD');
$commit = $result['commit'];
$diffs = $result['diff'];

echo "Author: {$commit->author}\n";
echo "Message: {$commit->message}\n\n";

foreach ($diffs as $diff) {
    echo $diff->format();
}

Identifiering av standardgren

PHP

$default = $repo->defaultBranch();
// Checks: remote HEAD symref -> local HEAD -> main/master fallback

När remote.origin.url är inställt och processer är aktiverade gör den första kontrollen en smart HTTP-begäran till fjärren. Nätverksfel ignoreras och de lokala kontrollerna utförs sedan.

Sammanfogningens härkomst

PHP

// Is feature fully merged into main?
$merged = $repo->isBranchMerged('feature/done', 'main');

// Find the merge base of two commits
$base = $repo->mergeBase(
    $repo->resolve('main'),
    $repo->resolve('feature/login'),
);