Zum Inhalt springen

Repositories lesen

Als Markdown anzeigen Auf GitHub bearbeiten Dokumentation zu bfe242f

Pitmaster liest git-Repositories, indem es die Datenträgerformate direkt parst: lose Objekte (zlib-komprimierte Dateien in .git/objects/), Packdateien (.git/objects/pack/), Refs (Dateien in .git/refs/ und packed-refs) und den Index (.git/index).

Repository öffnen

PHP
use Pitmaster\Pitmaster;

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

Pitmaster unterstützt drei Repository-Layouts:

  1. Reguläre Repositories: .git ist ein Verzeichnis im Projektstamm.
  2. Verknüpfte Worktrees: .git ist eine Datei mit gitdir: <path>, das auf .git/worktrees/<name>/ verweist.
  3. Bare-Repositories: Der Pfad selbst enthält HEAD, objects/ usw.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Objekte lesen

Jedes Datenelement in einem git-Repository wird als Objekt gespeichert, das durch seinen Hash identifiziert wird: standardmäßig SHA-1 (40 Hexadezimalzeichen) oder SHA-256 (64 Hexadezimalzeichen) in mit Pitmaster::init($path, 'sha256') erstellten Repositories. Es gibt vier Objekttypen: Blob, Tree, Commit und Tag.

Die hashbasierten Methoden unten erwarten den vollständigen Hex-Hash; abgekürzte Hashes werden nicht akzeptiert.

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

Objekte werden zuerst im losen Speicher gesucht, dann in Pack-Dateien. Bei der Suche in Pack-Dateien wird die .idx-Fanout-Tabelle für die binäre Suche nach O(log n) verwendet.

catFile

Zum einfachen Abrufen von Inhalten ohne Typprüfung:

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

Gibt die Hex-Hashes aller Objekte zurück (lose und gepackte).

Mit Blobs arbeiten

Ein Blob enthält rohe Dateiinhalte.

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

Mit Trees arbeiten

Ein Tree ist eine Verzeichnisauflistung. Jeder Eintrag enthält einen Modus, einen Namen und einen 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)
    }
}

Mit Commits arbeiten

Ein Commit verknüpft einen Tree-Snapshot mit seinen Eltern und Metadaten.

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
}

Mit Tags arbeiten

Annotierte Tags sind Objekte mit Ziel, Typ, Name, Tagger und Nachricht.

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

Refs lesen

Aktueller HEAD

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

Löst HEAD auf (und folgt symbolischen Refs wie HEAD -> refs/heads/main -> commit hash) und gibt das Commit-Objekt zurück.

Aktueller Branch

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

Branches und Tags auflisten

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

Revisionen auflösen

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

Der Revisionsparser unterstützt die Operatoren ~N (Vorfahr) und ^N (Elternteil), beliebig verkettet. Hashes müssen vollständig angegeben werden.

Commit-Verlauf durchlaufen

log

Commits werden zuerst die neuesten zurückgegeben und nach dem Committer-Zeitstempel sortiert.

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 ab einem bestimmten Commit

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

log nach Dateipfad filtern

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

Gibt nur Commits zurück, bei denen sich die angegebene Datei gegenüber dem ersten Eltern-Commit geändert hat (hinzugefügt, geändert, gelöscht oder umbenannt). Der Pfad muss ein exakter Dateipfad sein; Verzeichnisse werden nicht berücksichtigt. Es werden nur die neuesten 5 * $limit Commits geprüft, daher fehlen möglicherweise ältere Treffer (#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();
}

Standard-Branch erkennen

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

Wenn remote.origin.url gesetzt ist und Prozesse aktiviert sind, sendet die erste Prüfung eine intelligente HTTP-Anfrage an das Remote. Netzwerkfehler werden ignoriert und die lokalen Prüfungen werden fortgesetzt.

Merge-Abstammung

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