【PHP8.x】sprintf()関数の使い方

Copy
1<?php
2
3/**
4 * sprintf 関数を使って数値を0埋めするサンプル
5 *
6 * @param int $number 対象の数値
7 * @param int $length 桁数
8 * @return string 0埋めされた文字列
9 */
10function zeroPadding(int $number, int $length): string
11{
12    // sprintf関数で0埋めを行う
13    return sprintf("%0{$length}d", $number);
14}
15
16// 使用例
17$number = 123;
18$length = 5;
19$zeroPaddedNumber = zeroPadding($number, $length);
20
21// 結果を出力
22echo $zeroPaddedNumber . PHP_EOL; // "00123" が出力される

PHPのsprintf関数は、指定されたフォーマット文字列に基づいて文字列を生成する関数です。この関数を利用することで、数値の0埋めを簡単に行うことができます。

上記のサンプルコードでは、zeroPaddingという関数を定義しています。この関数は、0埋めしたい数値$numberと、桁数$lengthを引数として受け取ります。

sprintf("%0{$length}d", $number)という部分が、実際に0埋めを行っている箇所です。%0{$length}dは、sprintf関数におけるフォーマット指定子であり、%dは整数を表し、0は0埋めを行うことを、{$length}は桁数を指定することを意味します。sprintf関数は、このフォーマット指定子に従って、$numberを0埋めした文字列に変換します。

例えば、$numberが123で$lengthが5の場合、sprintf関数は%05dというフォーマットで123を処理します。結果として、"00123"という文字列が生成され、zeroPadding関数の戻り値として返されます。

このサンプルコードでは、zeroPadding関数を呼び出し、結果をechoで出力しています。これにより、画面に"00123"という0埋めされた数値が表示されます。sprintf関数を使うことで、桁数を意識した文字列整形を柔軟に行うことができます。

Copy
1<?php
2
3/**
4 * sprintf関数を使って、小数点以下の桁数を指定して数値を文字列にフォーマットする例。
5 */
6function formatDecimal(float $number, int $precision): string
7{
8    // %に続くfは浮動小数点数を意味し、.[桁数]で小数点以下の桁数を指定。
9    $formattedString = sprintf("%.{$precision}f", $number);
10    return $formattedString;
11}
12
13// 例: 円周率を小数点以下2桁でフォーマット
14$pi = 3.14159265359;
15$formattedPi = formatDecimal($pi, 2);
16echo "円周率: " . $formattedPi . PHP_EOL; // 出力: 円周率: 3.14
17
18// 例: 価格を小数点以下0桁でフォーマット
19$price = 99.99;
20$formattedPrice = formatDecimal($price, 0);
21echo "価格: " . $formattedPrice . PHP_EOL; // 出力: 価格: 100

sprintf関数は、指定されたフォーマット文字列に基づいて文字列を生成する関数です。引数には、フォーマット文字列 $format と、それに埋め込む値 $values を指定します。フォーマット文字列には、プレースホルダと呼ばれる特殊な記号が含まれており、$values の値が対応するプレースホルダに置き換えられます。

このサンプルコードでは、sprintf関数を使って浮動小数点数を指定した桁数でフォーマットする方法を示しています。formatDecimal関数は、浮動小数点数 $number と小数点以下の桁数 $precision を受け取り、sprintf関数を使ってフォーマットされた文字列を返します。

フォーマット文字列 %.{$precision}f は、浮動小数点数をフォーマットするためのものです。% はプレースホルダの開始を示し、f は浮動小数点数であることを意味します。.{$precision} は小数点以下の桁数を指定する部分で、{$precision} の部分には、引数で渡された $precision の値が展開されます。例えば、$precision が 2 の場合、フォーマット文字列は %.2f となり、小数点以下2桁でフォーマットされます。

サンプルコードでは、円周率と価格をそれぞれ異なる桁数でフォーマットし、結果を出力しています。sprintf関数を使うことで、数値の表示形式を柔軟に制御できます。sprintf関数は文字列を返し、フォーマットに失敗した場合はNULLを返します。

Copy
1<?php
2
3// sprintf関数は、指定されたフォーマット文字列に従って値を整形し、その結果の文字列を返します。
4// 主に、変数や定数の値を特定の形式で文字列に埋め込む際に使用されます。
5
6// 例1: 基本的な文字列のフォーマット
7$name = 'システムエンジニア';
8// %s は文字列の値を受け取り、その位置に挿入します。
9$greeting = sprintf('こんにちは、%sを目指す皆さん！', $name);
10echo $greeting . "\n";
11
12// 例2: 整数のフォーマット
13$courseDurationMonths = 6;
14$totalLessons = 30;
15// %d は整数（Decimal）の値を受け取り、その位置に挿入します。
16$summary = sprintf('このコースは%dヶ月間で、全%d回のレッスンがあります。', $courseDurationMonths, $totalLessons);
17echo $summary . "\n";
18
19// 例3: 浮動小数点数のフォーマット（小数点以下の桁数指定）
20$progressPercentage = 75.345;
21// %.1f は浮動小数点数（Float）の値を小数点以下1桁で表示します。
22// %.2f とすれば小数点以下2桁、といった形で制御できます。
23$formattedProgress = sprintf('現在の学習進捗率は %.1f%% です。', $progressPercentage);
24echo $formattedProgress . "\n";
25
26// 例4: 複数の異なる型を一度にフォーマット
27$language = 'PHP';
28$version = 8;
29$experienceYears = 0.5; // 半年
30// 複数の指定子を組み合わせて、複雑な文字列も整形できます。
31$profile = sprintf('学習言語: %s (バージョン %d), 実務経験: %.1f年', $language, $version, $experienceYears);
32echo $profile . "\n";
33
34?>

PHPのsprintf関数は、指定されたフォーマット（書式）に従って複数の値を整形し、その結果の文字列を生成して返す関数です。主に、変数や定数の値を特定の形式で文字列に埋め込みたい場合や、報告書、ログ出力などで統一されたフォーマットの文字列を作成する際に使用されます。

この関数は、まず一つ目の引数string $formatに、どのように文字列を整形するかを定義する「型板」となる文字列を受け取ります。この型板の中には、%s（文字列）、%d（整数）、%.1f（小数点以下1桁の浮動小数点数）のような「変換指定子」を含めることができ、これらの位置に後続の値を埋め込むことを指示します。二つ目以降の引数mixed ...$valuesには、それぞれの変換指定子に対応する値を順番に渡します。sprintf関数は、これらの引数をもとに整形処理を行い、完成した文字列を戻り値として返します。例えば、氏名やコース期間、学習進捗率などの情報を決まった文面に組み込む際に、文字列の結合だけでは難しい小数点以下の桁数指定や数値の制御も柔軟に行うことができます。

Copy
1<?php
2
3/**
4 * sprintf関数を使用して文字列や数値をフォーマットする基本的なサンプルです。
5 * %s は文字列を挿入するためのプレースホルダです。
6 */
7function formatBasicDataWithSprintf(): void
8{
9    // 例1: 文字列をフォーマットする (%s)
10    $name = "エンジニア";
11    $greeting = sprintf("こんにちは、未来の%sさん！", $name);
12    echo "文字列フォーマット: " . $greeting . "\n";
13
14    // 例2: 複数の異なる型のデータをフォーマットする
15    // %s: 文字列, %d: 整数, %.2f: 小数点以下2桁の浮動小数点数
16    $product = "PHP学習ガイド";
17    $price = 29.99;
18    $quantity = 1;
19
20    $orderSummary = sprintf(
21        "%sを%d冊購入しました。合計金額は$%.2fです。",
22        $product,
23        $quantity,
24        $price * $quantity
25    );
26    echo "複数データ型フォーマット: " . $orderSummary . "\n";
27}
28
29// 関数を実行し、結果を出力
30formatBasicDataWithSprintf();
31
32?>

PHPのsprintf関数は、指定されたフォーマット（書式）に従って、文字列や数値を整形し、新しい文字列を生成する関数です。この関数は、レポート作成やログ出力など、定型文に動的なデータを埋め込む際に非常に便利です。

最初の引数$formatには、整形するための書式指定文字列を渡します。この文字列の中には、データを挿入する位置を示す「プレースホルダ」を含めることができます。例えば、%sは文字列、%dは整数、%.2fは小数点以下2桁の浮動小数点数を挿入するためのプレースホルダです。続く引数...$valuesには、これらのプレースホルダに挿入したい値を、書式の登場順に複数指定できます。関数は整形された結果の文字列を戻り値として返します。

サンプルコードでは、まず%sを使って変数$nameの文字列を挿入し、「こんにちは、未来のエンジニアさん！」という挨拶文を生成しています。次に、%sで文字列、%dで整数、%.2fで小数点以下2桁の浮動小数点数を組み合わせて、商品名、購入数、合計金額を含む注文概要を作成しています。このように、sprintfを使用することで、様々なデータ型の情報を組み合わせて、見やすい文字列を簡単に整形できることがわかります。