Repositories lezen

Bekijken als Markdown Bewerken op GitHub Documentatie op bfe242f

Pitmaster leest git-repositories door de schijfindelingen rechtstreeks te parseren: losse objecten (met zlib gecomprimeerde bestanden in .git/objects/), packbestanden (.git/objects/pack/), refs (bestanden in .git/refs/ en packed-refs) en de index (.git/index).

Een repository openen

PHP

use Pitmaster\Pitmaster;

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

Pitmaster ondersteunt drie repository-indelingen:

Reguliere repositories: .git is een map in de projectroot.
Gekoppelde worktrees: .git is een bestand met gitdir: <path> dat verwijst naar .git/worktrees/<name>/.
Bare repositories: het pad zelf bevat HEAD, objects/ enzovoort.

PHP

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

Objecten lezen

Elk gegeven in een git-repository wordt opgeslagen als een object dat aan de hand van zijn hash wordt geïdentificeerd: standaard SHA-1 (40 hextekens), of SHA-256 (64 hextekens) in repositories die zijn aangemaakt met Pitmaster::init($path, 'sha256'). Er zijn vier objecttypen: blob, tree, commit en tag.

De hashmethoden hieronder vereisen de volledige hexhash; verkorte hashes worden niet geaccepteerd.

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

Objecten worden eerst gezocht in de losse opslag en daarna in packbestanden. Bij het opzoeken in packbestanden wordt de .idx-fanouttabel gebruikt voor binair zoeken van O(log n).

catFile

Voor eenvoudige inhoudsopvraging zonder typecontrole:

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

Retourneert hexhashes van alle objecten (los en gepackt).

Werken met blobs

Een blob bevat ruwe bestandsinhoud.

PHP

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

Werken met trees

Een tree is een mappenlijst. Elke vermelding heeft een modus, naam en 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)
    }
}

Werken met commits

Een commit koppelt een treesnapshot aan de bovenliggende commits en metagegevens.

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
}

Werken met tags

Geannoteerde tags zijn objecten met een doel, type, naam, tagger en bericht.

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 lezen

Huidige HEAD

PHP

$commit = $repo->head();

Lost HEAD op (inclusief symbolische refs zoals HEAD -> refs/heads/main -> commit hash) en retourneert het commitobject.

Huidige branch

PHP

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

Branches en tags weergeven

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

Revisies oplossen

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

De revisieparser ondersteunt de operatoren ~N (voorouder) en ^N (ouder), die onbeperkt kunnen worden gekoppeld. Hashes moeten volledig worden opgegeven.

Commitgeschiedenis doorlopen

log

Commits worden geretourneerd van nieuw naar oud, gerangschikt op het tijdstempel van de committer.

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 vanaf een specifieke commit

PHP

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

log gefilterd op bestandspad

PHP

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

Retourneert alleen commits waarin het opgegeven bestand is gewijzigd (toegevoegd, aangepast, verwijderd of hernoemd) ten opzichte van de eerste ouder. Het pad moet een exact bestandspad zijn; mappen komen niet overeen. Er worden alleen de nieuwste 5 * $limit commits onderzocht, waardoor oudere overeenkomsten kunnen ontbreken (#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();
}

Detectie van de standaardbranch

PHP

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

Wanneer remote.origin.url is ingesteld en processen zijn ingeschakeld, verstuurt de eerste controle een slimme HTTP-aanvraag naar de remote. Netwerkfouten worden genegeerd; daarna volgen de lokale controles.

Merge-afstamming

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