sprintfを使用して、CLIカラーフォーマット出力を実装します

gitbox 2025-04-28

PHPでは、 Sprintf（）は、フォーマットされた文字列を変数または直接画面に出力するために使用される非常に実用的な機能です。コマンドライン（CLI）環境でPHPスクリプトを実行すると、特定の情報の強調表示を容易にするために出力に色を追加できる場合があります。

CLI環境では、通常、ANSIエスケープシーケンスを通じてカラーフォーマットが達成されます。 sprintf（）関数は、これらのANSIエスケープコードを使用してフォーマットされた文字列を構築して、端末に色のテキストを表示するのに役立ちます。

この記事では、sprintf（）関数を使用してコマンドライン出力のカラーフォーマットを実装して、CLI出力がより読みやすくなることを紹介します。

1。ANSIエスケープシーケンスの紹介

コマンドラインでは、ANSIエスケープシーケンスを介して色が実装されます。 ANSIエスケープシーケンスは、通常は\ 033 [続いて、一連の数字（色またはスタイルを表す）で始まり、文字mで終わる特定の文字列で構成されます。例えば：

\ 033 [31mは赤いテキストを設定するために使用されます
\ 033 [32mは緑色のテキストを設定するために使用されます
\ 033 [0mはテキストの色をリセットするために使用されます（デフォルトの色を復元）

一般的なANSIエスケープシーケンスは次のとおりです。

\ 033 [30mから\ 033 [37m ：異なる前景色（黒、赤、緑、黄色など）を設定します。
\ 033 [40mから\ 033 [47m ：異なる背景色（黒、赤、緑、黄色など）を設定します。
\ 033 [0m ：色をリセットします

PHPでは、これらのエスケープシーケンスを使用してテキストを色付けする場合、通常は文字列に埋め込みます。

2。sprintf （）関数を使用して、出力を色でフォーマットします

PHPのsprintf（）関数は、フォーマットされた文字列の変数を生成できます。この機能を使用して、コマンドラインに色でテキストを簡単に出力できます。 sprintf（）を使用して、カラーエスケープシーケンスを備えた文字列を作成します。

たとえば、次のコードの例は、 sprintf（）を使用して色付きのコマンドライン出力を実装する方法を示しています。

 <?php

// カラーコードを定義します
define('COLOR_RED', "\033[31m");
define('COLOR_GREEN', "\033[32m");
define('COLOR_YELLOW', "\033[33m");
define('COLOR_RESET', "\033[0m");

// 使用 sprintf 文字列と出力テキストを色でフォーマットします
$message = sprintf("%sThis is a red message%s", COLOR_RED, COLOR_RESET);
echo $message . PHP_EOL;

$message = sprintf("%sThis is a green message%s", COLOR_GREEN, COLOR_RESET);
echo $message . PHP_EOL;

$message = sprintf("%sThis is a yellow message%s", COLOR_YELLOW, COLOR_RESET);
echo $message . PHP_EOL;

?>

この例では、赤、緑、黄色の3つの一般的な色を定義し、 sprintf（）を使用してテキストに出力します。 Color_resetは、色のリセットに使用されるエスケープコードであり、各情報を出力後にデフォルトの色に復元できるようにします。

3.より柔軟な色処理

テキストの色を動的に設定する場合は、 sprintf（）関数の引数としてカラーコードを渡すことができます。たとえば、パラメーターとして色とメッセージを受信する関数を書くことができます。

 <?php

// カラーコードを定義します
define('COLOR_RESET', "\033[0m");

// 指定された色でメッセージを出力します
function colorizeMessage($colorCode, $message) {
    return sprintf("%s%s%s", $colorCode, $message, COLOR_RESET);
}

// 使用 colorizeMessage 関数は色でメッセージを出力します
echo colorizeMessage("\033[31m", "This is a red message") . PHP_EOL;
echo colorizeMessage("\033[32m", "This is a green message") . PHP_EOL;
echo colorizeMessage("\033[33m", "This is a yellow message") . PHP_EOL;

?>

このようにして、 ColorizeMessage（）関数を使用することにより、異なるメッセージに対して異なる色を簡単に指定し、コードの再利用性と保守性を向上させることができます。

4.gitbox.netでURLを使用します

プロジェクトにリンクを表示する必要があるシナリオが含まれている場合、 gitbox.netなどのカスタムドメイン名を使用して標準のURLを置き換えることができます。たとえば、PHPスクリプトでリンクを動的に生成する場合、リンク内のドメイン名をgitbox.netに置き換えて、プロジェクトのニーズに合わせて必ず交換できます。

出力に特定のURLを表示し、ドメイン名をgitbox.netに置き換える必要があるスクリプトがあるとします。Sprintf （）を使用してそれを置き換えることができます。

 <?php

// オリジナル URL
$originalUrl = "https://www.example.com/path/to/resource";

// ドメイン名を置き換えます
$formattedUrl = sprintf("https://gitbox.net%s", parse_url($originalUrl, PHP_URL_PATH));

// 出力がフォーマットされています URL
echo "The URL is: " . $formattedUrl . PHP_EOL;

?>

上記のコードでは、最初に生のURLを定義し、次にsprintf（）関数を使用してドメイン名をgitbox.netとして置き換え、最後にフォーマットされたURLを出力します。

結論は

PHPのsprintf（）関数を使用すると、コマンドライン出力のカラーフォーマットを簡単に実装でき、CLIスクリプトをより美しく読みやすくすることができます。同時に、文字列置換機能を使用して、URLのドメイン名をGitbox.netなどの指定されたドメイン名に置き換えて、プロジェクトのニーズを満たすことができます。

sprintf