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

Copy
1<?php
2
3/**
4 * SplSubjectインターフェースを実装する具体的なSubjectクラス。
5 * 自身にアタッチされたObserverオブジェクトを管理し、状態変更時に通知します。
6 */
7class ConcreteSubject implements SplSubject
8{
9    /** @var SplObserver[] 通知するオブザーバーのリスト */
10    private array $observers = [];
11
12    /** @var string 主体の現在の状態 */
13    private string $state;
14
15    /**
16     * ObserverをSubjectにアタッチ（登録）します。
17     * 同じObserverが複数回アタッチされないようにします。
18     *
19     * @param SplObserver $observer アタッチするObserverインスタンス
20     */
21    public function attach(SplObserver $observer): void
22    {
23        // 既にオブザーバーがリストに存在しない場合のみ追加
24        if (!in_array($observer, $this->observers, true)) {
25            $this->observers[] = $observer;
26            echo "Subject: Observer " . spl_object_id($observer) . " attached.\n";
27        }
28    }
29
30    /**
31     * ObserverをSubjectからデタッチ（登録解除）します。
32     * これにより、デタッチされたObserverは今後の通知を受け取らなくなります。
33     *
34     * @param SplObserver $observer デタッチするObserverインスタンス
35     */
36    public function detach(SplObserver $observer): void
37    {
38        // オブザーバーをリストから見つけて削除
39        foreach ($this->observers as $key => $obs) {
40            if ($obs === $observer) {
41                unset($this->observers[$key]);
42                echo "Subject: Observer " . spl_object_id($observer) . " detached.\n";
43                // 配列のキーを再インデックスする（オプションだが推奨）
44                $this->observers = array_values($this->observers);
45                return;
46            }
47        }
48    }
49
50    /**
51     * 全てのアタッチされているObserverに通知します。
52     * ObserverはSubjectの最新の状態を取得して更新処理を行います。
53     */
54    public function notify(): void
55    {
56        echo "Subject: Notifying observers...\n";
57        foreach ($this->observers as $observer) {
58            $observer->update($this);
59        }
60    }
61
62    /**
63     * Subjectの内部状態を変更し、その後全てのアタッチされているObserverに通知します。
64     *
65     * @param string $newState 設定する新しい状態
66     */
67    public function changeState(string $newState): void
68    {
69        $this->state = $newState;
70        echo "Subject: State changed to '{$this->state}'.\n";
71        $this->notify(); // 状態変更後にオブザーバーに通知
72    }
73
74    /**
75     * Subjectの現在の状態を返します。
76     * これはObserverが通知を受けた際にSubjectの情報を取得するために使用されます。
77     *
78     * @return string 現在の状態
79     */
80    public function getState(): string
81    {
82        return $this->state;
83    }
84}
85
86/**
87 * SplObserverインターフェースを実装する具体的なObserverクラス。
88 * Subjectからの通知を受け取り、それに応じて自身を更新します。
89 */
90class ConcreteObserver implements SplObserver
91{
92    /** @var int オブザーバーの識別子 */
93    private int $id;
94
95    public function __construct(int $id)
96    {
97        $this->id = $id;
98    }
99
100    /**
101     * Subjectからの更新通知を受け取った際に実行されるメソッドです。
102     * ここでSubjectの最新の状態を取得し、Observerの更新処理を行います。
103     *
104     * @param SplSubject $subject 通知を発行したSubjectインスタンス
105     */
106    public function update(SplSubject $subject): void
107    {
108        // 通知元のSubjectの現在の状態を取得して表示
109        echo "Observer {$this->id} (ID: " . spl_object_id($this) . ") received update. Subject's state is: " . $subject->getState() . "\n";
110    }
111}
112
113// --- サンプルコードの実行 ---
114
115// Subjectインスタンスの作成
116$subject = new ConcreteSubject();
117
118// 複数のObserverインスタンスの作成
119$observer1 = new ConcreteObserver(1);
120$observer2 = new ConcreteObserver(2);
121$observer3 = new ConcreteObserver(3);
122
123echo "--- 1. 初期オブザーバーの登録 ---\n";
124// ObserverをSubjectにアタッチ（登録）
125$subject->attach($observer1);
126$subject->attach($observer2);
127$subject->attach($observer3);
128
129echo "\n--- 2. Subjectの状態変更（全てのオブザーバーが通知を受ける） ---\n";
130// Subjectの状態を変更し、全てのアタッチされたObserverに通知
131$subject->changeState("データが更新されました！");
132
133echo "\n--- 3. 特定のObserverのデタッチ（登録解除） ---\n";
134// Observer2をSubjectからデタッチ（登録解除）
135$subject->detach($observer2);
136
137echo "\n--- 4. Subjectの状態変更（デタッチされたオブザーバーは通知を受けない） ---\n";
138// 再度Subjectの状態を変更。Observer2はデタッチされたため通知を受け取らない
139$subject->changeState("別のイベントが発生しました！");
140
141echo "\n--- サンプルコード終了 ---\n";
142// Observer2はデタッチされているため、"別のイベントが発生しました！"の通知は受け取らないことが確認できます。

SplSubject::detachメソッドは、PHPの標準ライブラリ（SPL）が提供するSplSubjectインターフェースに定義されている機能の一つです。このメソッドは、オブザーバーパターンと呼ばれるデザインパターンにおいて、監視対象であるSubject（自身）に登録されているObserver（監視者）を、通知リストから解除する役割を持ちます。

引数にはSplObserver $observerを指定します。これは、過去にattachメソッドで登録し、今後Subjectからの状態変化の通知を受け取る必要がなくなった特定のオブザーバーオブジェクトを渡すことを意味します。このメソッドが実行されると、指定されたオブザーバーは以降、Subjectの状態変化に関する通知を受け取らなくなります。

戻り値はvoidです。これは、detachメソッドが登録解除処理を行った後、特に結果として値を返さないことを示しています。

提供されたサンプルコードでは、複数のConcreteObserverインスタンスがConcreteSubjectに登録された後、$subject->detach($observer2);の行でObserver2が通知リストから解除されています。この結果、その後に$subject->changeState()が呼び出されても、デタッチされたObserver2は通知を受け取らず、残りのObserver1とObserver3のみが通知を受け取る様子が確認できます。このようにdetachメソッドを使用することで、不要になったオブザーバーがシステムのイベント通知を受け取らないように制御し、効率的な処理を実現できます。

Copy
1<?php
2
3/**
4 * SplSubject インターフェースを実装するクラス（監視される側）。
5 * 自身の状態変化を監視者に通知します。
6 */
7class ConcreteSubject implements SplSubject
8{
9    /**
10     * @var SplObjectStorage 監視者オブジェクトを格納するコレクション。
11     * オブジェクトをキーとして使用し、追加・削除・反復処理が効率的に行えます。
12     */
13    private SplObjectStorage $observers;
14
15    /**
16     * @var string サブジェクトの現在の状態。
17     */
18    private string $state;
19
20    /**
21     * コンストラクタで監視者コレクションを初期化し、初期状態を設定します。
22     */
23    public function __construct()
24    {
25        $this->observers = new SplObjectStorage();
26        $this->state = "初期状態";
27    }
28
29    /**
30     * 監視者（SplObserver）を登録します。
31     * サブジェクトの状態変化時に通知を受け取れるようになります。
32     *
33     * @param SplObserver $observer 登録する監視者オブジェクト。
34     */
35    public function attach(SplObserver $observer): void
36    {
37        $this->observers->attach($observer);
38        echo "監視者 " . get_class($observer) . " を登録しました。\n";
39    }
40
41    /**
42     * 監視者（SplObserver）の登録を解除します。
43     * これにより、サブジェクトの状態変化時に通知を受け取らなくなります。
44     * このメソッドが今回リファレンスの対象である 'detach' です。
45     *
46     * @param SplObserver $observer 登録解除する監視者オブジェクト。
47     */
48    public function detach(SplObserver $observer): void
49    {
50        $this->observers->detach($observer);
51        echo "監視者 " . get_class($observer) . " の登録を解除しました。\n";
52    }
53
54    /**
55     * 登録されている全ての監視者に、サブジェクトの状態変化を通知します。
56     */
57    public function notify(): void
58    {
59        echo "全ての監視者に通知しています...\n";
60        foreach ($this->observers as $observer) {
61            $observer->update($this);
62        }
63    }
64
65    /**
66     * サブジェクトの状態を変更し、その後に全ての監視者に通知します。
67     */
68    public function changeStateAndNotify(string $newState): void
69    {
70        $this->state = $newState;
71        echo "\nサブジェクトの状態が「" . $this->state . "」に変更されました。\n";
72        $this->notify();
73    }
74
75    /**
76     * 現在のサブジェクトの状態を取得します。
77     *
78     * @return string 現在の状態。
79     */
80    public function getState(): string
81    {
82        return $this->state;
83    }
84}
85
86/**
87 * SplObserver インターフェースを実装するクラス（監視者側）。
88 * 監視しているサブジェクトの状態変化通知を受け取ります。
89 */
90class ConcreteObserver implements SplObserver
91{
92    /**
93     * @var string 監視者の名前。識別用。
94     */
95    private string $name;
96
97    /**
98     * コンストラクタで監視者の名前を設定します。
99     *
100     * @param string $name この監視者の名前。
101     */
102    public function __construct(string $name)
103    {
104        $this->name = $name;
105    }
106
107    /**
108     * サブジェクトから状態変更の通知を受け取った際に呼び出されます。
109     *
110     * @param SplSubject $subject 通知を発行したサブジェクトオブジェクト。
111     */
112    public function update(SplSubject $subject): void
113    {
114        // ここで監視者に応じた処理を実行します。
115        // 例: サブジェクトの新しい状態をログに出力する、別の処理をトリガーするなど。
116        echo "  - 監視者「" . $this->name . "」が通知を受信しました。サブジェクトの状態: 「" . $subject->getState() . "」\n";
117    }
118}
119
120// --- サンプルコードの実行 ---
121
122// サブジェクト（監視される側）を作成
123$subject = new ConcreteSubject();
124
125// 監視者（オブザーバー）を作成
126$observerA = new ConcreteObserver("オブザーバーA");
127$observerB = new ConcreteObserver("オブザーバーB");
128$observerC = new ConcreteObserver("オブザーバーC");
129
130// 監視者をサブジェクトに登録 (attach)
131$subject->attach($observerA);
132$subject->attach($observerB);
133$subject->attach($observerC);
134
135// サブジェクトの状態を変更し、全ての監視者に通知 (notify)
136$subject->changeStateAndNotify("重要な更新1");
137
138// 特定の監視者（オブザーバーB）の登録を解除 (detach)
139// これにより、オブザーバーBは以降の通知を受け取らなくなります。
140$subject->detach($observerB);
141
142// 再度サブジェクトの状態を変更し、残りの監視者に通知
143// オブザーバーBは通知されませんが、AとCは通知されます。
144$subject->changeStateAndNotify("重要な更新2");
145
146?>

PHP 8のSplSubject::detachメソッドは、オブジェクト間の連携をシンプルにするObserverパターンの一部として利用されます。このメソッドは、自身（監視される側、SplSubject）の状態変化を監視している特定のオブジェクト（監視者、SplObserver）の登録を解除する役割を持ちます。

具体的には、監視される側が持つ、状態変化を通知する先のリストから、引数$observerで指定されたSplObserverオブジェクトを削除します。一度detachされた監視者は、以降、監視していたサブジェクトの状態が変更されても、その通知を受け取らなくなります。

引数$observerには、登録解除したいSplObserverオブジェクトを渡します。このメソッドは登録解除処理のみを行い、特に結果を返さないため、戻り値はvoidです。

サンプルコードでは、はじめに複数の監視者を登録し、サブジェクトの状態が変化すると全ての監視者が通知を受け取ります。しかし、途中で特定の監視者（$observerB）をdetachメソッドで登録解除すると、その後の状態変化では$observerBには通知が届かなくなり、他の登録された監視者のみが通知を受け取る動作を確認できます。