【PHP8.x】MON_9定数の使い方

Copy
1<?php
2
3/**
4 * プログラミング言語リファレンス情報に基づく定数 MON_9 を定義します。
5 * この定数は、PHPの拡張機能の一部として提供される架空の定数を想定しており、
6 * モナドに関連する何らかの設定値や識別子として利用されることを示唆しています。
7 * '戻り値: 戻り値なし' は定数自体が値を直接返さないことを意味すると解釈し、
8 * 定数には値を保持させます。
9 */
10if (!defined('MON_9')) {
11    define('MON_9', 9); // 例として整数値を設定
12}
13
14/**
15 * Optionモナドの抽象クラス。
16 * nullの可能性を持つ値を安全に扱うためのモナドパターンを実装します。
17 * これにより、コード内のnullチェックを減らし、処理の連鎖を簡潔に記述できます。
18 * システムエンジニア初心者にとって、null安全なコードの書き方を学ぶ良い例となります。
19 */
20abstract class Option
21{
22    /**
23     * 値が存在するかどうかを判定します。
24     *
25     * @return bool 値が存在すればtrue、そうでなければfalse。
26     */
27    abstract public function isDefined(): bool;
28
29    /**
30     * Optionが値を持たない(Noneである)かどうかを判定します。
31     *
32     * @return bool 値が存在しなければtrue、そうでなければfalse。
33     */
34    public function isEmpty(): bool
35    {
36        return !$this->isDefined();
37    }
38
39    /**
40     * Option内の値に関数を適用し、新しいOptionを返します。
41     * これはモナドの `flatMap` (または `bind`) 操作に相当し、
42     * 連鎖する関数もOptionを返すことを前提とします。
43     *
44     * @param callable $f 値に適用する関数。Optionインスタンスを返す必要があります。
45     * @return Option 新しいOptionインスタンス。
46     */
47    abstract public function flatMap(callable $f): Option;
48
49    /**
50     * Option内の値に関数を適用し、新しいOptionを返します。
51     * これはモナドの `map` 操作に相当し、連鎖する関数が通常の値を返す場合に便利です。
52     *
53     * @param callable $f 値に適用する関数。任意の値を返すことができます。
54     * @return Option 新しいOptionインスタンス。
55     */
56    public function map(callable $f): Option
57    {
58        return $this->flatMap(fn (mixed $value) => Option::of($f($value)));
59    }
60
61    /**
62     * Optionが値を持つ場合はその値を返し、持たない場合は指定されたデフォルト値を返します。
63     *
64     * @param mixed $default Optionが値を持たない場合に返すデフォルト値。
65     * @return mixed Option内の値、またはデフォルト値。
66     */
67    abstract public function getOrElse(mixed $default): mixed;
68
69    /**
70     * 生の値からOptionインスタンスを生成するファクトリメソッド。
71     * 値がnullの場合は `None` インスタンスを、それ以外の場合は `Some` インスタンスを返します。
72     *
73     * @param mixed $value Optionでラップしたい値。
74     * @return Option 値をラップしたOptionインスタンス。
75     */
76    public static function of(mixed $value): Option
77    {
78        return (null === $value) ? new None() : new Some($value);
79    }
80}
81
82/**
83 * Optionモナドの具体的な実装：値が存在する場合。
84 * 不変オブジェクトとして設計されています。
85 */
86class Some extends Option
87{
88    private mixed $value;
89
90    /**
91     * Someインスタンスを生成します。null値は格納できません。
92     *
93     * @param mixed $value ラップする値。
94     * @throws InvalidArgumentException 値がnullの場合。
95     */
96    public function __construct(mixed $value)
97    {
98        if (null === $value) {
99            throw new InvalidArgumentException('Some cannot contain a null value.');
100        }
101        $this->value = $value;
102    }
103
104    public function isDefined(): bool
105    {
106        return true;
107    }
108
109    public function flatMap(callable $f): Option
110    {
111        // ここでMON_9定数の値を利用する例。
112        // 例えば、MON_9の値が特定の閾値を超えた場合にデバッグログを出力するなど、
113        // 拡張機能の定数としてモナドの挙動に影響を与えるシナリオを想定できます。
114        if (MON_9 > 5) {
115            // error_log("MON_9 constant active in Some::flatMap: " . MON_9);
116        }
117        return $f($this->value);
118    }
119
120    public function getOrElse(mixed $default): mixed
121    {
122        return $this->value;
123    }
124}
125
126/**
127 * Optionモナドの具体的な実装：値が存在しない場合。
128 * 不変オブジェクトとして設計されています。
129 */
130class None extends Option
131{
132    public function isDefined(): bool
133    {
134        return false;
135    }
136
137    public function flatMap(callable $f): Option
138    {
139        // Noneの場合、連鎖する関数は実行されず、None自身を返します。
140        // これにより、null値に対する操作エラーを防ぎます。
141        return $this;
142    }
143
144    public function getOrElse(mixed $default): mixed
145    {
146        return $default;
147    }
148}
149
150// ---------------------------------------------------------------------------------------------------------------------
151// 使用例
152// ---------------------------------------------------------------------------------------------------------------------
153
154/**
155 * 仮のデータソースからユーザーIDに基づいてユーザー名を取得する関数。
156 * 指定されたIDのユーザーが存在しない場合や、名前がnullの場合があります。
157 *
158 * @param int $id ユーザーID。
159 * @return string|null ユーザー名、または存在しない場合はnull。
160 */
161function getUserName(int $id): ?string
162{
163    $users = [
164        1 => 'Alice',
165        2 => 'Bob',
166        3 => null, // ID3のユーザーは存在するが、名前がnullのケース
167        // ID4はデータが存在しない
168    ];
169    return $users[$id] ?? null; // IDが存在しない場合もnullを返す
170}
171
172/**
173 * ユーザー名を整形する関数。大文字に変換し、接頭辞を付与します。
174 *
175 * @param string $name 元のユーザー名。
176 * @return string 整形されたユーザー名。
177 */
178function formatUserName(string $name): string
179{
180    return 'USER_' . strtoupper($name);
181}
182
183// 例1: ユーザーが存在し、有効な名前を持つ場合
184$result1 = Option::of(getUserName(1)) // getUserName(1)は"Alice"を返す -> Some("Alice")
185    ->map('trim')                    // "Alice" -> "Alice" (trimしても同じ) -> Some("Alice")
186    ->map('formatUserName')          // "Alice" -> "USER_ALICE" -> Some("USER_ALICE")
187    ->getOrElse('UNKNOWN_USER');     // 値が存在するので"USER_ALICE"を取得
188
189echo "Result 1 (有効なユーザー): " . $result1 . PHP_EOL;
190
191// 例2: ユーザーが存在しない場合（getUserName(4)がnullを返す）
192$result2 = Option::of(getUserName(4)) // getUserName(4)はnullを返す -> None
193    ->map('trim')                    // Noneなので関数は適用されない -> None
194    ->map('formatUserName')          // Noneなので関数は適用されない -> None
195    ->getOrElse('UNKNOWN_USER');     // Noneなのでデフォルト値"UNKNOWN_USER"を取得
196
197echo "Result 2 (ユーザーが存在しない): " . $result2 . PHP_EOL;
198
199// 例3: ユーザーは存在するが、名前がnullの場合（getUserName(3)がnullを返す）
200$result3 = Option::of(getUserName(3)) // getUserName(3)はnullを返す -> None
201    ->map('trim')                    // Noneなので関数は適用されない -> None
202    ->map('formatUserName')          // Noneなので関数は適用されない -> None
203    ->getOrElse('UNKNOWN_USER');     // Noneなのでデフォルト値"UNKNOWN_USER"を取得
204
205echo "Result 3 (ユーザー名がnull): " . $result3 . PHP_EOL;
206
207// 定数MON_9の値を直接参照する例
208echo "MON_9 constant value: " . MON_9 . PHP_EOL;
209
210?>

このPHPコードは、PHP 8で拡張機能の定数MON_9を定義し、さらに『Optionモナド』というパターンを用いてnull値を安全に扱う方法を示しています。MON_9は、拡張機能の一部として提供される架空の定数を想定しており、モナドの動作に影響を与える設定値や識別子などとして利用されることを示唆しています。リファレンスにある『戻り値なし』とは、定数自体が直接値を返す関数ではないことを意味し、定数として値を保持します。

Optionモナドは、値が存在しない可能性（null）を考慮したプログラミングを簡潔に行うためのデザインパターンです。`Option::of()`メソッドは、渡された値がnullであれば`None`（値なし）オブジェクトを、それ以外の場合は`Some`（値あり）オブジェクトを生成して値をラップします。`map()`メソッドは、もし値が存在すれば引数に指定された関数をその値に適用し、結果を新しい`Option`として返します。値が存在しない`None`の場合、`map()`内の関数は実行されず、`None`がそのまま返されるため、nullチェックの手間を省きながら安全に処理を連鎖させることができます。最終的に`getOrElse()`メソッドで、Optionに値が存在すればその値を、存在しなければ引数で指定されたデフォルト値を取得します。これにより、null値による予期せぬエラーを未然に防ぎ、コードの可読性と堅牢性を高めることができます。

Copy
1<?php
2
3// Monologライブラリのインストールが必要です。
4// プロジェクトのルートディレクトリで以下のコマンドを実行してください:
5// composer require monolog/monolog
6
7require_once __DIR__ . '/vendor/autoload.php';
8
9use Monolog\Logger;
10use Monolog\Handler\StreamHandler;
11
12/**
13 * ユーザーが提供したリファレンス情報に基づき、MON_9 定数を定義します。
14 *
15 * 実際のMonologライブラリには「MON_9」という標準定数はありません。
16 * このサンプルコードでは、Monologのログレベルとして使用するため、
17 * Logger::NOTICE (250) と Logger::WARNING (300) の間の整数値 (例: 280) を仮定します。
18 * これは、特定の拡張機能やカスタム設定で利用される定数をシミュレートするものです。
19 *
20 * リファレンス情報の「戻り値: 戻り値なし」という記述は定数には通常適用されませんが、
21 * 定数自体が値を持つものとして扱います。
22 */
23if (!defined('MON_9')) {
24    define('MON_9', 280); // MON_9 をカスタムログレベルの閾値として設定
25}
26
27/**
28 * Monolog を使用してログをファイルに記録する基本的なサンプル関数です。
29 * MON_9 定数をログハンドラーの閾値として使用し、
30 * それよりも高い深刻度のログのみをファイルに出力します。
31 *
32 * @param string $logFilePath ログを保存するファイルのパス。デフォルトは 'app.log' です。
33 */
34function demonstrateMonologWithCustomConstant(string $logFilePath = 'app.log'): void
35{
36    // ロガーインスタンスを作成します。
37    // 'my_application' はこのロガーの名前で、ログメッセージに表示されます。
38    $logger = new Logger('my_application');
39
40    // ログをファイルに出力するための StreamHandler を追加します。
41    // 第2引数に MON_9 定数を指定することで、この値以上の深刻度のログのみが
42    // このハンドラーによって処理され、ファイルに書き込まれます。
43    // 例えば、MON_9 (280) を設定した場合、それよりも深刻度の低いDEBUG (100)、
44    // INFO (200)、NOTICE (250) のログはファイルには記録されません。
45    $logger->pushHandler(new StreamHandler($logFilePath, MON_9));
46
47    // 様々な深刻度のログメッセージを記録します。
48    // MON_9 (280) よりも低い深刻度のログは、StreamHandler によってフィルタリングされ、
49    // ログファイルには出力されません。
50    $logger->debug('これはデバッグメッセージです。 (レベル100)');    // MON_9 (280) より低い -> 出力されない
51    $logger->info('これは情報メッセージです。 (レベル200)');     // MON_9 (280) より低い -> 出力されない
52    $logger->notice('これは通知メッセージです。 (レベル250)');   // MON_9 (280) より低い -> 出力されない
53
54    // MON_9 (280) 以上の深刻度のログは、StreamHandler によってファイルに出力されます。
55    // MonologのLogger::WARNING のレベルは 300、Logger::ERROR は 400 です。
56    $logger->warning('これは警告メッセージです。 (レベル300)'); // MON_9 (280) 以上 -> 出力される
57    $logger->error('これはエラーメッセージです。 (レベル400)');   // MON_9 (280) 以上 -> 出力される
58    $logger->critical('これは致命的なエラーメッセージです。 (レベル500)'); // MON_9 (280) 以上 -> 出力される
59
60    echo "Monologのロギングが完了しました。\n";
61    echo "ログは '{$logFilePath}' を確認してください。\n";
62    echo "MON_9 定数({MON_9})以上のログレベルがファイルに出力されました。\n";
63}
64
65// サンプル関数の実行
66demonstrateMonologWithCustomConstant();

このPHPコードは、MON_9という定数を「280」という値で定義しています。これは、Monologライブラリでログの重要度（ログレベル）の閾値として利用するカスタム定数としています。PHPの定数は特定の値を保持しますが、リファレンス情報の「戻り値: 戻り値なし」という記述は、定数自体が直接何かを返す動作をしないことを意味します。

MonologはPHPアプリケーションで発生する様々な情報をログファイルに記録するための標準的なライブラリです。demonstrateMonologWithCustomConstant関数は、このMonologとMON_9定数を使ってログを制御する例を示します。

この関数は$logFilePathという引数でログの出力先を指定し、何も返しません（void）。関数内部では、Monologロガーを初期化し、StreamHandlerを用いてログをファイルへ書き出す設定をします。特に、MON_9をStreamHandlerのログレベル閾値として設定することで、MON_9（280）より深刻度の低いログ（デバッグ、情報、通知など）はファイルに記録されません。一方で、MON_9以上の深刻度を持つログ（警告、エラー、致命的など）のみがファイルに出力されます。このサンプルは、カスタム定数を利用してログの出力を柔軟に制御する方法を学ぶのに適しています。