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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * log() 関数の計算結果を出力するサンプル
7 */
8function showLogCalculations(): void
9{
10    // --- 基本的な使い方: 自然対数を計算 ---
11    // log() は、第1引数に指定した数値の対数を計算します。
12    // 第2引数（底）を省略した場合、自然対数（底はネイピア数 e）が計算されます。
13    
14    // ネイピア数 e (約 2.718) の自然対数を計算します。結果は 1 になります。
15    $num1 = M_E;
16    $naturalLog = log($num1);
17
18    echo "ネイピア数 e の自然対数: " . $naturalLog . PHP_EOL; // 出力例: 1
19
20    // --- 応用的な使い方: 底を指定して対数を計算 ---
21    // 第2引数に底（base）を指定することで、常用対数など任意の底で計算できます。
22
23    // 100 を底 10 で対数計算します。結果は 2 になります (10^2 = 100 のため)。
24    $num2 = 100.0;
25    $base = 10.0;
26    $commonLog = log($num2, $base);
27
28    echo "100 の常用対数（底 10）: " . $commonLog . PHP_EOL; // 出力例: 2
29    
30    // 8 を底 2 で対数計算します。結果は 3 になります (2^3 = 8 のため)。
31    $num3 = 8.0;
32    $base2 = 2.0;
33    $logBase2 = log($num3, $base2);
34    
35    echo "8 の対数（底 2）: " . $logBase2 . PHP_EOL; // 出力例: 3
36}
37
38// 関数を実行して結果を出力します
39showLogCalculations();

PHPのlog()関数は、指定された数値の対数を計算するために使用されます。

この関数は最大2つの引数を受け取ります。第1引数$numには対数を求めたい数値を、第2引数$baseには対数の「底」となる数値を指定します。第2引数$baseは省略可能で、省略した場合は数学定数であるネイピア数e（PHPの定数M_E）が底として自動的に使われ、自然対数が計算されます。関数の戻り値は、計算結果の数値で、データ型は浮動小数点数（float）です。

サンプルコードでは、3つの異なる計算例を示しています。まず、ネイピア数M_Eを引数に与え、底を省略することで自然対数を計算し、結果として1が出力されます。次に、数値100を底10で対数計算（常用対数）し、10の2乗が100であるため結果は2となります。最後に、数値8を底2で計算し、2の3乗が8であるため結果は3となります。このようにlog()関数は、底を指定することで様々な対数計算に対応できます。

Copy
1<?php
2
3/**
4 * PHPのlog()関数（数学関数）の使用例を示します。
5 * この関数は数値の自然対数、または指定された底の対数を計算します。
6 * キーワード「場所」は、計算結果が標準出力（画面）に表示される「場所」として解釈しています。
7 *
8 * @param float $value 対数を計算する数値（0より大きい必要があります）
9 * @return void
10 */
11function demonstrateLogFunction(float $value): void
12{
13    echo "--- log() 関数の計算結果の表示 ---\n";
14    echo "対象数値: " . $value . "\n\n";
15
16    if ($value <= 0) {
17        echo "注意: 0以下の数値の対数は数学的に定義されていません。\n";
18        echo "結果は通常、-INF (負の無限大) または NAN (Not a Number) になります。\n";
19        echo "この値では計算結果の「場所」を示すことができません。\n\n";
20        return;
21    }
22
23    // 1. 自然対数を計算します (底がM_E、つまりネイピア数eの場合)。
24    // log() 関数に引数を1つだけ渡すと、自動的に自然対数になります。
25    $natural_log_result = log($value);
26    echo "自然対数 (底 e): " . $natural_log_result . "\n";
27    echo "これは、eを約 " . $natural_log_result . " 乗すると " . $value . " になることを意味します。\n\n";
28
29    // 2. 常用対数を計算します (底が10の場合)。
30    // log(num, base) の形式で、第2引数に底 (この場合は10) を指定します。
31    $common_log_result = log($value, 10);
32    echo "常用対数 (底 10): " . $common_log_result . "\n";
33    echo "これは、10を約 " . $common_log_result . " 乗すると " . $value . " になることを意味します。\n\n";
34
35    // 3. 二進対数を計算します (底が2の場合)。
36    $binary_log_result = log($value, 2);
37    echo "二進対数 (底 2): " . $binary_log_result . "\n";
38    echo "これは、2を約 " . $binary_log_result . " 乗すると " . $value . " になることを意味します。\n\n";
39
40    echo "--- 上記の計算結果は、標準出力（画面）に表示される「場所」に示されています ---\n";
41}
42
43// 様々な数値でlog()関数の動作を確認します。
44demonstrateLogFunction(10.0);
45echo "\n----------------------------------------\n\n";
46
47demonstrateLogFunction(1.0); // どんな底でも1の対数は0
48echo "\n----------------------------------------\n\n";
49
50demonstrateLogFunction(M_E); // ネイピア数eの自然対数は1
51echo "\n----------------------------------------\n\n";
52
53demonstrateLogFunction(100.0); // 100の常用対数は2
54echo "\n----------------------------------------\n\n";
55
56demonstrateLogFunction(8.0); // 8の二進対数は3
57echo "\n----------------------------------------\n\n";
58
59// 0以下の数値の対数は定義されないため、エラーメッセージが表示されます。
60demonstrateLogFunction(0.0);
61echo "\n----------------------------------------\n\n";
62
63demonstrateLogFunction(-5.0);

PHPのlog()関数は、指定した数値の対数を計算するための数学関数です。

この関数は、最大で2つの引数を取ります。第1引数には、対数を計算したい数値を指定します。第2引数には、対数の「底」となる数値を指定しますが、この引数は省略可能です。第2引数を省略した場合、自動的に「自然対数」（ネイピア数eを底とする対数）が計算されます。例えば、log(10.0)は10の自然対数を求めます。

もし特定の数値を底としたい場合は、第2引数にその値を指定します。例えば、10を底とする「常用対数」を計算したい場合は log(100.0, 10) のように記述します。この計算結果は「10を何乗すれば100になるか」という問いの答え、つまり2になります。

関数の戻り値は、計算された対数の値が浮動小数点数（float型）で返されます。

サンプルコードでは、log()関数で計算した自然対数、常用対数、二進対数の結果を、echoを使用して画面（標準出力）という「場所」に表示しています。なお、数学的に0以下の数値の対数は定義されていないため、引数に0や負の数を指定すると、期待通りの結果は得られません。

Copy
1<?php
2
3/**
4 * システムエンジニアを目指す初心者向けのシンプルなファイルロガー。
5 *
6 * アプリケーションのイベントやエラーメッセージを指定されたファイルに記録します。
7 * PHPの組み込み関数 `log` (数学的な対数関数) とは異なり、
8 * このクラスの `log` メソッドはメッセージの記録を目的としています。
9 */
10class SimpleFileLogger
11{
12    private string $logFilePath;
13
14    /**
15     * ロガーの新しいインスタンスを生成します。
16     *
17     * @param string $filePath ログメッセージを書き込むファイルのパス。
18     */
19    public function __construct(string $filePath)
20    {
21        $this->logFilePath = $filePath;
22        // ログファイルが存在しない場合は作成を試みる（または書き込み可能か確認）
23        if (!file_exists($this->logFilePath)) {
24            touch($this->logFilePath);
25        }
26        if (!is_writable($this->logFilePath)) {
27            throw new RuntimeException("ログファイル '{$this->logFilePath}' は書き込み可能ではありません。");
28        }
29    }
30
31    /**
32     * 指定されたメッセージとレベルでログエントリを記録します。
33     *
34     * @param string $message 記録するメッセージ。
35     * @param string $level   ログの重要度レベル（例: 'INFO', 'WARNING', 'ERROR'）。
36     */
37    public function log(string $message, string $level = 'INFO'): void
38    {
39        $timestamp = date('Y-m-d H:i:s');
40        // ログエントリのフォーマット: [日時] [レベル] メッセージ
41        $logEntry = sprintf("[%s] [%s] %s%s", $timestamp, strtoupper($level), $message, PHP_EOL);
42
43        // ファイルにログエントリを追記します。
44        // FILE_APPEND: ファイルの最後にデータを追記します。
45        // LOCK_EX: 排他ロックを取得し、同時書き込みによる競合を防ぎます。
46        if (file_put_contents($this->logFilePath, $logEntry, FILE_APPEND | LOCK_EX) === false) {
47            error_log("Failed to write to log file: {$this->logFilePath}");
48        }
49    }
50
51    /**
52     * 情報レベルのメッセージを記録します。
53     *
54     * @param string $message 記録する情報メッセージ。
55     */
56    public function info(string $message): void
57    {
58        $this->log($message, 'INFO');
59    }
60
61    /**
62     * 警告レベルのメッセージを記録します。
63     *
64     * @param string $message 記録する警告メッセージ。
65     */
66    public function warning(string $message): void
67    {
68        $this->log($message, 'WARNING');
69    }
70
71    /**
72     * エラーレベルのメッセージを記録します。
73     *
74     * @param string $message 記録するエラーメッセージ。
75     */
76    public function error(string $message): void
77    {
78        $this->log($message, 'ERROR');
79    }
80}
81
82// --- 使用例 ---
83
84// ログファイルを現在のスクリプトと同じディレクトリに作成
85$logFile = __DIR__ . '/application.log';
86
87try {
88    // SimpleFileLoggerのインスタンスを作成
89    $logger = new SimpleFileLogger($logFile);
90
91    // 異なるレベルのログメッセージを記録
92    $logger->info("アプリケーションの初期化が開始されました。");
93    $logger->warning("設定ファイルが見つかりません。デフォルト値を使用します。");
94
95    // 例外処理内でエラーを記録する例
96    try {
97        $result = 10 / 0; // ゼロ除算でエラーを発生させる
98    } catch (Throwable $e) {
99        $logger->error(
100            "処理中にエラーが発生しました: " . $e->getMessage() .
101            " (ファイル: " . $e->getFile() . ", 行: " . $e->getLine() . ")"
102        );
103    }
104
105    $logger->info("アプリケーションの処理が完了しました。");
106
107    echo "ログメッセージが '{$logFile}' に出力されました。\n";
108    echo "内容を確認するには、このファイルを開いてください。\n";
109
110} catch (RuntimeException $e) {
111    // ロガーの初期化に失敗した場合の処理
112    echo "エラー: ロガーの初期化に失敗しました - " . $e->getMessage() . "\n";
113}
114
115// --- ログファイルの内容を確認する（オプション） ---
116// スクリプト実行後、ターミナルで `cat application.log` などと実行して内容を確認できます。
117// または、以下のコメントアウトを外してスクリプトから直接表示することもできます。
118
119/*
120echo "\n--- ログファイルの内容 ---\n";
121if (file_exists($logFile)) {
122    echo file_get_contents($logFile);
123} else {
124    echo "ログファイルが見つかりません。\n";
125}
126*/

PHPには、数値の対数を計算する組み込み関数log（引数：数値 $num、底 $base、戻り値：数値）がありますが、このサンプルコードはそれとは異なる、独自のSimpleFileLoggerクラス内のlogメソッドを説明しています。このクラスは、アプリケーションのイベントやエラーメッセージをファイルに記録するロガー機能を提供します。

SimpleFileLoggerクラスのlogメソッドは、第一引数に記録したいメッセージ（文字列 $message）、第二引数にログの重要度（文字列 $level、省略時は'INFO'）を受け取ります。このメソッドは、現在の日時と指定されたレベル、メッセージを組み合わせ、整形されたログエントリとして指定のログファイルに追記します。戻り値はvoidであり、何も返さずにログ記録処理を完了します。

このlogメソッドを基盤として、info、warning、errorといった専用のメソッドも用意されており、それぞれの重要度に応じたログを簡単に記録できるようになっています。これにより、システムエンジニアがアプリケーションの動作状況を把握したり、問題発生時の原因究明を行ったりする際に役立つ情報を効率的に収集できます。

Copy
1<?php
2
3/**
4 * PHPロゴの青色(#4F5D95)に関連する数値の対数を計算し、出力する関数。
5 *
6 * この関数は、PHPのlog()関数の基本的な使い方を、
7 * PHPロゴのカラーコードを例に示します。
8 * log()関数は、与えられた数値の対数を計算します。
9 * 第2引数(底)を省略した場合、自然対数(底がM_E、約2.71828)が計算されます。
10 *
11 * @return void
12 */
13function calculatePhpLogoRelatedLogarithms(): void
14{
15    // PHPロゴの代表的な青色（#4F5D95）の16進数カラーコードを定義します。
16    // この値を対数計算の対象として使用します。
17    $phpLogoBlueHex = '4F5D95';
18    // 16進数カラーコードを10進数の数値に変換します。
19    // `hexdec()` 関数は16進数の文字列を10進数の整数に変換します。
20    $phpLogoBlueDecimal = hexdec($phpLogoBlueHex);
21
22    echo "PHPロゴの青色カラーコード (#{$phpLogoBlueHex}) を10進数に変換: {$phpLogoBlueDecimal}\n\n";
23
24    // 1. 数値の自然対数を計算します。
25    // `log($num)` の形式で呼び出します。
26    // 底は定数 M_E (オイラー数、約2.71828) です。
27    $naturalLog = log($phpLogoBlueDecimal);
28    echo "{$phpLogoBlueDecimal} の自然対数 (底: M_E): " . $naturalLog . "\n";
29
30    // 2. 数値の10を底とする対数を計算します。
31    // `log($num, $base)` の形式で呼び出します。
32    // ここでは底として10を指定しています。
33    $base10Log = log($phpLogoBlueDecimal, 10);
34    echo "{$phpLogoBlueDecimal} の10を底とする対数: " . $base10Log . "\n";
35
36    // 3. 数値の2を底とする対数を計算します。
37    // コンピュータサイエンスでは2を底とする対数がよく使われます。
38    $base2Log = log($phpLogoBlueDecimal, 2);
39    echo "{$phpLogoBlueDecimal} の2を底とする対数: " . $base2Log . "\n";
40}
41
42// 上で定義した関数を実行します。
43calculatePhpLogoRelatedLogarithms();

PHPのlog()関数は、与えられた数値の対数を計算するために使用される関数です。この関数は、数学的な計算を行う際に役立ちます。

最初の引数$numには対数を計算したい数値を浮動小数点数で指定します。2番目の引数$baseには対数の底を浮動小数点数で指定しますが、この引数は省略可能です。$baseを省略した場合、自然対数（底が定数M_E、約2.71828）が計算されます。関数の戻り値は、計算された対数の結果を浮動小数点数で返します。

サンプルコードでは、PHPロゴの代表的な青色の16進数カラーコード「#4F5D95」を10進数に変換した数値「5209589」を例に、log()関数の基本的な使い方を示しています。まず、引数$baseを省略して自然対数を計算し、次にlog($num, 10)のように底を10と指定して常用対数を計算しています。さらに、コンピュータサイエンスでよく使われる底が2の対数も計算しており、引数によって様々な底の対数を簡単に求められることがわかります。