Gå til indhold

Læsning af repositories

Vis som Markdown Rediger på GitHub Dokumentation hos bfe242f

Pitmaster læser git-repositories ved at fortolke diskformaterne direkte: løse objekter (zlib-komprimerede filer i .git/objects/), pack-filer (.git/objects/pack/), refs (filer i .git/refs/ og packed-refs) og indekset (.git/index).

Åbning af et repository

PHP
use Pitmaster\Pitmaster;

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

Pitmaster understøtter tre repository-layouts:

  1. Almindelige repositories: .git er en mappe i projektets rodmappe.
  2. Tilknyttede worktrees: .git er en fil, der indeholder gitdir: <path>, som peger på .git/worktrees/<name>/.
  3. Bare repositories: Selve stien indeholder HEAD, objects/ osv.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Læsning af objekter

Alle data i et git-repository gemmes som et objekt, der identificeres af sin hash: SHA-1 (40 hex-tegn) som standard eller SHA-256 (64 hex-tegn) i repositories, der er oprettet med Pitmaster::init($path, 'sha256'). Der findes fire objekttyper: blob, tree, commit og tag.

Hash-baserede metoder nedenfor kræver den fulde hex-hash; forkortede hashes accepteres ikke.

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

Objekter søges først i det løse lager og derefter i pack-filer. Opslag i pack-filer bruger fanout-tabellen .idx til binær søgning i O(log n).

catFile

Til enkel hentning af indhold uden typekontrol:

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...', ...]

Returnerer hex-hashes for alle objekter (løse og pakkede).

Arbejde med blobs

En blob indeholder råt filindhold.

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

Arbejde med trees

Et tree er en mappeoversigt. Hver post har en tilstand, et navn og 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)
    }
}

Arbejde med commits

En commit knytter et tree-snapshot til dets forældre og 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
}

Arbejde med tags

Annoterede tags er objekter med et mål, en type, et navn, en tagger og en besked.

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æsning af refs

Aktuel HEAD

PHP
$commit = $repo->head();

Slår HEAD op (følger symbolske refs som HEAD -> refs/heads/main -> commit hash) og returnerer commit-objektet.

Aktuel branch

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

Visning af brancher og tags

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

Alle 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øsning af 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');

Revisionsfortolkeren understøtter operatorerne ~N (forfader) og ^N (forælder), som kan kædes vilkårligt. Hashes skal angives i fuld længde.

Gennemgang af commit-historik

log

Commits returneres med den nyeste først, sorteret efter committerens tidsstempel.

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 fra en bestemt commit

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

log filtreret efter filsti

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

Returnerer kun commits, hvor den angivne fil blev ændret (tilføjet, ændret, slettet eller omdøbt) sammenlignet med den første forælder. Stien skal være en præcis filsti; mapper matches ikke. Kun de nyeste 5 * $limit commits undersøges, så ældre resultater kan mangle (#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();
}

Registrering af standardbranch

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

Når remote.origin.url er angivet, og processer er aktiveret, sender det første tjek en smart HTTP-anmodning til fjernlageret. Netværksfejl ignoreres, og derefter udføres de lokale tjek.

Merge-forfædre

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'),
);