Auth::setCheckAuthCallback()

Auth::setCheckAuthCallback() -- セッションが有効かどうかを調べる際に実行されるコールバックを設定する

概要

void Auth::setCheckAuthCallback (string $checkAuthCallback)

説明

この関数はコールバック関数を設定します。設定したコールバック関数は、 ログイン中のセッションが有効かどうかを調べるたびにコールされます。 このコールバックを使用して、 ログイン中のユーザが認証ソースでまだ有効であるかどうかを調べたりします。

コールバック関数には二つのパラメータが渡されます。 ログインしているユーザの名前と、Auth オブジェクトへの参照です。 このコールバック関数は、セッションを続行させるかどうかを指定する boolean 値を返さなければなりません。セッションを続行してもいい場合は TRUE、セッションを終了させる場合は FALSE を返します。

このコールバックでセッションを終了させた場合のステータスは、 AUTH_CALLBACK_ABORT となります。

パラメータ

string $checkAuthCallback

使用するコールバック関数。

注意

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