Preskočiť na obsah

Čítanie repozitárov

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na bfe242f

Pitmaster číta repozitáre git priamym parsovaním formátov na disku: voľné objekty (súbory komprimované pomocou zlib v .git/objects/), pack súbory (.git/objects/pack/), odkazy (súbory v .git/refs/ a packed-refs) a index (.git/index).

Otvorenie repozitára

PHP
use Pitmaster\Pitmaster;

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

Pitmaster podporuje tri rozloženia repozitára:

  1. Bežné repozitáre: .git je adresár v koreňovom adresári projektu.
  2. Prepojené pracovné stromy: .git je súbor obsahujúci gitdir: <path>, ktorý ukazuje na .git/worktrees/<name>/.
  3. Holé repozitáre: samotná cesta obsahuje HEAD, objects/ atď.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Čítanie objektov

Každá časť údajov v repozitári git je uložená ako objekt identifikovaný svojím hashom: predvolene SHA-1 (40 hexadecimálnych znakov) alebo SHA-256 (64 hexadecimálnych znakov) v repozitároch vytvorených pomocou Pitmaster::init($path, 'sha256'). Existujú štyri typy objektov: blob, strom, commit a tag.

Metódy založené na hashi nižšie vyžadujú celý hexadecimálny hash; skrátené hashe sa neprijímajú.

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

Objekty sa najprv hľadajú v úložisku voľných objektov a potom v pack súboroch. Pri vyhľadávaní v pack súboroch sa na O(log n) binárne vyhľadávanie používa tabuľka rozvetvenia .idx.

catFile

Na jednoduché načítanie obsahu bez kontroly 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...', ...]

Vráti hexadecimálne hashe všetkých objektov (voľných aj zabalených).

Práca s blobmi

Blob obsahuje nespracovaný obsah súboru.

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

Práca so stromami

Strom je zoznam adresára. Každá položka obsahuje režim, názov a 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)
    }
}

Práca s commitmi

Commit prepája snímku stromu s jej rodičmi a metadátami.

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
}

Práca s tagmi

Anotované tagy sú objekty obsahujúce cieľ, typ, názov, autora tagu a správu.

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

Čítanie odkazov

Aktuálny HEAD

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

Vyrieši HEAD (nasleduje symbolické odkazy, napríklad HEAD -> refs/heads/main -> commit hash) a vráti objekt commitu.

Aktuálna vetva

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

Zoznam vetiev a tagov

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

Všetky odkazy

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

Riešenie revízií

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 revízií podporuje operátory ~N (predok) a ^N (rodič), ktoré možno ľubovoľne reťaziť. Hashe sa musia uvádzať celé.

Prechádzanie histórie commitov

log

Commity sa vracajú od najnovšieho a zoraďujú sa podľa časovej pečiatky autora commitu.

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 konkrétneho commitu

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

log filtrovaný podľa cesty k súboru

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

Vráti iba commity, v ktorých sa zadaný súbor zmenil (bol pridaný, upravený, odstránený alebo premenovaný) v porovnaní s prvým rodičom. Cesta musí presne označovať súbor; adresáre sa nezhodujú. Kontroluje sa iba najnovších 5 * $limit commitov, takže staršie zhody môžu chýbať (#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();
}

Zisťovanie predvolenej vetvy

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

Keď je nastavené remote.origin.url a procesy sú povolené, prvá kontrola odošle vzdialenému serveru inteligentnú požiadavku HTTP. Chyby siete sa ignorujú a potom nasledujú lokálne kontroly.

Predkovia pri zlúčení

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