Tárolók olvasása

Megtekintés Markdownként Szerkesztés itt: GitHub Dokumentáció itt: bfe242f

Az Pitmaster a git adattárakat úgy olvassa be, hogy közvetlenül feldolgozza a lemezen tárolt formátumokat: a laza objektumokat (zlib-tömörített fájlok az .git/objects/-ban), a csomagfájlokat (.git/objects/pack/), a hivatkozásokat (fájlok az .git/refs/-ban és az packed-refs-ban), valamint az indexet (.git/index).

Tároló megnyitása

PHP

use Pitmaster\Pitmaster;

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

Az Pitmaster három tárolóelrendezést támogat:

Normál tárolók: az .git könyvtár a projekt gyökérkönyvtárában található.
Kapcsolt munkafák: az .git egy fájl, amely az .git/worktrees/<name>/ helyre mutató gitdir: <path> értéket tartalmazza.
Bare tárolók: maga az útvonal tartalmazza többek között az HEAD és objects/ elemeket.

PHP

// Detection helpers
Pitmaster::isRepository('/path');  // true for any of the above
Pitmaster::isWorktree('/path');    // true only for linked worktrees

Objektumok olvasása

A git adattár minden adata hash alapján azonosított objektumként van tárolva: alapértelmezés szerint SHA-1 (40 hexadecimális karakter), vagy SHA-256 (64 hexadecimális karakter) az Pitmaster::init($path, 'sha256') használatával létrehozott adattárakban. Négy objektumtípus létezik: blob, tree, commit és tag.

Az alábbi hash-alapú metódusok a teljes hexadecimális hash-t várják; rövidített hash-ek nem használhatók.

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

Az objektumok keresése először a laza tárolóban, majd a csomagfájlokban történik. A csomagfájlok keresése az .idx elosztótáblát használja az O(log n) bináris kereséshez.

catFile

Egyszerű tartalomlekérés típusellenőrzés nélkül:

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

Az összes objektum hexadecimális hashét adja vissza (a laza és a csomagolt objektumokét is).

Blobok kezelése

A blob nyers fájltartalmat tárol.

PHP

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

Fák kezelése

A fa egy könyvtárbejegyzés-lista. Minden bejegyzésnek van módja, neve és hash-e.

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

Commitok kezelése

A commit egy fa-pillanatképet kapcsol össze a szülőivel és a metaadataival.

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
}

Címkék kezelése

A megjegyzésekkel ellátott címkék objektumok, amelyek célt, típust, nevet, címkézőt és üzenetet tartalmaznak.

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

Hivatkozások olvasása

Aktuális HEAD

PHP

$commit = $repo->head();

Feloldja a HEAD-et (követve az olyan szimbolikus hivatkozásokat, mint az HEAD -> refs/heads/main -> commit hash), és visszaadja a commit objektumot.

Aktuális ág

PHP

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

Ágak és címkék listázása

PHP

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

Összes hivatkozás

PHP

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

Verziók feloldása

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

A verzióelemző támogatja az ~N (ős) és az ^N (szülő) operátorokat, tetszőleges láncolásban. A hash-eket teljes alakjukban kell megadni.

Commitelőzmények bejárása

log

A commitok a legújabbtól a legrégebbi felé, a commitoló időbélyege szerint rendezve jelennek meg.

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";
}

Napló megadott commitból

PHP

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

Napló fájlútvonal szerint szűrve

PHP

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

Csak azokat a commitokat adja vissza, amelyekben a megadott fájl az első szülőhöz képest módosult (hozzáadás, módosítás, törlés vagy átnevezés történt). Az útvonalnak pontos fájlútvonalnak kell lennie; könyvtárakra nem illeszkedik. Csak a legújabb 5 * $limit commitot vizsgálja, ezért régebbi egyezések kimaradhatnak (#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();
}

Alapértelmezett ág észlelése

PHP

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

Ha az remote.origin.url be van állítva, és a folyamatok engedélyezettek, az első ellenőrzés egy intelligens HTTP kérést küld a távoli tárolónak. A hálózati hibákat figyelmen kívül hagyja, majd végrehajtja a helyi ellenőrzéseket.

Egyesítési leszármazás

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