PHP API

Markdownとして表示 GitHubで編集ドキュメント: bfe242f

`Pitmaster\Pitmaster`

Pitmaster\Pitmasterクラスは静的エントリーポイントです。リポジトリを開く、作成する、クローンするためのファクトリメソッドと、検出用のヘルパーを提供します。

PHP

use Pitmaster\Pitmaster;

`open`

PHP

public static function open(string $path, array $options = []): Repository

$pathにある既存のリポジトリを開きます。パスには作業ツリーのルート（.git/を含むディレクトリ）を指定してください。リンクされたworktree（.gitがgitdir: <path>を含むファイルの場合）と、bareリポジトリ（$pathが.gitディレクトリそのものの場合）にも対応しています。

$optionsは2つのブール値を受け取り、どちらもデフォルトはtrueです。

hooks: .git/hooksスクリプトを実行します。このハンドルで実行しない場合はfalseを渡します。
processes: プロセスを開始する操作やネットワークトランスポートを開く操作をすべて許可します。フック、fsmonitorフック、clone、fetch、push、SSHプロセストランスポートを無効にするにはfalseを渡します。ローカルの読み書きは引き続き行えます。

パスがgitリポジトリでない場合、InvalidArgumentExceptionをスローします。

PHP

$repo = Pitmaster::open('/home/user/project');
$repo = Pitmaster::open('/home/user/project', ['hooks' => false]);
$repo = Pitmaster::open('/home/user/project', Pitmaster::processFreeOptions());

`init`

PHP

public static function init(string $path, string $objectFormat = 'sha1', array $options = []): Repository

$pathに新しいリポジトリを初期化します。.gitディレクトリ構造を作成し、objects/、refs/heads/、refs/tags/、hooks/、info/、HEAD（refs/heads/mainを指す）、およびデフォルトのconfigを作成します。

$objectFormatは'sha1'または'sha256'です。SHA-256リポジトリでは、設定にrepositoryformatversion = 1とextensions.objectformat = sha256が追加されます。それ以外の値を指定するとInvalidArgumentExceptionがスローされます。$optionsはopen()と同じキーを受け取ります。

指定したパスにリポジトリがすでに存在する場合、RuntimeExceptionをスローします。

PHP

$repo = Pitmaster::init('/home/user/new-project');
$repo = Pitmaster::init('/home/user/sha256-project', 'sha256');

`clone`

PHP

public static function clone(string $url, string $path, ?int $depth = null, array $options = []): Repository

リモートリポジトリをクローンします。新しいリポジトリを初期化し、リモート参照を検出してパックファイルを取得し、リモート追跡ブランチを設定して、作業ツリーを展開します。SSH URL（ssh://...またはuser@host:path）にはSSHトランスポートを使用します。それ以外のURLにはスマートHTTPを使用し、スマート交換に失敗した場合はダムHTTPにフォールバックします。浅いクローンには$depthを渡します。

$options['processes']がfalseの場合にRuntimeExceptionをスローします。クローンに失敗し、$pathが事前に存在しなかった場合は、作成途中のディレクトリを削除します。

PHP

$repo = Pitmaster::clone('https://github.com/user/repo.git', '/tmp/repo');
$repo = Pitmaster::clone('https://github.com/user/repo.git', '/tmp/shallow', 1);
$repo = Pitmaster::clone('https://github.com/user/repo.git', '/tmp/repo', null, ['hooks' => false]);

`processFreeOptions`

PHP

public static function processFreeOptions(): array

ホストプロセスを起動してはならないランタイム向けに['processes' => false, 'hooks' => false]を返します。open()またはinit()に渡してください。

`isRepository`

PHP

public static function isRepository(string $path): bool

パスがgitリポジトリかどうかを確認します。通常のリポジトリ（.git/ディレクトリ）、リンクされたワークツリー（.gitファイル）、ベアリポジトリ（HEADファイルが存在）ではtrueを返します。

PHP

if (Pitmaster::isRepository('/path/to/check')) {
    // It's a git repo
}

`isWorktree`

PHP

public static function isWorktree(string $path): bool

パスがリンクされたワークツリー（メインリポジトリではない）かどうかを確認します。.gitがgitdir:参照を含むファイルの場合に限り、trueを返します。

PHP

if (Pitmaster::isWorktree('/path/to/worktree')) {
    // It's a linked worktree
}

`commonGitDir`

PHP

public static function commonGitDir(string $path): ?string

任意のチェックアウトパスから共通のgitディレクトリを解決します。通常のリポジトリでは.gitディレクトリです。リンクされたワークツリーでは、オブジェクト、設定、packed-refsを含む共有gitディレクトリです。パスがリポジトリでない場合はnullを返します。

PHP

$common = Pitmaster::commonGitDir('/path/to/worktree');
// '/path/to/main-repo/.git'

`Pitmaster\Repository`

Pitmaster\Repositoryクラスは、すべてのgit操作を行うための主要なハンドルです。Pitmaster::open()、Pitmaster::init()、またはPitmaster::clone()で取得できます。

PHP

use Pitmaster\Repository;

パスアクセサー

`gitDir`

PHP

public function gitDir(): string

ワークツリーごとのgitディレクトリを返します。通常のリポジトリでは.git/、リンクされたワークツリーでは.git/worktrees/<name>/です。

`commonGitDir`

PHP

public function commonGitDir(): string

共有gitディレクトリを返します。通常のリポジトリではgitDir()と同じです。リンクされたワークツリーでは、メインリポジトリの.git/ディレクトリ（オブジェクト、設定、packed-refsが格納される場所）です。

`workDir`

PHP

public function workDir(): string

作業ツリーのルートパスを返します。

`isLinkedWorktree`

PHP

public function isLinkedWorktree(): bool

このリポジトリハンドルがリンクされたワークツリーの場合、trueを返します。

`isBare`, `hooksEnabled`, `processesEnabled`

PHP

public function isBare(): bool
public function hooksEnabled(): bool
public function processesEnabled(): bool

リポジトリに作業ツリーがないかどうか、およびこのハンドルでhooks / processesのどちらのオプションが有効かを報告します。プロセスが無効な場合、hooksEnabled()は常にfalseです。

オブジェクト

`readObject`

PHP

public function readObject(string $hash): GitObject

完全な16進ハッシュ（40文字、SHA-256リポジトリでは64文字）で任意のオブジェクトを読み込みます。省略形のハッシュは受け付けません。Blob、Tree、Commit、またはTagのインスタンスを返します。ルーズオブジェクトを先に検索し、その後パックファイルを検索します。

ハッシュが見つからない場合、ObjectNotFoundExceptionをスローします。

PHP

$object = $repo->readObject('a1b2c3d4e5f6...');

`writeObject`

PHP

public function writeObject(GitObject $object): ObjectId

ルーズオブジェクトストアにオブジェクトを書き込みます。計算されたObjectIdを返します。

PHP

use Pitmaster\Object\Blob;

$blob = Blob::fromContent('Hello, world!');
$id = $repo->writeObject($blob);

`catFile`

PHP

public function catFile(string $hash): string

git cat-file -pと同等の、オブジェクトの生コンテンツを返します。

PHP

echo $repo->catFile('a1b2c3d4...');

`objectExists`

PHP

public function objectExists(string $hash): bool

リポジトリ内にオブジェクトが存在するか（ルーズまたはパック済み）を確認します。

`listObjects`

PHP

public function listObjects(): array

リポジトリ内のすべてのオブジェクトハッシュを一覧表示します。16進文字列の配列を返します。

参照

`head`

PHP

public function head(): Commit

現在のHEADコミットを返します。シンボリック参照（HEAD -> refs/heads/main -> コミットハッシュ）をたどります。

HEADが有効なコミットを指していない場合（e.g、空のリポジトリ）、RuntimeExceptionをスローします。

`branch`

PHP

public function branch(?string $name = null): ?string

引数がない場合、現在のブランチ名（e.g、'main'）を返します。HEADがデタッチ状態の場合はnullを返します。

ブランチ名を指定すると、そのコミットハッシュ（16進文字列）を解決して返します。ブランチが存在しない場合はnullを返します。

PHP

$current = $repo->branch();        // 'main'
$hash = $repo->branch('feature');   // 'abc123...' or null

`branches`

PHP

public function branches(): array

すべてのブランチ名を含むソート済み配列を返します（refs/heads/プレフィックスなし）。

PHP

$branches = $repo->branches();
// ['bugfix/typo', 'feature/login', 'main']

`tags`

PHP

public function tags(): array

すべてのタグ名を含むソート済み配列を返します（refs/tags/プレフィックスなし）。

`resolve`

PHP

public function resolve(string $revision): ObjectId

リビジョン式をObjectIdに解決します。対応形式：

完全な16進ハッシュ（40文字、SHA-256では64文字）。abc1234のような省略形のハッシュは解決されません。
HEAD
ブランチ名（main、feature/login）
タグ名（v1.0.0）
完全な参照パス（refs/heads/main）
リビジョン式（HEAD~3、main^2）

リビジョンを解決できない場合、RuntimeExceptionをスローします。

PHP

$id = $repo->resolve('HEAD~3');
$id = $repo->resolve('v1.0.0');
$id = $repo->resolve('feature/login');

`allRefs`

PHP

public function allRefs(): array

すべての参照を、参照名をキー、16進ハッシュを値とする連想配列で返します。

PHP

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

`updateRef`

PHP

public function updateRef(string $name, ObjectId $target): void

参照が新しい対象を指すように更新します。

PHP

$repo->updateRef('refs/heads/main', $commitId);

`createBranch`

PHP

public function createBranch(string $name, ?ObjectId $from = null): void

新しいブランチを作成します。$fromがnullの場合、現在のHEADから分岐します。

PHP

$repo->createBranch('feature/new-thing');
$repo->createBranch('hotfix', $repo->resolve('v1.0.0'));

`deleteBranch`

PHP

public function deleteBranch(string $name): void

名前を指定してブランチを削除します。ブランチがチェックアウト中、または存在しない場合はRuntimeExceptionをスローします。git branch -dとは異なり、ブランチがマージ済みかどうかは確認しません。

PHP

$repo->deleteBranch('feature/old');

`createLightweightTag`

PHP

public function createLightweightTag(string $name, ?ObjectId $target = null): void

軽量タグを作成します。$targetがnullの場合、現在のHEADに直接タグを付けます。

PHP

$repo->createLightweightTag('v2.0.0');
$repo->createLightweightTag('hotfix-start', $repo->resolve('main~2'));

`createTag`

PHP

public function createTag(string $name, string $message, ?ObjectId $target = null, ?string $tagger = null): ObjectId

注釈付きタグを作成します。$targetがnullの場合、現在のHEADにタグを付けます。タグオブジェクトのObjectIdを返します。

PHP

$tagId = $repo->createTag('v2.0.0', 'Release version 2.0.0');

`deleteTag`

PHP

public function deleteTag(string $name): void

名前を指定してタグを削除します。

PHP

$repo->deleteTag('v1.0.0');

`packRefs`

PHP

public function packRefs(): void

現在のルーズ参照セットから共有packed-refsファイルを書き換え、対応する共有ルーズ参照を削除します。リンクされたワークツリーでは、共通のgitディレクトリに書き込みます。

PHP

$repo->packRefs();

`defaultBranch`

PHP

public function defaultBranch(): string

リポジトリのデフォルトブランチを解決します。まずリモートHEADのシンボリック参照、次にローカルHEADを確認し、その後mainまたはmasterにフォールバックします。

`isBranchMerged`

PHP

public function isBranchMerged(string $branch, ?string $target = null): bool

あるブランチが別のブランチ（デフォルトではデフォルトブランチ）に完全にマージ済みかどうかを確認します。

PHP

if ($repo->isBranchMerged('feature/done')) {
    $repo->deleteBranch('feature/done');
}

`checkout`

PHP

public function checkout(string $target): void

ブランチを切り替えるか、HEADをデタッチします。HEAD、インデックス、作業ツリーを更新します。$targetにはブランチ名、タグ、完全なハッシュ、またはリビジョン式を指定します。ブランチ以外を指定するとHEADがデタッチされます。

現在のツリーと対象ツリーで異なるパスに、ローカル変更（ステージ済みかどうかを問わない）または未追跡ファイルがある場合、RuntimeExceptionをスローします。

その他の追跡対象ファイルにある未コミットの変更は引き継がれません。インデックスと作業ツリーは対象ツリーから再構築されるため、両側で同一のファイルに対する編集は失われます。gitなら保持される編集です（#2）。先にコミットするか、スタッシュしてください。merge()、cherryPick()、revert()、rebase()およびbisectメソッドも同じ方法で作業ツリーを再構築します。

PHP

$repo->checkout('feature/login');
$repo->checkout($repo->resolve('v1.0.0')->hex);  // Detached HEAD

インデックス

`index`

PHP

public function index(): Index

.git/indexから現在のインデックス（ステージング領域）を読み込み、返します。

`add`

PHP

public function add(string ...$paths): void

ファイルをステージします。各ファイルを作業ツリーから読み込み、blobオブジェクトを作成して、インデックスを更新します。各引数には作業ツリーのルートからの相対パスでファイル（またはシンボリックリンク）を指定してください。ディレクトリとglobは展開されず、ファイルが見つからない場合はRuntimeExceptionをスローします。

PHP

$repo->add('src/Feature.php', 'tests/FeatureTest.php');

`remove`

PHP

public function remove(string ...$paths): void
public function removeCached(string ...$paths): void

追跡対象のパスをインデックスと作業ツリーの両方から削除します。Gitと同様の動作にするため、引数リストでは--cachedおよび-r / --recursiveをサポートします。

PHP

$repo->remove('old-file.txt');
$repo->remove('-r', 'src');
$repo->remove('--cached', 'old-file.txt');
$repo->removeCached('old-file.txt');

`mv`

PHP

public function mv(string $source, string $destination): void

作業ツリーとインデックスの両方でファイルを移動または名前変更します。

PHP

$repo->mv('old-name.php', 'new-name.php');

コミット

`commit`

PHP

public function commit(?string $message = null, ?string $author = null): ObjectId

現在のインデックスからコミットを作成します。インデックスのエントリーからツリー階層を構築し、HEADがあれば親としてコミットオブジェクトを作成して、HEADを更新します。新しいコミットのObjectIdを返します。

$messageをnullにできるのは、マージ、cherry-pick、revert、またはrebaseが競合で停止している間だけです。その場合は準備済みメッセージが使われます。それ以外の場合、nullメッセージはRuntimeException('Commit message required')をスローします。インデックスに未マージのパスがある場合、コミットのないリポジトリでインデックスが空の場合、およびツリーがHEADから変わっていない場合も、コミットはエラーになります。

$authorパラメーターには完全なgit作成者文字列（Name <email> timestamp timezone）を指定します。nullの場合、環境変数、定数、.git/configから、Getting Startedで説明されている順に解決されます。

PHP

$id = $repo->commit('Fix null pointer bug');

`show`

PHP

public function show(string $revision): array

コミット相当のリビジョンと最初の親との差分を表示します。リビジョンが注釈付きタグに解決される場合、戻り値には['tag' => Tag]も含まれ、commitはタグを剥がした後の対象コミットになります。

PHP

$result = $repo->show('HEAD');
echo $result['commit']->message;

foreach ($result['diff'] as $diff) {
    echo $diff->format();
}

`reset`

PHP

public function reset(string $revision, string $mode = 'mixed'): void

HEADをコミットにリセットします。モード：

'soft'：HEADのみ移動
'mixed'：HEADを移動し、インデックスをリセット（デフォルト）
'hard'：HEADを移動し、インデックスと作業ツリーをリセット

PHP

$repo->reset('HEAD~1', 'soft');
$repo->reset('main', 'hard');

`restore`

PHP

public function restore(string $path, ?string $source = null, bool $staged = false, bool $worktree = false): void

インデックスまたは指定したソースリビジョンからパスを復元します。どちらのフラグも指定しない場合、Pitmasterはインデックスから作業ツリーを復元します（指定があれば$sourceから復元）。staged: trueはHEAD（または$source）からインデックスを復元し、作業ツリーには触れません。両方を復元するにはstaged: true, worktree: trueを渡します。

PHP

$repo->restore('src/File.php');                                        // Worktree from index
$repo->restore('src/File.php', staged: true);                          // Index from HEAD
$repo->restore('src/File.php', 'HEAD~1');                              // Worktree from another commit
$repo->restore('src/File.php', 'HEAD~1', staged: true, worktree: true); // Index + worktree from another commit

`cherryPick`

PHP

public function cherryPick(string $revision): ObjectId
public function cherryPickContinue(): ObjectId
public function cherryPickAbort(): void

現在のブランチに新しいコミットとしてコミットを適用し、元の作成者を保持します。競合で処理が停止した場合は、競合を解決してパスをステージし、cherryPickContinue()またはcherryPickAbort()を呼び出します。

PHP

$newId = $repo->cherryPick('feature~2');

// After resolving conflicts:
$repo->add('src/File.php');
$repo->cherryPickContinue();

`revert`

PHP

public function revert(string $revision): ObjectId
public function revertContinue(): ObjectId
public function revertAbort(): void

別のコミットを取り消すコミットを作成します。revertが競合で停止した場合は、競合を解決してパスをステージし、revertContinue()またはrevertAbort()を呼び出します。

PHP

$revertId = $repo->revert('HEAD~1');

// After resolving conflicts:
$repo->add('src/File.php');
$repo->revertContinue();

`rebase`

PHP

public function rebase(string $onto): array
public function rebaseContinue(): array
public function rebaseAbort(): void
public function rebaseSkip(): array

現在のブランチを別のリビジョンにrebaseします。Pitmasterは現在、競合時にGitと同様の停止状態になるリニアrebaseに加え、続行、中止、スキップに対応しています。HEADはブランチを指している必要があります。

rebase()、rebaseContinue()、rebaseSkip()は['success' => bool, 'commits' => int, 'conflicts' => list<string>]を返します。rebaseが完了したかどうか、適用されたコミット数、停止時に競合したパスが含まれます。

PHP

$result = $repo->rebase('main');

if (!$result['success']) {
    // Resolve conflicts, then continue or skip/abort.
    $repo->add('src/File.php');
    $repo->rebaseContinue();
}

ステータス

`status`

PHP

public function status(): array

作業ツリーのステータスを計算します。各StatusEntryオブジェクトを含む配列を返します。各オブジェクトには次の情報が含まれます。

path：ファイルパス
index：HEADからインデックスへの変更を示すFileStatus列挙値
worktree：インデックスから作業ツリーへの変更を示すFileStatus列挙値
origPath、renameScore：名前変更されたエントリーの場合に設定。それ以外はnull

未追跡ファイルの両方の列にはFileStatus::Untrackedが設定されます。無視対象のファイルは報告されません。

PHP

foreach ($repo->status() as $entry) {
    echo $entry->shortFormat() . "\n"; // "M  src/File.php", "?? notes.txt"
}

`statusPorcelainV2`

PHP

public function statusPorcelainV2(): string

gitのporcelain v2形式による機械可読なステータス出力です。

PHP

echo $repo->statusPorcelainV2();
// 1 M. N... 000000 000000 000000 0000...0000 0000...0000 modified-file.txt
// ? untracked-file.txt

差分

`diff`

PHP

public function diff(?string $pathspec = null, string $algorithm = 'myers'): array

作業ツリーとインデックスの差分（未ステージの変更）を表示します。DiffResultオブジェクトの配列を返します。$pathspecを指定すると、完全一致する1つのファイルパスで絞り込みます。$algorithmは'myers'（デフォルト）、'patience'、'histogram'、または'minimal'です。それ以外の値を指定するとInvalidArgumentExceptionをスローします。

PHP

$diffs = $repo->diff();

foreach ($diffs as $diff) {
    echo $diff->format();  // Unified diff output
}

`diffStaged`

PHP

public function diffStaged(?string $pathspec = null, string $algorithm = 'myers'): array

インデックスとHEADの差分（ステージ済みの変更）を表示します。名前変更の検出を含め、削除されたファイルと追加されたファイルを照合してDiffResult[]を返します。

現在、$pathspec引数は無視されるため、ステージ済みのファイルがすべて返されます。また、最初のコミット前は空の配列を返します（#5）。

PHP

$staged = $repo->diffStaged();

`diffTree`

PHP

public function diffTree(ObjectId $a, ObjectId $b, string $algorithm = 'myers'): array

ObjectIdを使って2つのツリーを比較します。DiffResult[]を返します。コミットIDではなくツリーIDを渡してください。コミットIDはツリーとして読み込まれず、結果は空になります。

PHP

$old = $repo->readObject($repo->resolve('HEAD~1')->hex);
$new = $repo->head();
$diffs = $repo->diffTree($old->tree, $new->tree);

ログ

`log`

PHP

public function log(int $limit = 50, ?ObjectId $from = null): array

コミッターのタイムスタンプが新しい順にコミット履歴をたどります。Commit[]を返します。$fromがnullの場合はHEADから開始します。HEADにコミットがない場合は空の配列を返します。

PHP

$commits = $repo->log(10);

`logAll`

PHP

public function logAll(int $limit = 50): array

すべての参照とHEADから到達可能なコミットを新しい順にたどります。Commit[]を返します。

`logOneline`

PHP

public function logOneline(int $limit = 50, bool $all = false, ?string $path = null): array

HEADから、すべての参照から（$all）、またはパスで絞り込んだgit log --oneline形式（abc1234 Subject）のログ行を返します。

`logPath`

PHP

public function logPath(string $path, int $limit = 50): array

ファイルパスで絞り込んだログです。最初の親との差分で、指定したファイルそのものを追加、変更、削除、または名前変更したコミットだけを返します。ディレクトリパスは一致しません。

最新の5 * $limit件のコミットだけが調べられるため、その範囲より古くにファイルに変更を加えたコミットが結果に含まれないことがあります（#7）。

PHP

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

マージ

`merge`

PHP

public function merge(string $branch, string $strategy = 'recursive'): MergeResult
public function mergeOctopus(array $branches): MergeResult
public function mergeContinue(): ObjectId
public function mergeAbort(): void

ブランチ（または任意のリビジョン）をHEADにマージします。早送りマージは自動検出します。早送りでないマージでは、ツリー単位で競合を検出し、競合がなければマージコミットを作成します。競合で停止した場合は、Gitと同様のマージ状態をインデックスと作業ツリーに書き込みます。パスの競合を解決してステージし、mergeContinue()またはmergeAbort()を呼び出します。

$strategy 'ours'はHEADのツリーを保持するマージコミットを記録し、それ以外の値ではデフォルトの再帰マージを使用します。mergeOctopus()は2つ以上のブランチを1つのコミットにマージします。いずれかのブランチで競合が発生した場合は、マージ状態を書き込まず、コミットも作成せずに、クリーンでない結果を返します。

すでにHEADに含まれているブランチをマージすると、「Already up to date」と報告する代わりに、別のマージコミットが作成されます（#6）。追跡対象ファイルの未コミット変更は、checkout()で説明したように上書きされます。

次の情報を含むMergeResultを返します。

clean：競合なくマージが成功したかどうか
commitId：マージコミットID（クリーンな場合）
conflictPaths：競合したファイルパスの配列（クリーンでない場合）
mergedContents：競合マーカー付きのファイル内容。競合パスをキーとします（クリーンでない場合）

PHP

$result = $repo->merge('feature/login');

if ($result->clean) {
    echo "Merged: {$result->commitId->hex}\n";
} else {
    echo "Conflicts in: " . implode(', ', $result->conflictPaths) . "\n";
    $repo->add('src/File.php');
    $repo->mergeContinue();
}

`mergeBase`

PHP

public function mergeBase(ObjectId $a, ObjectId $b): ?ObjectId

2つのコミットのマージベース（最も近い共通祖先）を検索します。共通祖先がない場合はnullを返します。

PHP

$base = $repo->mergeBase(
    $repo->resolve('main'),
    $repo->resolve('feature/login'),
);

二分探索

PHP

public function bisectStart(string $bad, string $good): ObjectId
public function bisectGood(?string $revision = null): ?ObjectId
public function bisectBad(?string $revision = null): ?ObjectId
public function bisectReset(): void

変更を導入したコミットを二分探索します。bisectStart()は不良と良好のリビジョンを記録し、最初の候補をチェックアウトして返します。bisectGood()とbisectBad()は現在のHEAD（または$revision）をマークし、次の候補をチェックアウトして返します。疑わしいコミットが1つだけになると、そのコミットが返され、候補として維持されます。これが最初の不良コミットです。bisectReset()はセッションを終了し、開始時のブランチまたはコミットに戻ります。

PHP

$candidate = $repo->bisectStart('HEAD', 'v1.0.0');
// test $candidate ...
$candidate = $repo->bisectBad();
$candidate = $repo->bisectGood();
$repo->bisectReset();

ネットワーク

`fetch`

PHP

public function fetch(string $remote = 'origin', ?int $depth = null): void

リモートからフェッチします。新しいオブジェクトをダウンロードし、リモート追跡参照を更新します。浅い履歴を深くするか制限するには$depthを渡します。

fetch()およびpush*()メソッドは、['processes' => false]を指定して開いたハンドルではRuntimeExceptionをスローします。

PHP

$repo->fetch();
$repo->fetch('upstream');

`push`

PHP

public function push(string $remote = 'origin', ?string $branch = null): void
public function pushForceWithLease(string $remote = 'origin', ?string $branch = null, ?ObjectId $expected = null): void
public function pushAtomic(string $remote = 'origin', array $branches = []): void
public function pushMirror(string $remote = 'origin'): void

現在のブランチ（または指定したブランチ）をリモートにプッシュします。参照の更新をより厳密に、または広範囲に行うためのforce-with-lease、atomic、mirrorの各バリアントを利用できます。

PHP

$repo->push();
$repo->push('origin', 'feature/login');
$repo->pushForceWithLease('origin', 'main', $repo->resolve('refs/remotes/origin/main'));
$repo->pushAtomic('origin', ['main', 'release']);
$repo->pushMirror();

ワークツリー

`addWorktree`

PHP

public function addWorktree(string $path, string $branch, ?ObjectId $from = null, ?string $name = null): Worktree

リンクされたワークツリーを追加します。ブランチが存在しない場合は作成し、ワークツリーのメタデータを設定して、作業ツリーのファイルを展開します。チェックアウトディレクトリのベース名とは異なる、決定的なメタデータ用slugが必要な場合は$nameを渡します。

PHP

$wt = $repo->addWorktree('/tmp/review', 'feature/review');
$wt = $repo->addWorktree('/tmp/checkouts/review', 'feature/review', name: 'review-wt');

`removeWorktree`

PHP

public function removeWorktree(string $pathOrName, bool $force = false): void

リンクされたワークツリーを削除します。ロックされていても削除するには$force = trueを使います。

`worktrees`

PHP

public function worktrees(): array

すべてのワークツリー（メインとリンク済み）を一覧表示します。Worktree[]を返します。

PHP

foreach ($repo->worktrees() as $wt) {
    echo "{$wt->path} [{$wt->branch}]\n";
}

設定

`config`

PHP

public function config(): GitConfig

リポジトリのgit設定にアクセスします。設定値の読み取りと書き込みができます。

PHP

$config = $repo->config();
$name = $config->get('user.name');
$config->set('user.email', 'new@example.com');

内部アクセス

これらのメソッドでは、高度な用途向けに内部コンポーネントを公開します。

`objectDatabase`

PHP

public function objectDatabase(): ObjectDatabase

生のオブジェクトデータベース（ルーズストアとパックストア）にアクセスします。

`refDatabase`

PHP

public function refDatabase(): RefDatabase

生の参照データベース（ルーズ参照とパック済み参照）にアクセスします。

低レベルクラス

これらのクラスはRepositoryでラップされず、その内部コンポーネントから構築されます。

`Pitmaster\Graph\Blame`

PHP

public function blame(ObjectId $headId, string $path): array

$headIdにある$pathの各行について1つのエントリーを返します：['line' => int, 'hash' => string, 'author' => string, 'content' => string]。authorは完全な識別文字列（Name <email> timestamp timezone）です。

PHP

use Pitmaster\Graph\Blame;

$blame = new Blame($repo->objectDatabase());

foreach ($blame->blame($repo->resolve('HEAD'), 'src/File.php') as $line) {
    echo substr($line['hash'], 0, 8) . " {$line['content']}\n";
}

`Pitmaster\Graph\Grep`

PHP

public function grep(ObjectId $treeId, string $pattern, string $prefix = '', array $options = []): array

ツリー内のblobを検索します。一致した行ごとに['path' => string, 'line' => int, 'content' => string]を返します。オプション：regex（パターンをPCREパターンとして扱う）とignore_case。正規表現が無効な場合はInvalidArgumentExceptionをスローします。

PHP

use Pitmaster\Graph\Grep;

$grep = new Grep($repo->objectDatabase());
$matches = $grep->grep($repo->head()->tree, 'TODO', '', ['ignore_case' => true]);

`Pitmaster\Ref\Notes`

PHP

public function get(ObjectId $commitId, string $notesRef = 'refs/notes/commits'): ?string
public function set(ObjectId $commitId, string $noteContent, string $notesRef = 'refs/notes/commits'): void
public function remove(ObjectId $commitId, string $notesRef = 'refs/notes/commits'): void
public function listAll(string $notesRef = 'refs/notes/commits'): array
public function merge(string $sourceRef, string $targetRef = 'refs/notes/commits'): void

notes参照の下に保存されたgit notesを読み書きします。listAll()はコミットハッシュからノート内容への対応を返します。

PHP

use Pitmaster\Ref\Notes;

$notes = new Notes($repo->objectDatabase(), $repo->refDatabase());
$notes->set($repo->resolve('HEAD'), "Reviewed\n");
echo $notes->get($repo->resolve('HEAD'));

PHP API

Pitmaster\Pitmaster

open

init

clone

processFreeOptions

isRepository

isWorktree

commonGitDir

Pitmaster\Repository

パスアクセサー

gitDir

commonGitDir

workDir

isLinkedWorktree

isBare, hooksEnabled, processesEnabled

オブジェクト

readObject

writeObject

catFile

objectExists

listObjects

参照

head

branch

branches

tags

resolve

allRefs

updateRef

createBranch

deleteBranch

createLightweightTag

createTag

deleteTag

packRefs

defaultBranch

isBranchMerged

checkout

インデックス

index

add

remove

mv

コミット

commit

show

reset

restore

cherryPick

revert

rebase

ステータス

status

statusPorcelainV2

差分

diff

diffStaged

diffTree

ログ

log

logAll

logOneline

logPath

マージ

merge

mergeBase

二分探索

ネットワーク

fetch

push

ワークツリー

addWorktree

removeWorktree

worktrees

設定

config

内部アクセス

objectDatabase

refDatabase

`Pitmaster\Pitmaster`

`open`

`init`

`clone`

`processFreeOptions`

`isRepository`

`isWorktree`

`commonGitDir`

`Pitmaster\Repository`

`gitDir`

`commonGitDir`

`workDir`

`isLinkedWorktree`

`isBare`, `hooksEnabled`, `processesEnabled`

`readObject`

`writeObject`

`catFile`

`objectExists`

`listObjects`

`head`

`branch`

`branches`

`tags`

`resolve`

`allRefs`

`updateRef`

`createBranch`

`deleteBranch`

`createLightweightTag`

`createTag`

`deleteTag`

`packRefs`

`defaultBranch`

`isBranchMerged`

`checkout`

`index`

`add`

`remove`

`mv`

`commit`

`show`

`reset`

`restore`

`cherryPick`

`revert`

`rebase`

`status`

`statusPorcelainV2`

`diff`

`diffStaged`

`diffTree`

`log`

`logAll`

`logOneline`

`logPath`

`merge`

`mergeBase`

`fetch`

`push`

`addWorktree`

`removeWorktree`

`worktrees`

`config`

`objectDatabase`

`refDatabase`

`Pitmaster\Graph\Blame`

`Pitmaster\Graph\Grep`

`Pitmaster\Ref\Notes`