0 フォロワー

クラス yii\filters\auth\HttpBasicAuth

すべてのクラス | プロパティ | メソッド
継承yii\filters\auth\HttpBasicAuth » yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
実装yii\base\Configurable, yii\filters\auth\AuthInterface
利用可能なバージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/filters/auth/HttpBasicAuth.php

HttpBasicAuth は、HTTP Basic 認証メソッドをサポートするアクションフィルターです。

HttpBasicAuth は、以下のようにコントローラーまたはモジュールにビヘイビアとしてアタッチすることで使用できます。

public function behaviors()
{
    return [
        'basicAuth' => [
            'class' => \yii\filters\auth\HttpBasicAuth::class,
        ],
    ];
}

HttpBasicAuth のデフォルトの実装では、userアプリケーションコンポーネントのloginByAccessToken()メソッドを使用し、ユーザー名のみを渡します。この実装は、APIクライアントを認証するために使用されます。

ユーザー名とパスワードを使用してユーザーを認証する場合は、例えば以下のように$auth関数を提供する必要があります。

public function behaviors()
{
    return [
        'basicAuth' => [
            'class' => \yii\filters\auth\HttpBasicAuth::class,
            'auth' => function ($username, $password) {
                $user = User::find()->where(['username' => $username])->one();
                if ($user && $user->validatePassword($password)) {
                    return $user;
                }
                return null;
            },
        ],
    ];
}

ヒント: 認証が期待どおりに機能しない場合は、Webサーバーがユーザー名とパスワードを$_SERVER['PHP_AUTH_USER']および$_SERVER['PHP_AUTH_PW']変数に渡していることを確認してください。 ApacheをPHP-CGIで使用している場合は、.htaccessファイルに次の行を追加する必要がある場合があります：RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]

公開プロパティ

継承されたプロパティを非表示にする

プロパティ 型 説明 定義元
$auth callable|null HTTP基本認証情報を使用してユーザーを認証するPHPのcallable。 yii\filters\auth\HttpBasicAuth
$except array このフィルターを適用すべきでないアクションIDのリスト。 yii\base\ActionFilter
$only array このフィルターを適用すべきアクションIDのリスト。 yii\base\ActionFilter
$optional array このフィルターが適用されるアクションIDのリストですが、認証の失敗はエラーにはつながりません。 yii\filters\auth\AuthMethod
$owner yii\base\Component|null このビヘイビアのオーナー yii\base\Behavior
$realm string HTTP認証レルム yii\filters\auth\HttpBasicAuth
$request yii\web\Request|null 現在のリクエスト。 yii\filters\auth\AuthMethod
$response yii\web\Response|null 送信されるレスポンス。 yii\filters\auth\AuthMethod
$user yii\web\User|null ユーザー認証ステータスを表すユーザーオブジェクト。 yii\filters\auth\AuthMethod

公開メソッド

継承されたメソッドを非表示にする

メソッド 説明 定義元
__call() クラスメソッドではない名前付きメソッドを呼び出します。 yii\base\BaseObject
__construct() コンストラクタ。 yii\base\BaseObject
__get() オブジェクトプロパティの値を返します。 yii\base\BaseObject
__isset() プロパティが設定されているか、つまり定義されていてnullではないかを確認します。 yii\base\BaseObject
__set() オブジェクトプロパティの値を設定します。 yii\base\BaseObject
__unset() オブジェクトプロパティをnullに設定します。 yii\base\BaseObject
afterAction() このメソッドは、アクションが実行された直後に呼び出されます。 yii\base\ActionFilter
afterFilter() yii\base\ActionFilter
attach() ビヘイビアオブジェクトをコンポーネントにアタッチします。 yii\base\ActionFilter
authenticate() 現在のユーザーを認証します。 yii\filters\auth\HttpBasicAuth
beforeAction() このメソッドは、（可能なすべてのフィルタの後で）アクションが実行される直前に呼び出されます。このメソッドをオーバーライドして、アクションの直前準備を行うことができます。 yii\filters\auth\AuthMethod
beforeFilter() yii\base\ActionFilter
canGetProperty() プロパティが読み取り可能かどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティが設定可能かどうかを示す値を返します。 yii\base\BaseObject
challenge() 認証失敗時にチャレンジを生成します。 yii\filters\auth\HttpBasicAuth
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
detach() ビヘイビアオブジェクトをコンポーネントからデタッチします。 yii\base\ActionFilter
events() $owner のイベントのイベントハンドラを宣言します。 yii\base\Behavior
handleFailure() 認証失敗を処理します。 yii\filters\auth\AuthMethod
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject

保護されたメソッド

継承されたメソッドを非表示にする

メソッド 説明 定義元
getActionId() yii\base\Action::$uniqueId をモジュールに対する相対IDに変換して、アクションIDを返します。 yii\base\ActionFilter
isActive() 指定されたアクションに対してフィルターがアクティブかどうかを示す値を返します。 yii\base\ActionFilter
isOptional() 指定されたアクションに対して認証がオプションであるかどうかをチェックします。 yii\filters\auth\AuthMethod

プロパティの詳細

継承されたプロパティを非表示にする

$auth public プロパティ

HTTP基本認証情報でユーザーを認証するPHPのcallableです。callableは、パラメータとしてユーザー名とパスワードを受け取ります。ユーザー名とパスワードに一致するIDオブジェクトを返す必要があります。そのようなIDがない場合は、Nullを返す必要があります。callableは、現在のユーザーが認証されていない場合にのみ呼び出されます。

次のコードは、このcallableの典型的な実装です。

function ($username, $password) {
    return \app\models\User::findOne([
        'username' => $username,
        'password' => $password,
    ]);
}

このプロパティが設定されていない場合、ユーザー名情報はアクセストークンと見なされ、パスワード情報は無視されます。yii\web\User::loginByAccessToken() メソッドが呼び出され、ユーザーの認証とログインが行われます。

public callable|null $auth = null
$realm public プロパティ

HTTP認証レルム

public string $realm = 'api'

メソッドの詳細

継承されたメソッドを非表示にする

__call() public メソッド

定義元： yii\base\BaseObject::__call()

クラスメソッドではない名前付きメソッドを呼び出します。

不明なメソッドが呼び出されたときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

public mixed __call ( $name, $params )
$name string

メソッド名
$params array

メソッドのパラメータ
return mixed

メソッドの戻り値
throws yii\base\UnknownMethodException

不明なメソッドを呼び出す場合

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public メソッド

定義元： yii\base\BaseObject::__construct()

コンストラクタ。

デフォルトの実装では、次の2つの処理を行います。

  • 指定された構成 $config でオブジェクトを初期化します。
  • init() を呼び出します。

このメソッドが子クラスでオーバーライドされている場合は、次のことを推奨します。

  • コンストラクタの最後のパラメータは、ここでの $config のような構成配列です。
  • コンストラクタの最後に親の実装を呼び出します。
public void __construct ( $config = [] )
$config array

オブジェクトのプロパティを初期化するために使用される名前と値のペア

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public メソッド

定義元： yii\base\BaseObject::__get()

オブジェクトプロパティの値を返します。

$value = $object->property; を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

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

public mixed __get ( $name )
$name string

プロパティ名
return mixed

プロパティの値
throws yii\base\UnknownPropertyException

プロパティが定義されていない場合
throws yii\base\InvalidCallException

プロパティが書き込み専用の場合

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public メソッド

定義元： yii\base\BaseObject::__isset()

プロパティが設定されているか、つまり定義されていてnullではないかを確認します。

isset($object->property) を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

プロパティが定義されていない場合、false が返されることに注意してください。

https://www.php.net/manual/en/function.isset.php も参照してください。

public boolean __isset ( $name )
$name string

プロパティ名またはイベント名
return boolean

名前付きプロパティが設定されているかどうか（nullではない）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public メソッド

定義元： yii\base\BaseObject::__set()

オブジェクトプロパティの値を設定します。

$object->property = $value; を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

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

public void __set ( $name, $value )
$name string

プロパティ名またはイベント名
$value mixed

プロパティの値
throws yii\base\UnknownPropertyException

プロパティが定義されていない場合
throws yii\base\InvalidCallException

プロパティが読み取り専用の場合

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public メソッド

定義元： yii\base\BaseObject::__unset()

オブジェクトプロパティをnullに設定します。

unset($object->property) を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。

プロパティが定義されていない場合、このメソッドは何も行わないことに注意してください。プロパティが読み取り専用の場合、例外をスローします。

https://www.php.net/manual/en/function.unset.php も参照してください。

public void __unset ( $name )
$name string

プロパティ名
throws yii\base\InvalidCallException

プロパティが読み取り専用の場合。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
afterAction() public メソッド

定義元： yii\base\ActionFilter::afterAction()

このメソッドは、アクションが実行された直後に呼び出されます。

アクションの後処理を行うために、このメソッドをオーバーライドできます。

public mixed afterAction ( $action, $result )
$action yii\base\Action

実行されたアクション。
$result mixed

アクションの実行結果
return mixed

処理されたアクションの結果。

 

                public function afterAction($action, $result)
{
    return $result;
}
afterFilter() public メソッド

定義元: yii\base\ActionFilter::afterFilter()

public void afterFilter ( $event )
$event yii\base\ActionEvent 

                public function afterFilter($event)
{
    $event->result = $this->afterAction($event->action, $event->result);
    $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
attach() public メソッド

定義元: yii\base\ActionFilter::attach()

ビヘイビアオブジェクトをコンポーネントにアタッチします。

デフォルトの実装では、$owner プロパティを設定し、events() で宣言されているイベントハンドラをアタッチします。このメソッドをオーバーライドする場合は、親の実装を呼び出すようにしてください。

public void attach ( $owner )
$owner yii\base\Component

このビヘイビアがアタッチされるコンポーネント。

 

                public function attach($owner)
{
    $this->owner = $owner;
    $owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
authenticate() public メソッド

現在のユーザーを認証します。

public yii\web\IdentityInterface|null authenticate ( $user, $request, $response )
$user yii\web\User
$request yii\web\Request
$response yii\web\Response
return yii\web\IdentityInterface|null

認証されたユーザーのアイデンティティ。認証情報が提供されていない場合は、null が返されます。
throws yii\web\UnauthorizedHttpException

認証情報が提供されているが、無効な場合。

 

                public function authenticate($user, $request, $response)
{
    list($username, $password) = $request->getAuthCredentials();
    if ($this->auth) {
        if ($username !== null || $password !== null) {
            $identity = $user->getIdentity() ?: call_user_func($this->auth, $username, $password);
            if ($identity === null) {
                $this->handleFailure($response);
            } elseif ($user->getIdentity(false) !== $identity) {
                $user->login($identity);
            }
            return $identity;
        }
    } elseif ($username !== null) {
        $identity = $user->loginByAccessToken($username, get_class($this));
        if ($identity === null) {
            $this->handleFailure($response);
        }
        return $identity;
    }
    return null;
}
beforeAction() public メソッド

定義元: yii\filters\auth\AuthMethod::beforeAction()

このメソッドは、（可能なすべてのフィルタの後で）アクションが実行される直前に呼び出されます。このメソッドをオーバーライドして、アクションの直前準備を行うことができます。

public boolean beforeAction ( $action )
$action yii\base\Action

実行されるアクション。
return boolean

アクションの実行を継続すべきかどうか。

 

                public function beforeAction($action)
{
    $response = $this->response ?: Yii::$app->getResponse();
    try {
        $identity = $this->authenticate(
            $this->user ?: Yii::$app->getUser(),
            $this->request ?: Yii::$app->getRequest(),
            $response
        );
    } catch (UnauthorizedHttpException $e) {
        if ($this->isOptional($action)) {
            return true;
        }
        throw $e;
    }
    if ($identity !== null || $this->isOptional($action)) {
        return true;
    }
    $this->challenge($response);
    $this->handleFailure($response);
    return false;
}
beforeFilter() public メソッド

定義元: yii\base\ActionFilter::beforeFilter()

public void beforeFilter ( $event )
$event yii\base\ActionEvent 

                public function beforeFilter($event)
{
    if (!$this->isActive($event->action)) {
        return;
    }
    $event->isValid = $this->beforeAction($event->action);
    if ($event->isValid) {
        // call afterFilter only if beforeFilter succeeds
        // beforeFilter and afterFilter should be properly nested
        $this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
    } else {
        $event->handled = true;
    }
}
canGetProperty() public メソッド

定義元: yii\base\BaseObject::canGetProperty()

プロパティが読み取り可能かどうかを示す値を返します。

プロパティが読み取り可能であるのは次の場合です。

  • クラスに、指定された名前に関連付けられたゲッターメソッドがある場合（この場合、プロパティ名は大文字と小文字が区別されません）。
  • クラスに、指定された名前のメンバー変数がある場合（$checkVars が true の場合）。

また、canSetProperty() も参照してください。

public boolean canGetProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバー変数をプロパティとして扱うかどうか
return boolean

プロパティを読み取ることができるかどうか

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public メソッド

定義元: yii\base\BaseObject::canSetProperty()

プロパティが設定可能かどうかを示す値を返します。

プロパティが書き込み可能であるのは次の場合です。

  • クラスに、指定された名前に関連付けられたセッターメソッドがある場合（この場合、プロパティ名は大文字と小文字が区別されません）。
  • クラスに、指定された名前のメンバー変数がある場合（$checkVars が true の場合）。

また、canGetProperty() も参照してください。

public boolean canSetProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバー変数をプロパティとして扱うかどうか
return boolean

プロパティを書き込むことができるかどうか

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
challenge() public メソッド

認証失敗時にチャレンジを生成します。

たとえば、適切な HTTP ヘッダーが生成される場合があります。

public void challenge ( $response )
$response yii\web\Response 

                public function challenge($response)
{
    $response->getHeaders()->set('WWW-Authenticate', "Basic realm=\"{$this->realm}\"");
}
className() public static メソッド
2.0.14 以降非推奨。PHP >=5.5 では、代わりに ::class を使用してください。

定義元: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
return string

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
detach() public メソッド

定義元: yii\base\ActionFilter::detach()

ビヘイビアオブジェクトをコンポーネントからデタッチします。

デフォルトの実装では、$owner プロパティを unset し、events() で宣言されているイベントハンドラをデタッチします。このメソッドをオーバーライドする場合は、親の実装を呼び出すようにしてください。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        $this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
        $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
        $this->owner = null;
    }
}
events() public メソッド

定義元: yii\base\Behavior::events()

$owner のイベントのイベントハンドラを宣言します。

子クラスは、このメソッドをオーバーライドして、$owner コンポーネントのイベントにアタッチする必要がある PHP コールバックを宣言できます。

コールバックは、ビヘイビアがオーナーにアタッチされると $owner のイベントにアタッチされます。そして、ビヘイビアがコンポーネントからデタッチされると、イベントからデタッチされます。

コールバックは、次のいずれかになります。

  • このビヘイビアのメソッド: 'handleClick' は [$this, 'handleClick'] と同じです
  • オブジェクトメソッド: [$object, 'handleClick']
  • 静的メソッド: ['Page', 'handleClick']
  • 匿名関数: function ($event) { ... }

以下は例です

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
return array

イベント（配列のキー）と、対応するイベントハンドラメソッド（配列の値）。

 

                public function events()
{
    return [];
}
getActionId() protected メソッド (バージョン 2.0.7 から利用可能)

定義元: yii\base\ActionFilter::getActionId()

yii\base\Action::$uniqueId をモジュールに対する相対IDに変換して、アクションIDを返します。

protected string getActionId ( $action )
$action yii\base\Action 

                protected function getActionId($action)
{
    if ($this->owner instanceof Module) {
        $mid = $this->owner->getUniqueId();
        $id = $action->getUniqueId();
        if ($mid !== '' && strpos($id, $mid) === 0) {
            $id = substr($id, strlen($mid) + 1);
        }
    } else {
        $id = $action->id;
    }
    return $id;
}
handleFailure() public メソッド

定義元: yii\filters\auth\AuthMethod::handleFailure()

認証失敗を処理します。

通常、実装は認証失敗を示すために UnauthorizedHttpException をスローする必要があります。

public void handleFailure ( $response )
$response yii\web\Response
throws yii\web\UnauthorizedHttpException 

                public function handleFailure($response)
{
    throw new UnauthorizedHttpException('Your request was made with invalid credentials.');
}
hasMethod() public メソッド

定義元: yii\base\BaseObject::hasMethod()

メソッドが定義されているかどうかを示す値を返します。

デフォルトの実装は、PHP 関数 method_exists() を呼び出すことです。PHP のマジックメソッド __call() を実装した場合、このメソッドをオーバーライドできます。

public boolean hasMethod ( $name )
$name string

メソッド名
return boolean

メソッドが定義されているかどうか

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public メソッド

定義元: yii\base\BaseObject::hasProperty()

プロパティが定義されているかどうかを示す値を返します。

プロパティは、次の場合に定義されます。

  • クラスに、指定された名前に関連付けられたゲッターまたはセッターメソッドがある場合（この場合、プロパティ名は大小文字を区別しません）。
  • クラスに、指定された名前のメンバー変数がある場合（$checkVars が true の場合）。

参照

public boolean hasProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバー変数をプロパティとして扱うかどうか
return boolean

プロパティが定義されているかどうか

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public メソッド

定義元: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが指定された設定で初期化された後、コンストラクタの最後に呼び出されます。

public void init ( )

                public function init()
{
}
isActive() protected メソッド

定義元: yii\base\ActionFilter::isActive()

指定されたアクションに対してフィルターがアクティブかどうかを示す値を返します。

protected boolean isActive ( $action )
$action yii\base\Action

フィルタリングされているアクション
return boolean

指定されたアクションに対してフィルターがアクティブかどうか。

 

                protected function isActive($action)
{
    $id = $this->getActionId($action);
    if (empty($this->only)) {
        $onlyMatch = true;
    } else {
        $onlyMatch = false;
        foreach ($this->only as $pattern) {
            if (StringHelper::matchWildcard($pattern, $id)) {
                $onlyMatch = true;
                break;
            }
        }
    }
    $exceptMatch = false;
    foreach ($this->except as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            $exceptMatch = true;
            break;
        }
    }
    return !$exceptMatch && $onlyMatch;
}
isOptional() protected メソッド (バージョン 2.0.7 から利用可能)

定義元: yii\filters\auth\AuthMethod::isOptional()

指定されたアクションに対して認証がオプションであるかどうかをチェックします。

こちらも参照 $optional。

protected boolean isOptional ( $action )
$action yii\base\Action

チェックするアクション。
return boolean

認証がオプションかどうか。

 

                protected function isOptional($action)
{
    $id = $this->getActionId($action);
    foreach ($this->optional as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            return true;
        }
    }
    return false;
}