指定したリポジトリ URL のコミットログメッセージを返す

説明

array svn_log ( string $repos_url [, int $start_revision [, int $end_revision [, int $limit [, int $flags ]]]] )

svn_log() は、指定したリビジョン URL repos_url の中身の完全な履歴を返します。 start_revision を指定した場合は、そのリビジョンの履歴を返します。この関数は、svn log --verbose -r $start_revision $repos_url と同等です。

警告

長い期間使用しているリポジトリでは、出力が巨大なものになる可能性があります (すべてのリビジョンに対して配列の項目ができあがります)。この関数は --limit NUM フラグをサポートしていません。また、リビジョンの範囲指定にも対応していません (start_revision は整数で指定しなければなりません)。

パラメータ

repos_url: 履歴を取得したいアイテムのリポジトリ URL。
start_revision: ログを取得したい最初のリビジョン番号。直近のリビジョンからのログを取得する場合は SVN_REVISON_HEAD を使用します。
end_revision: ログを取得したい最後のリビジョン番号。デフォルトは、 start_revision を指定した場合はそれと同じで指定しなかった場合は SVN_REVISION_INITIAL となります。
limit: 取得したいログの数。
flags: SVN_OMIT_MESSAGES、 SVN_DISCOVER_CHANGED_PATHS および SVN_STOP_ON_COPY の任意の組み合わせ。デフォルトは SVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY 。

返り値

成功した場合は、この関数は次のような構造の配列を返します。

[0] => Array (最新のリポジトリから順に並びます)
(
    [rev] => リビジョン番号
    [author] => コミットした人の名前
    [msg] => ログメッセージ
    [date] => ISO 8601 形式、つまり date('c') と同じ形式の日付文字列
    [paths] => Array (変更したファイルについての説明)
        (
            [0] => Array
                (
                    [action] => 変更の種類を表す文字
                    [path] =>  変更されたファイルの絶対パス
                )
            [1] => ...
        )
)
[1] => ...

注意: 出力は、常に数値添字の二次元配列となります。ログメッセージがなかったり、ひとつだけだったりする場合でも同じです。

action の値は、 » status の出力の最初の列の内容のサブセットで、以下のいずれかとなります。

**アクション**
文字	説明
M	アイテム/プロパティが変更されました
A	アイテムが追加されました
D	アイテムが削除されました
R	アイテムが置き換えられました

何も変更されていない場合は、空の配列を返します。

注意

警告

この関数は、 実験的 なものです。この関数の動作・名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP のリリースにおいて変更される可能性があります。この関数は自己責任で使用してください。

例

例1 svn_log() の例


<?php
print_r( svn_log('http://www.example.com/', 23) );
?>

上の例の出力は、たとえば以下のようになります。

Array
(
    [0] => Array
    (
        [rev] => 23
        [author] => 'joe'
        [msg] => 'チーズとサラミをサンドイッチに追加した。'
        [date] => '2007-04-06T16:00:27-04:00'
        [paths] => Array
            (
                [0] => Array
                    (
                        [action] => 'M'
                        [path] =>  '/sandwich.txt'
                    )
            )
    )
)

参考

» SVN ドキュメントの svn log