sprintf

(PHP 3, PHP 4 , PHP 5)

sprintf -- フォーマットされた文字列を返す

説明

string sprintf ( string format [, mixed args])

フォーマット文字列formatに基づき生成された 文字列を返します。

フォーマット文字列は0個以上のディレクティブ(指示子)により 構成されます。ディレクティブには、そのまま結果にコピーされる (%を除く)通常の文字と変換指定子 (conversion specifications)があり、取り出される際は どちらもそれ自身がパラメータとなります。このことは sprintf()の場合だけでなくprintf() の場合も同様です。

各変換指定子はパーセント記号(%)の後に、これら の要素が一つ以上続いたものになります。

  1. オプションのパディング指定子。これは、 文字列が正しい長さになるまでどんな文字で埋めるかということを 指定します。これは空白かまたは0(文字'0') のいずれかです。デフォルトでは空白で埋められます。 これ以外のパディング文字を指定するには、その文字の前に単一 引用符(')を置きます。後述の例を参照して ください。

  2. オプションのアラインメント指定子。これは 結果を左寄せまたは右寄せにしたい場合に指定します。デフォルトは 右寄せです。ここで-文字を指定すると左寄せ となります。

  3. オプションの数字。これは表示幅指定子です。 結果を(最低)何桁にするかを指定します。

  4. オプションの精度指定子。これは、浮動小数点 数に対して何個の数字を表示するか??定します。このオプションは、 double(倍精度)型以外には何の効果もありません。 (数字をフォーマットする際に便利な関数として他に number_format() があります。)

  5. 型指定子。引数を何の型として扱うかを指定 します。指定できる型を以下に示します。

    % - パーセント文字。引数は不要です。
    b - 引数を整数として扱い、バイナリの数値 として表現します。
    c - 引数を整数として扱い、その ASCII 値 の文字として表現します。
    d - 引数を整数として扱い、10 進数として 表現します。
    u - 引数を整数として扱い、符号無しの10進 数として表現します。
    f - 引数を double として扱い、浮動小数点数 として表現します。
    o - 引数を整数として扱い、8 進数として 表現します。
    s - 引数を文字列として扱い、表現します。
    x - 引数を整数として扱い、16 進数として (小文字で)表現します。
    X - 引数を整数として扱い、16 進数として (大文字で)表現します。

PHP バージョン 4.0.6 でフォーマット文字列で引数の番号付け/交換が サポートされました。以下に例を示します。

例 1. 引数の交換

$format = "There are %d monkeys in the %s";
printf($format,$num,$location);
この出力は、"There are 5 monkeys in the tree" のようになります。 ここで、フォーマット文字列が別のファイルにある場合を考えてみましょ う。これは、出力を国際化したりする場合に行われる可能性があります。 この場合、次の書き変えられます。

例 2. 引数の交換

$format = "The %s contains %d monkeys";
printf($format,$num,$location);
ここで、問題が発生します。フォーマット文字列における置換指示子の 順番は、コードにおける引数の順番と一致していません。コードは変更 せず、置換指示子が参照するフォーマット文字列で指示を行う方が望ま しいと言えます。フォーマット文字列を次のように書き換えてみましょ う。

例 3. 引数の交換

$format = "The %2\$s contains %1\$d monkeys";
printf($format,$num,$location);
加えて、これによりコードに引数を追加せずに置換指示子を複数回使用 することも可能になります。例えば、次のようになります。

例 4. 引数の交換

$format = "The %2\$s contains %1\$d monkeys.  
           That's a nice %2\$s full of %1\$d monkeys.";
printf($format,$num,$location);

printf(), sscanf(), fscanf(), number_format() も参照下さい。

例 5. sprintf: 整数を0でパディング

$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);

例 6. sprintf: 通貨をフォーマットする例

$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
// echo $money は "123.1" を出力します。
$formatted = sprintf ("%01.2f", $money);
// echo $formatted は "123.10"を出力します