Pereiti prie turinio

Saugyklų skaitymas

Peržiūrėti kaip Markdown Redaguoti per GitHub Dokumentacija: bfe242f

Pitmaster skaito git saugyklas tiesiogiai analizuodamas diske esančius formatus: atskirus objektus (zlib suspaustus failus aplanke .git/objects/), paketo failus (.git/objects/pack/), nuorodas (failus aplankuose .git/refs/ ir packed-refs) bei indeksą (.git/index).

Saugyklos atvėrimas

PHP
use Pitmaster\Pitmaster;

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

Pitmaster palaiko tris saugyklų išdėstymo variantus:

  1. Įprastos saugyklos: .git yra katalogas projekto šakniniame kataloge.
  2. Susieti darbiniai medžiai: .git yra failas, kuriame yra gitdir: <path>, nurodantis į .git/worktrees/<name>/.
  3. Bare saugyklos: pačiame kelyje yra HEAD, objects/ ir kt.
PHP
// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Objektų skaitymas

Kiekviena git saugyklos duomenų dalis saugoma kaip objektas, identifikuojamas maiša: pagal numatytuosius nustatymus SHA-1 (40 šešioliktainių ženklų), o su Pitmaster::init($path, 'sha256') sukurtose saugyklose – SHA-256 (64 šešioliktainiai ženklai). Yra keturi objektų tipai: blob, medis, įrašas ir žyma.

Toliau aprašyti metodai priima visą šešioliktainę maišą; sutrumpintos maišos nepriimamos.

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

Pirmiausia objektų ieškoma atskiroje saugykloje, tada paketo failuose. Objektų paketo faile ieškoma naudojant .idx nukreipimo lentelę ir O(log n) dvejetainę paiešką.

catFile

Paprastam turinio gavimui netikrinant tipo:

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

Grąžina visų objektų (atskirų ir supakuotų) šešioliktaines maišas.

Darbas su blob objektais

Blob objekte saugomas neapdorotas failo turinys.

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

Darbas su medžiais

Medis yra katalogo sąrašas. Kiekvienas įrašas turi režimą, pavadinimą ir maišą.

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

Darbas su įrašais

Įrašas susieja medžio momentinę kopiją su jos tėviniais įrašais ir metaduomenimis.

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
}

Darbas su žymomis

Anotuotos žymos yra objektai, turintys tikslą, tipą, pavadinimą, žymos autorių ir pranešimą.

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

Nuorodų skaitymas

Dabartinė HEAD

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

Išsprendžia HEAD (sekdama simbolines nuorodas, pavyzdžiui, HEAD -> refs/heads/main -> commit hash) ir grąžina įrašo objektą.

Dabartinė šaka

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

Šakų ir žymų sąrašas

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

Visos nuorodos

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

Versijų išsprendimas

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

Versijų analizatorius palaiko ~N (protėvio) ir ^N (tėvinio įrašo) operatorius, kuriuos galima jungti bet kokia seka. Maišos turi būti pateiktos visos.

Įrašų istorijos peržiūra

log

Įrašai pateikiami pradedant naujausiais, pagal įrašytojo laiko žymą.

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 nuo konkretaus įrašo

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

log, filtruojamas pagal failo kelią

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

Grąžinami tik tie įrašai, kuriuose nurodytas failas buvo pakeistas (pridėtas, modifikuotas, ištrintas ar pervadintas), palyginti su pirmuoju tėviniu įrašu. Kelias turi tiksliai nurodyti failą; katalogai neatitinka. Tikrinami tik naujausi 5 * $limit įrašai, todėl senesni atitikmenys gali būti neįtraukti (žr. #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();
}

Numatytoji šaka

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

Kai nustatyta remote.origin.url ir procesų vykdymas įjungtas, pirmiausia nuotolinei saugyklai siunčiama išmani HTTP užklausa. Tinklo klaidos ignoruojamos, tada atliekami vietiniai patikrinimai.

Sujungimo protėviai

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