HTTP_Client::attach()

HTTP_Client::attach() --  オブジェクトのイベントが通知されるリスナーのリストに Listener を追加する

概要

require_once 'HTTP/Client.php';

boolean HTTP_Client::attach (object HTTP_Request_Listener &$listener [, boolean $propagate = FALSE])

説明

追加されたリスナーには、以下のイベントが通知されます。

'request'

それ以前のリダイレクトの結果ではない HTTP リクエストの前に送出されます。

'httpSuccess'

成功を表す 2xx レスポンス(リダイレクトではない、 またはリダイレクト処理が無効の場合、3xx レスポンス) を受け取った場合に送出されます。

'httpRedirect'

3xx リダイレクトレスポンスを受信したとき、 リダイレクトの前に送出されます。

'httpError'

4xx, 5xx レスポンスの場合に送出されます。

もし、$propagateTRUE ならば、 リスナーは生成された HTTP_Request オブジェクトに関連付けられ、それらのイベントが通知されます。

パラメータ

object HTTP_Request_Listener &$listener

追加するリスナーインスタンスを指定します。

boolean $propagate

Whether the listener should be attached to the created HTTP_Request objects リスナーが生成された HTTP_Request オブジェクトを帰属させるべきかどうかを指定します。

返り値

returns リスナーが正常に追加されたかどうか

例外・エラー

throws 投げられる例外はありません。

参照

detach() も参照してください。

注意

この関数は、スタティックにコールする ことはできません。