【PHP8.x】SplSubject::attach()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplSubject インターフェースを実装するクラスです。
5 * メール送信サービスを表し、メール送信やファイル添付のイベントを発行（通知）します。
6 * イベントに興味があるオブザーバー（監視者）を登録・解除し、イベント発生時に通知します。
7 */
8class MailSender implements SplSubject
9{
10    /** @var SplObserver[] 登録されているオブザーバーのリスト */
11    private array $observers = [];
12
13    /** @var string 現在のメール処理のステータス（例: 'file_attached', 'email_sent'） */
14    private string $status = '';
15
16    /** @var string 送信するメールの本文 */
17    private string $emailContent = '';
18
19    /** @var ?string 添付ファイルのパス（ない場合はnull） */
20    private ?string $attachmentFilePath = null;
21
22    /**
23     * MailSender の新しいインスタンスを初期化します。
24     *
25     * @param string $content 送信するメールの本文
26     */
27    public function __construct(string $content)
28    {
29        $this->emailContent = $content;
30    }
31
32    /**
33     * オブザーバー（監視者）を登録します。
34     * このメソッドは、メール送信やファイル添付などのイベントを監視したいオブジェクトを
35     * イベント発行元（この場合は MailSender）に紐づける際に使用します。
36     *
37     * @param SplObserver $observer 登録するオブザーバー
38     */
39    public function attach(SplObserver $observer): void
40    {
41        // 同じオブザーバーが重複して登録されないようにチェックします
42        if (!in_array($observer, $this->observers, true)) {
43            $this->observers[] = $observer;
44            echo "Info: Observer attached - " . get_class($observer) . PHP_EOL;
45        }
46    }
47
48    /**
49     * オブザーバーの登録を解除します。
50     *
51     * @param SplObserver $observer 解除するオブザーバー
52     */
53    public function detach(SplObserver $observer): void
54    {
55        foreach ($this->observers as $key => $existingObserver) {
56            if ($existingObserver === $observer) {
57                unset($this->observers[$key]);
58                echo "Info: Observer detached - " . get_class($observer) . PHP_EOL;
59                return;
60            }
61        }
62    }
63
64    /**
65     * 登録されているすべてのオブザーバーに更新を通知します。
66     * メール送信やファイル添付の特定の段階で、このメソッドを呼び出してオブザーバーにイベントを伝えます。
67     */
68    public function notify(): void
69    {
70        echo "Info: Notifying " . count($this->observers) . " observers about status change to '" . $this->status . "'..." . PHP_EOL;
71        foreach ($this->observers as $observer) {
72            $observer->update($this);
73        }
74    }
75
76    /**
77     * メールにファイルを添付します。
78     * このメソッド自体は `SplSubject::attach` とは直接関係ありませんが、
79     * キーワード「php attach file to email」に対応する主要な機能です。
80     * 添付処理の結果をオブザーバーに通知するために `notify()` を呼び出します。
81     *
82     * @param string $filePath 添付するファイルのパス
83     */
84    public function attachFile(string $filePath): void
85    {
86        echo "Action: Attempting to attach file: " . basename($filePath) . PHP_EOL;
87        if (file_exists($filePath)) {
88            $this->attachmentFilePath = $filePath;
89            $this->status = 'file_attached';
90            echo "Success: File '" . basename($filePath) . "' successfully prepared for email." . PHP_EOL;
91            $this->notify(); // ファイル添付成功イベントをオブザーバーに通知
92        } else {
93            $this->status = 'file_attachment_failed';
94            echo "Error: File not found for attachment: " . $filePath . PHP_EOL;
95            $this->notify(); // ファイル添付失敗イベントをオブザーバーに通知
96        }
97    }
98
99    /**
100     * メールを送信します。
101     * メール送信の完了をオブザーバーに通知するために `notify()` を呼び出します。
102     */
103    public function sendEmail(): void
104    {
105        echo "Action: Sending email with content: '" . $this->emailContent . "'";
106        if ($this->attachmentFilePath) {
107            echo " and attachment: '" . basename($this->attachmentFilePath) . "'";
108        }
109        echo PHP_EOL;
110
111        // ここに実際のメール送信ロジック（例: PHPMailerライブラリの使用など）を実装します。
112        // 今回は簡略化のため、送信が成功したと仮定します。
113
114        $this->status = 'email_sent';
115        $this->notify(); // メール送信完了イベントをオブザーバーに通知
116        echo "Success: Email sent successfully!" . PHP_EOL;
117    }
118
119    /**
120     * 現在のメール処理ステータスを取得します。
121     * オブザーバーはこのメソッドを使って、`MailSender`の状態を問い合わせます。
122     */
123    public function getStatus(): string
124    {
125        return $this->status;
126    }
127
128    /**
129     * メールコンテンツを取得します。オブザーバーがこの情報を利用できます。
130     */
131    public function getEmailContent(): string
132    {
133        return $this->emailContent;
134    }
135
136    /**
137     * 添付ファイルパスを取得します。オブザーバーがこの情報を利用できます。
138     */
139    public function getAttachmentFilePath(): ?string
140    {
141        return $this->attachmentFilePath;
142    }
143}
144
145/**
146 * SplObserver インターフェースを実装するクラスです。
147 * メール送信サービスのイベントを監視し、ログ記録の処理を実行するオブザーバー（監視者）です。
148 */
149class EmailLogger implements SplObserver
150{
151    /**
152     * 被監視オブジェクト（MailSender）からの更新通知を受け取ります。
153     *
154     * @param SplSubject $subject 更新を通知した被監視オブジェクト
155     */
156    public function update(SplSubject $subject): void
157    {
158        // ログ記録は MailSender のインスタンスが通知した場合にのみ行います
159        if ($subject instanceof MailSender) {
160            echo "[Logger] Received update for status: " . $subject->getStatus() . PHP_EOL;
161            // 実際のアプリケーションでは、ここでログファイルへの書き込みやデータベースへの記録などを行います。
162            // 例: error_log(date('Y-m-d H:i:s') . " - Mail status changed to: " . $subject->getStatus());
163        }
164    }
165}
166
167/**
168 * SplObserver インターフェースを実装するクラスです。
169 * メール送信サービスのイベントを監視し、ユーザーへの通知などの処理を実行するオブザーバーです。
170 */
171class EmailNotifier implements SplObserver
172{
173    /**
174     * 被監視オブジェクト（MailSender）からの更新通知を受け取ります。
175     *
176     * @param SplSubject $subject 更新を通知した被監視オブジェクト
177     */
178    public function update(SplSubject $subject): void
179    {
180        if ($subject instanceof MailSender) {
181            switch ($subject->getStatus()) {
182                case 'file_attached':
183                    echo "[Notifier] User notification: A file '" . basename($subject->getAttachmentFilePath()) . "' has been prepared for your email." . PHP_EOL;
184                    // 例: ユーザーインターフェースに「ファイル添付準備完了」と表示するAPIを呼び出す
185                    break;
186                case 'file_attachment_failed':
187                    echo "[Notifier] Admin alert: Failed to attach file for email '" . $subject->getEmailContent() . "'." . PHP_EOL;
188                    // 例: 管理者へエラー通知メールを送る
189                    break;
190                case 'email_sent':
191                    echo "[Notifier] User notification: Your email with content '" . $subject->getEmailContent() . "' successfully sent!" . PHP_EOL;
192                    // 例: ユーザーにメール送信完了メッセージを表示する
193                    break;
194                default:
195                    echo "[Notifier] Info: MailSender status is now " . $subject->getStatus() . ". No specific notification defined." . PHP_EOL;
196            }
197        }
198    }
199}
200
201// --- 単体で動作可能なサンプルコード実行部分 ---
202
203echo "--- Setup: Creating a dummy file for attachment ---" . PHP_EOL;
204$dummyFileName = 'report_2024.pdf';
205// ファイルが存在しない場合に作成します。これにより、コードが常に実行可能になります。
206if (!file_exists($dummyFileName)) {
207    file_put_contents($dummyFileName, 'This is a dummy PDF report content for attachment.');
208    echo "Created dummy file: " . $dummyFileName . PHP_EOL . PHP_EOL;
209} else {
210    echo "Dummy file already exists: " . $dummyFileName . PHP_EOL . PHP_EOL;
211}
212
213// メール送信サービス（イベントの発行元、被監視オブジェクト）をインスタンス化します。
214$mailService = new MailSender("Here is your monthly sales report. Please review it carefully.");
215
216// オブザーバー（イベントを監視し、特定の処理を実行するオブジェクト）をインスタンス化します。
217$emailLogger = new EmailLogger();
218$emailNotifier = new EmailNotifier();
219
220// SplSubject::attach() を使用してオブザーバーを登録します。
221// これにより、`$mailService` の内部で `notify()` メソッドが呼び出された際に、
222// 登録されたオブザーバー（`$emailLogger`と`$emailNotifier`）の `update()` メソッドが
223// 自動的に呼び出され、イベントに応じた処理が実行されます。
224echo "--- Step 1: Registering Observers using SplSubject::attach() ---" . PHP_EOL;
225$mailService->attach($emailLogger);
226$mailService->attach($emailNotifier);
227echo PHP_EOL;
228
229// 存在するファイルをメールに添付する処理を実行します。
230// このメソッド内で `notify()` が呼び出され、オブザーバーに「file_attached」イベントが通知されます。
231echo "--- Step 2: Performing File Attachment for Email ---" . PHP_EOL;
232$mailService->attachFile($dummyFileName);
233echo PHP_EOL;
234
235// 存在しないファイルを添付しようとします。（エラーシナリオのテスト）
236// このメソッド内で `notify()` が呼び出され、オブザーバーに「file_attachment_failed」イベントが通知されます。
237echo "--- Step 3: Attempting to Attach a Non-Existent File (Error Scenario) ---" . PHP_EOL;
238$mailService->attachFile('non_existent_document.docx');
239echo PHP_EOL;
240
241// メールを送信する処理を実行します。
242// このメソッド内で `notify()` が呼び出され、オブザーバーに「email_sent」イベントが通知されます。
243echo "--- Step 4: Sending the Email ---" . PHP_EOL;
244$mailService->sendEmail();
245echo PHP_EOL;
246
247// 添付したダミーファイルを削除してクリーンアップします。
248echo "--- Cleanup: Deleting the dummy file ---" . PHP_EOL;
249if (file_exists($dummyFileName)) {
250    unlink($dummyFileName);
251    echo "Deleted dummy file: " . $dummyFileName . PHP_EOL;
252}
253?>

PHPのSplSubject::attachメソッドは、オブザーバーパターンというデザインパターンにおいて、特定のイベントを監視したい「オブザーバー（監視者）」を「被監視オブジェクト（イベント発行元）」に登録する際に使用されます。

このメソッドはSplSubjectインターフェースを実装するクラスで利用され、attachという名前の通り、監視対象にオブザーバーを「取り付け」る役割を担います。引数にはSplObserverインターフェースを実装したオブザーバーオブジェクトを一つ指定します。このオブザーバーは、後で被監視オブジェクトから何らかのイベントが発生した際に通知を受け取ります。

戻り値はありません。オブザーバーを登録するだけで、登録の成否などを直接返しません。

サンプルコードでは、MailSenderクラスがメール送信やファイル添付のイベントを発行する被監視オブジェクトです。EmailLoggerとEmailNotifierは、これらのイベントを監視するオブザーバーです。$mailService->attach($emailLogger);のようにattachメソッドを呼び出すことで、MailSenderで「ファイルが添付された」や「メールが送信された」といったイベントが発生した際に、登録されたオブザーバーに自動的に通知が送られ、それぞれの処理（ログ記録やユーザーへの通知など）が実行されるようになります。これにより、「php attach file to email」のようなメールのファイル添付イベントに対しても、オブザーバーを通じて柔軟な対応が可能となります。

Copy
1<?php
2
3/**
4 * SplSubject インターフェースを実装する具体的なサブジェクトクラスです。
5 * ファイル処理のイベント（例：ファイルアップロード、保存など）を監視するオブザーバーに通知します。
6 */
7class FileProcessor implements SplSubject
8{
9    /**
10     * このサブジェクトにアタッチされているオブザーバーのリストです。
11     *
12     * @var SplObserver[]
13     */
14    private array $observers = [];
15
16    /**
17     * 最後に処理されたファイル名です。オブザーバーにこの情報を提供します。
18     *
19     * @var string
20     */
21    private string $lastProcessedFileName = '';
22
23    /**
24     * オブザーバーをサブジェクトにアタッチ（登録）します。
25     * このメソッドは、SplSubjectインターフェースの必須実装であり、
26     * オブザーバーパターンにおける「オブザーバーの追加」に相当します。
27     *
28     * @param SplObserver $observer 登録するオブザーバーインスタンス。
29     */
30    public function attach(SplObserver $observer): void
31    {
32        // 既に登録されていないオブザーバーのみを追加
33        if (!in_array($observer, $this->observers, true)) {
34            $this->observers[] = $observer;
35            echo "オブザーバーがアタッチされました: " . get_class($observer) . PHP_EOL;
36        }
37    }
38
39    /**
40     * オブザーバーの登録を解除（デタッチ）します。
41     *
42     * @param SplObserver $observer 登録解除するオブザーバーインスタンス。
43     */
44    public function detach(SplObserver $observer): void
45    {
46        foreach ($this->observers as $key => $obs) {
47            if ($obs === $observer) {
48                unset($this->observers[$key]);
49                echo "オブザーバーがデタッチされました: " . get_class($observer) . PHP_EOL;
50                return;
51            }
52        }
53    }
54
55    /**
56     * 全ての登録されたオブザーバーに更新を通知します。
57     * サブジェクトの状態が変化したときに呼び出されます。
58     */
59    public function notify(): void
60    {
61        echo "イベントをオブザーバーに通知中..." . PHP_EOL;
62        foreach ($this->observers as $observer) {
63            $observer->update($this);
64        }
65    }
66
67    /**
68     * ファイルを処理する（例：アップロード、保存など）メソッド。
69     * 処理が完了すると、アタッチされているオブザーバー全てに通知します。
70     *
71     * @param string $fileName 処理するファイル名。
72     */
73    public function processFile(string $fileName): void
74    {
75        $this->lastProcessedFileName = $fileName;
76        echo "ファイル '{$fileName}' を処理中..." . PHP_EOL;
77        // ここに実際のファイル処理ロジックを記述します（例：ファイル移動、データベースへのメタデータ保存など）
78        echo "ファイル '{$fileName}' の処理が完了しました。" . PHP_EOL;
79        $this->notify(); // 処理完了後にオブザーバーに通知
80    }
81
82    /**
83     * 最後に処理されたファイル名を取得します。
84     * オブザーバーはこのメソッドを介してサブジェクトの状態にアクセスできます。
85     *
86     * @return string
87     */
88    public function getLastProcessedFileName(): string
89    {
90        return $this->lastProcessedFileName;
91    }
92}
93
94/**
95 * SplObserver インターフェースを実装する具体的なオブザーバークラス（ロガー）です。
96 * ファイル処理イベントが発生した際にログを記録します。
97 */
98class LoggerObserver implements SplObserver
99{
100    /**
101     * サブジェクトからの更新を受け取ります。
102     *
103     * @param SplSubject $subject 更新を通知したサブジェクト。
104     */
105    public function update(SplSubject $subject): void
106    {
107        if ($subject instanceof FileProcessor) {
108            echo "[ロガー]: ファイル '{$subject->getLastProcessedFileName()}' が処理されました。" . PHP_EOL;
109            // 実際のアプリケーションでは、ここにログファイルへの書き込みなどのロジックを実装します。
110        }
111    }
112}
113
114/**
115 * SplObserver インターフェースを実装する具体的なオブザーバークラス（サムネイルジェネレータ）です。
116 * 画像ファイル処理イベントが発生した際にサムネイルを生成します。
117 */
118class ThumbnailGeneratorObserver implements SplObserver
119{
120    /**
121     * サブジェクトからの更新を受け取ります。
122     *
123     * @param SplSubject $subject 更新を通知したサブジェクト。
124     */
125    public function update(SplSubject $subject): void
126    {
127        if ($subject instanceof FileProcessor) {
128            echo "[サムネイルジェネレータ]: ファイル '{$subject->getLastProcessedFileName()}' のサムネイルを生成中..." . PHP_EOL;
129            // 実際のアプリケーションでは、ここにサムネイル生成のロジックを実装します。
130        }
131    }
132}
133
134// --- サンプルコードの実行 ---
135
136// ファイル処理を管理するサブジェクトインスタンスを作成します。
137$fileProcessor = new FileProcessor();
138
139// 各イベントに対応するオブザーバーインスタンスを作成します。
140$logger = new LoggerObserver();
141$thumbnailGenerator = new ThumbnailGeneratorObserver();
142
143// オブザーバーをファイル処理サブジェクトにアタッチ（登録）します。
144// ここで SplSubject::attach メソッドが使用され、オブザーバーがイベント通知リストに追加されます。
145$fileProcessor->attach($logger);
146$fileProcessor->attach($thumbnailGenerator);
147
148echo PHP_EOL;
149
150// 複数のファイルを処理し、そのたびにアタッチされたオブザーバーが通知を受け取ります。
151$fileProcessor->processFile("document.pdf");
152
153echo PHP_EOL;
154
155$fileProcessor->processFile("image_001.jpg");
156
157echo PHP_EOL;
158
159// ロガーオブザーバーをデタッチ（登録解除）します。
160// 今後、ファイル処理イベントが発生してもロガーには通知されなくなります。
161$fileProcessor->detach($logger);
162
163echo PHP_EOL;
164
165// ロガーをデタッチした後、再度ファイルを処理します。
166// 今度はサムネイルジェネレータのみが通知を受け取ります。
167$fileProcessor->processFile("video_clip.mp4");
168
169?>

PHPのSplSubjectインターフェースに定義されているattachメソッドは、特定のイベントを監視し、そのイベントが発生した際に通知を受け取る「オブザーバー」を登録するために使用されます。これは、プログラムが実行時に発生するさまざまな出来事（イベント）に対して、複数の処理を自動的に連動させる「オブザーバーパターン」という仕組みの根幹をなすものです。

attachメソッドは、引数としてSplObserver型のオブジェクト $observer を一つ受け取ります。この $observer は、イベントが発生したときに実行したい具体的な処理（例えば、ログの記録やサムネイルの生成など）を定義したクラスのインスタンスです。attachメソッドが呼び出されると、指定されたオブザーバーがイベント通知リストに追加され、以後、サブジェクトの状態が変化した際にそのupdateメソッドが自動的に呼び出されるようになります。

このメソッドには戻り値がありません（void）。これは、オブザーバーの登録処理自体が成功すれば良く、特に結果として何かを返す必要がないことを意味します。サンプルコードでは、FileProcessorというファイル処理を管理するクラスがSplSubjectを実装し、LoggerObserverやThumbnailGeneratorObserverといった具体的なオブザーバーをattachメソッドで登録しています。これにより、ファイル処理が完了するたびに、登録された全てのオブザーバーに自動で通知が送られ、それぞれの処理が実行されるのです。