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

Copy
1<?php
2
3/**
4 * プログラミング言語PHPのbase_convert関数を使用して、異なる基数の間で数値を変換する例です。
5 * 特に、比較的大きな数値を文字列として扱い、基数変換を行う方法を示します。
6 *
7 * base_convert関数は、基数2から基数36までの間で数値を変換できます。
8 * 注意: base_convertは内部で浮動小数点数を使用する場合があるため、
9 * 非常に大きな整数を扱う際には精度が失われる可能性があります。
10 * この例では、一般的な64ビット整数に相当する範囲の数値を扱います。
11 */
12function convertLargeNumberBases(): void
13{
14    // 変換する大きな数値（16進数文字列として表現）
15    // この値は、一般的な32ビット整数型では扱えない「大きな数値」です。
16    $hexNumber = "DEADBEEFCAFEBABE";
17    echo "元の16進数 (base 16): " . $hexNumber . PHP_EOL;
18
19    // 16進数 (base 16) を2進数 (base 2) に変換
20    // 第1引数: 変換元の数値文字列
21    // 第2引数: 変換元の基数 (16進数なので16)
22    // 第3引数: 変換先の基数 (2進数なので2)
23    $binaryNumber = base_convert($hexNumber, 16, 2);
24    echo "2進数 (base 2) に変換: " . $binaryNumber . PHP_EOL;
25
26    // 2進数 (base 2) を10進数 (base 10) に変換
27    // 変換結果は文字列として返されるため、非常に長い10進数になる可能性があります。
28    $decimalNumber = base_convert($binaryNumber, 2, 10);
29    echo "10進数 (base 10) に変換: " . $decimalNumber . PHP_EOL;
30
31    // 10進数 (base 10) を元の16進数 (base 16) に戻す
32    // base_convertは結果のアルファベットを小文字で返します。
33    $revertedHexNumber = base_convert($decimalNumber, 10, 16);
34    echo "元の16進数 (base 16) に戻す (小文字): " . $revertedHexNumber . PHP_EOL;
35
36    // 元の16進数と戻した16進数を比較 (大文字・小文字を無視して比較)
37    if (strtolower($hexNumber) === $revertedHexNumber) {
38        echo "変換と逆変換は成功しました。" . PHP_EOL;
39    } else {
40        echo "変換と逆変換で不一致が発生しました。" . PHP_EOL;
41    }
42}
43
44// 関数を実行して変換処理を開始
45convertLargeNumberBases();
46
47?>

PHPのbase_convert関数は、数値の基数（進数）を変換するために使用されます。この関数は3つの引数を取ります。最初の$numには変換したい数値を文字列として指定し、2番目の$from_baseにはその数値が現在どの基数で表現されているかを整数で指定します。最後の$to_baseには、変換したい先の基数を整数で指定します。戻り値は変換された数値を表す文字列です。基数は2から36までの間で変換可能です。ただし、内部で浮動小数点数を使用する可能性があり、非常に大きな数値を扱うと精度が失われることがあるため注意が必要です。

このサンプルコードでは、一般的な64ビット整数に相当する範囲の「大きな数値」を文字列として扱い、その基数変換の挙動を示しています。具体的には、16進数で表現された大きな数値を指定し、それをbase_convert関数を使って2進数、さらに10進数へと順に変換しています。最終的に10進数から元の16進数へ戻すことで、変換の正確性を確認しています。変換結果はすべて文字列として扱われるため、非常に長い数値でも正しく処理されますが、base_convert関数は結果のアルファベットを小文字で返す点に留意してください。

Copy
1<?php
2
3/**
4 * 10進数の数値を62進数の文字列に変換します。
5 *
6 * PHPの組み込み関数 `base_convert()` は、変換可能な基数 (base) が
7 * 2から36の範囲に制限されています。そのため、URL短縮などで利用される
8 * 62進数（0-9, a-z, A-Z）への変換は `base_convert()` では直接行えません。
9 *
10 * このサンプルコードは、`base_convert()` の代替として、
11 * 10進数から62進数への変換を行うカスタム関数を提供します。
12 *
13 * @param int $decimalNumber 変換する非負の10進整数
14 * @return string 62進数に変換された文字列
15 */
16function convertDecimalToBase62(int $decimalNumber): string
17{
18    // 62進数で使用する文字セットを定義します (0-9, a-z, A-Z)。
19    $characterSet = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
20    $base = strlen($characterSet); // 基数は62
21    $base62String = '';
22
23    // 引数が0の場合は、'0'を返します。
24    if ($decimalNumber === 0) {
25        return '0';
26    }
27
28    $num = $decimalNumber;
29
30    // 10進数の数値を62で割り続け、その余りから対応する文字を特定します。
31    while ($num > 0) {
32        // 余りを計算し、文字セットから対応する文字を取得します。
33        $remainder = $num % $base;
34        $base62String = $characterSet[$remainder] . $base62String;
35
36        // 次の計算のために、商を整数値で求めます。
37        $num = (int)floor($num / $base);
38    }
39
40    return $base62String;
41}
42
43// ---- 関数の使用例 ----
44
45// データベースのIDなどを想定した10進数の数値
46$id = 1_234_567_890;
47
48// 10進数を62進数に変換します。
49$shortCode = convertDecimalToBase62($id);
50
51// 結果を出力します。
52echo "10進数の {$id} は、62進数では '{$shortCode}' です。" . PHP_EOL;
53
54// 比較: base_convert() で扱える最大の36進数に変換した場合
55$base36Code = base_convert((string)$id, 10, 36);
56echo "10進数の {$id} は、36進数では '{$base36Code}' です。" . PHP_EOL;
57
58?>

PHPのbase_convert関数は、ある基数（N進数）の数値を別の基数（M進数）の数値に変換するために使用される組み込み関数です。引数$numには変換したい数値を文字列として、$from_baseには変換元の基数を、$to_baseには変換先の基数を整数で指定します。戻り値は変換された数値を文字列として返しますが、この関数が対応する基数は2から36までの範囲に制限されています。そのため、URL短縮などで利用される62進数（0-9, a-z, A-Z）のような、より大きな基数への変換は直接行えません。

このサンプルコードは、base_convertの制限を補い、10進数を62進数の文字列に変換するためのカスタム関数convertDecimalToBase62を提供しています。この関数は、引数$decimalNumberとして変換したい非負の10進整数を受け取り、62進数に変換された文字列を戻り値として返します。関数内部では、62種類の文字（0-9, a-z, A-Z）を定義し、与えられた10進数を62で割り続け、その都度発生する余りに対応する文字を連結していくことで62進数表現を生成しています。

サンプルコードでは、10進数「1,234,567,890」をconvertDecimalToBase62関数で62進数に変換し、その結果を表示しています。比較のために、同じ10進数をbase_convert関数が対応する最大の36進数に変換した場合の例も示されており、62進数変換の必要性と機能が具体的に理解できます。

Copy
1<?php
2
3/**
4 * base_convert() 関数は、ある基数 (例: 10進数、2進数、16進数) の数値を
5 * 別の基数の数値に変換するために使用されます。
6 *
7 * 引数:
8 * - string $num: 変換したい数値文字列。
9 * - int $from_base: 変換元の基数 (2から36までの整数)。
10 * - int $to_base: 変換先の基数 (2から36までの整数)。
11 *
12 * 戻り値:
13 * - string: 変換された数値文字列。
14 */
15
16// 例1: 10進数を16進数に変換する
17$decimalNumber = "255"; // 10進数の255
18$hexadecimalNumber = base_convert($decimalNumber, 10, 16);
19echo "10進数 '{$decimalNumber}' は16進数で '{$hexadecimalNumber}' です。\n";
20// 出力: 10進数 '255' は16進数で 'ff' です。
21
22// 例2: 16進数を10進数に変換する
23$hexadecimalValue = "ff"; // 16進数のff
24$decimalValue = base_convert($hexadecimalValue, 16, 10);
25echo "16進数 '{$hexadecimalValue}' は10進数で '{$decimalValue}' です。\n";
26// 出力: 16進数 'ff' は10進数で '255' です。
27
28// 例3: 2進数を10進数に変換する
29$binaryNumber = "11111111"; // 2進数の11111111
30$decimalFromBinary = base_convert($binaryNumber, 2, 10);
31echo "2進数 '{$binaryNumber}' は10進数で '{$decimalFromBinary}' です。\n";
32// 出力: 2進数 '11111111' は10進数で '255' です。
33
34// 例4: 10進数を2進数に変換する
35$anotherDecimal = "10"; // 10進数の10
36$binaryFromDecimal = base_convert($anotherDecimal, 10, 2);
37echo "10進数 '{$anotherDecimal}' は2進数で '{$binaryFromDecimal}' です。\n";
38// 出力: 10進数 '10' は2進数で '1010' です。
39
40?>

PHPのbase_convert関数は、ある数値表現形式（基数、例えば10進数、2進数、16進数など）の値を、別の表現形式へ変換するために使用される便利な関数です。システム開発において、数値の基数を変更する必要がある場面で役立ちます。

この関数は、変換したい数値を表す文字列を一つ目の引数$numとして受け取ります。二つ目の引数$from_baseには、変換元の基数を2から36までの整数で指定します。三つ目の引数$to_baseには、変換先の基数を同じく2から36までの整数で指定します。そして、変換された数値を文字列として返します。

サンプルコードでは、10進数の「255」を16進数の「ff」へ、またその逆の変換を行う例が示されています。他にも2進数と10進数、あるいは2進数と16進数といった、様々な基数間の相互変換が可能です。この関数を使うことで、プログラミングにおいて数値の基数変換を簡単かつ正確に行うことができ、特にバイナリデータやハッシュ値などを扱う際に、人間が読みやすい形式へ変換するのに重宝します。

Copy
1<?php
2
3/**
4 * 指定された画像ファイルをBase64エンコードされたデータURI文字列に変換します。
5 * この関数は、HTMLのimgタグのsrc属性やCSSのbackground-imageプロパティに
6 * 画像データを直接埋め込む際に特に便利です。
7 *
8 * @param string $imagePath 変換する画像ファイルへのパス。
9 * @return string|false Base64エンコードされた画像データURI文字列、
10 *                      またはファイルが存在しない、読み取れない、
11 *                      MIMEタイプが特定できない場合にfalse。
12 */
13function convertImageToBase64DataUri(string $imagePath): string|false
14{
15    // 1. ファイルが存在し、読み込み可能かを確認
16    if (!file_exists($imagePath) || !is_readable($imagePath)) {
17        // ファイルが見つからないか、読み込み権限がない場合はfalseを返す
18        return false;
19    }
20
21    // 2. 画像ファイルの内容をバイナリ形式で読み込む
22    $imageData = file_get_contents($imagePath);
23    if ($imageData === false) {
24        // ファイル内容の読み込みに失敗した場合はfalseを返す
25        return false;
26    }
27
28    // 3. 画像ファイルのMIMEタイプを特定する
29    // 例: "image/png", "image/jpeg", "image/gif" など
30    $mimeType = mime_content_type($imagePath);
31    if ($mimeType === false) {
32        // MIMEタイプの特定に失敗した場合はfalseを返す
33        return false;
34    }
35
36    // 4. バイナリデータをBase64形式にエンコードする
37    $base64EncodedData = base64_encode($imageData);
38
39    // 5. "data URI" スキーム形式で文字列を構築して返す
40    // 形式: data:[<MIME-type>][;charset=<encoding>][;base64],<data>
41    return "data:{$mimeType};base64,{$base64EncodedData}";
42}
43
44// --- 使用例 ---
45
46// 単体で動作確認するために、一時的なテスト用PNG画像を生成します。
47// 実際の使用時には、既存の画像ファイルのパスを指定してください。
48$testImagePath = __DIR__ . '/temp_test_image.png';
49
50// テスト画像を生成
51if (!file_exists($testImagePath)) {
52    // 1x1ピクセルの透明なPNG画像を生成
53    $img = imagecreatetruecolor(1, 1);
54    if ($img !== false) {
55        imagesavealpha($img, true);
56        $color = imagecolorallocatealpha($img, 0, 0, 0, 127); // 完全透明
57        imagefill($img, 0, 0, $color);
58        imagepng($img, $testImagePath);
59        imagedestroy($img);
60        echo "テスト画像 '{$testImagePath}' を生成しました。\n";
61    } else {
62        echo "GD拡張が有効でないため、テスト画像を生成できませんでした。既存の画像パスを指定してください。\n";
63        // GD拡張がない場合はここで処理を終了するか、既存の画像パスに切り替える
64        // 今回はGDがないとテストできないため、実質的にGD依存
65        exit(1);
66    }
67} else {
68    echo "既存のテスト画像 '{$testImagePath}' を使用します。\n";
69}
70
71// 画像ファイルをBase64データURIに変換
72$base64DataUri = convertImageToBase64DataUri($testImagePath);
73
74if ($base64DataUri !== false) {
75    echo "\n--- 変換成功 ---\n";
76    echo "Base64データURI (先頭100文字): " . substr($base64DataUri, 0, 100) . "...\n";
77    echo "\nこのデータURIは、HTMLで次のように使用できます:\n";
78    echo '<img src="' . htmlspecialchars($base64DataUri) . '" alt="Example Base64 Image">' . "\n";
79    echo "\nCSSでは次のように使用できます:\n";
80    echo '.my-element { background-image: url(\'' . htmlspecialchars($base64DataUri) . '\'); }' . "\n";
81} else {
82    echo "\n--- 変換失敗 ---\n";
83    echo "エラー: 画像ファイル '{$testImagePath}' をBase64データURIに変換できませんでした。\n";
84    echo "ファイルが存在しないか、読み取れないか、MIMEタイプが特定できませんでした。\n";
85}
86
87// 存在しないファイルを指定した場合の例
88echo "\n--- 存在しないファイルでのテスト ---\n";
89$nonExistentPath = __DIR__ . '/non_existent_image.jpg';
90$failedConversion = convertImageToBase64DataUri($nonExistentPath);
91if ($failedConversion === false) {
92    echo "エラー: 存在しないファイル '{$nonExistentPath}' の変換は失敗しました (期待される動作)。\n";
93} else {
94    echo "警告: 存在しないはずのファイルの変換に成功しました (予期せぬ動作)。\n";
95}
96
97// テスト用に生成した一時ファイルをクリーンアップ
98if (file_exists($testImagePath)) {
99    unlink($testImagePath);
100    echo "\nテスト画像 '{$testImagePath}' を削除しました。\n";
101}
102
103?>

このPHPサンプルコードは、指定された画像ファイルを、ウェブページに直接埋め込むことが可能なBase64エンコードされたデータURI形式に変換する方法を示しています。システムエンジニアを目指す初心者の方にも理解しやすいよう、具体的な処理の流れが丁寧に実装されています。

主要な関数であるconvertImageToBase64DataUriは、変換したい画像ファイルへのパスを文字列型の引数$imagePathとして受け取ります。この関数はまず、ファイルが存在し、かつ読み込み可能であるかを確認します。その後、file_get_contents関数を用いて画像ファイルの内容をバイナリ形式で読み込み、さらにmime_content_type関数でその画像のMIMEタイプ（例: "image/png"や"image/jpeg"など）を特定します。

これらの情報が揃った後、読み込んだバイナリデータをbase64_encode関数によってBase64形式の文字列にエンコードします。最後に、特定されたMIMEタイプとBase64エンコードされたデータを結合し、「data:MIMEタイプ;base64,エンコードデータ」という形式のデータURI文字列を構築して返します。この戻り値は、HTMLの<img>タグのsrc属性やCSSのbackground-imageプロパティなどに直接記述して画像を表示できます。ファイルが見つからない、読み取れない、またはMIMEタイプが特定できないといったエラーが発生した場合は、戻り値としてfalseを返します。