Przejdź do treści

Odczytywanie repozytoriów

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: bfe242f

Pitmaster odczytuje repozytoria git, bezpośrednio analizując formaty danych na dysku: luźne obiekty (pliki skompresowane zlib w .git/objects/), pliki pack (.git/objects/pack/), refy (pliki w .git/refs/ i packed-refs) oraz indeks (.git/index).

Otwieranie repozytorium

PHP
use Pitmaster\Pitmaster;

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

Pitmaster obsługuje trzy układy repozytoriów:

  1. Zwykłe repozytoria: .git to katalog w katalogu głównym projektu.
  2. Połączone drzewa robocze: .git to plik zawierający gitdir: <path> wskazujące na .git/worktrees/<name>/.
  3. Repozytoria bez katalogu roboczego: sama ścieżka zawiera HEAD, objects/ itd.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Odczytywanie obiektów

Każdy fragment danych w repozytorium git jest przechowywany jako obiekt identyfikowany skrótem: domyślnie SHA-1 (40 znaków szesnastkowych) lub SHA-256 (64 znaki szesnastkowe) w repozytoriach utworzonych za pomocą Pitmaster::init($path, 'sha256'). Istnieją cztery typy obiektów: blob, drzewo, commit i tag.

Poniższe metody oparte na skrócie wymagają pełnego skrótu szesnastkowego; skrócone skróty nie są akceptowane.

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

Obiekty są wyszukiwane najpierw w luźnych danych, a następnie w plikach pack. Wyszukiwanie w plikach pack używa tablicy rozgałęzień .idx do wyszukiwania binarnego O(log n).

catFile

Aby pobrać zawartość bez sprawdzania typu:

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

Zwraca skróty szesnastkowe wszystkich obiektów (luźnych i spakowanych).

Praca z blobami

Blob zawiera surową treść pliku.

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

Praca z drzewami

Drzewo to lista katalogów. Każdy wpis zawiera tryb, nazwę i 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)
    }
}

Praca z commitami

Commit łączy migawkę drzewa z elementami nadrzędnymi i metadanymi.

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
}

Praca z tagami

Tagi z adnotacją to obiekty zawierające cel, typ, nazwę, autora tagu i komunikat.

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

Odczytywanie referencji

Bieżący HEAD

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

Rozwiązuje HEAD (podążając za symbolicznymi referencjami, takimi jak HEAD -> refs/heads/main -> commit hash) i zwraca obiekt commit.

Bieżąca gałąź

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

Lista gałęzi i tagów

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

Wszystkie referencje

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

Rozwiązywanie rewizji

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

Parser rewizji obsługuje operatory ~N (przodek) i ^N (rodzic), które można łączyć w dowolny sposób. Hashe należy podawać w całości.

Przeglądanie historii commitów

log

Commity są zwracane od najnowszego, w kolejności według znacznika czasu committera.

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 od konkretnego commita

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

log z filtrem ścieżki pliku

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

Zwraca tylko commity, w których określony plik został zmieniony (dodany, zmodyfikowany, usunięty lub przemianowany) w porównaniu z pierwszym rodzicem. Ścieżka musi wskazywać dokładny plik; katalogi nie są dopasowywane. Sprawdzanych jest tylko 5 * $limit najnowszych commitów, więc starsze dopasowania mogą zostać pominięte (#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();
}

Wykrywanie domyślnej gałęzi

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

Gdy ustawiono remote.origin.url i włączono procesy, pierwsze sprawdzenie wysyła do zdalnego repozytorium inteligentne żądanie HTTP. Błędy sieciowe są ignorowane, a następnie wykonywane są sprawdzenia lokalne.

Pokrewieństwo w scalaniu

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