Класс yii\authclient\AuthAction

AuthAction выполняет аутентификацию через разные службы аутентификации.

Он поддерживает типы клиентов yii\authclient\OpenId, yii\authclient\OAuth1 и yii\authclient\OAuth2.

Использование:

class SiteController extends Controller
{
    public function actions()
    {
        return [
            'auth' => [
                'class' => 'yii\authclient\AuthAction',
                'successCallback' => [$this, 'successCallback'],
            ],
        ]
    }

    public function successCallback($client)
    {
        $attributes = $client->getUserAttributes();
        // user login or signup comes here
    }
}

Обычно аутентификация через внешние сервисы выполняется в всплывающем окне. Этот action правильно обрабатывает перенаправление и закрытие всплывающего окна.

См. также:

• yii\authclient\Collection
• yii\authclient\widgets\AuthChoice

Публичные свойства

Публичные методы

Защищенные методы

Подробное описание свойств

$cancelUrl публичное свойство

URL отмены.

public string getCancelUrl ( )
public void setCancelUrl ( $url )

$clientCollection публичное свойство

Имя компонента приложения для коллекции клиентов аутентификации. Оно должно указывать на экземпляр yii\authclient\Collection.

public string $clientCollection = 'authClientCollection'

$clientIdGetParamName публичное свойство

Имя параметра GET, используемого для передачи идентификатора клиента аутентификации в это действие. Примечание: обратите внимание на именование, убедитесь, что вы не выбираете имя, используемое в каком-либо протоколе аутентификации.

public string $clientIdGetParamName = 'authclient'

$redirectView публичное свойство

Имя или псевдоним файла представления, который должен быть отрисован для выполнения перенаправления. Если не задано, будет использоваться значение по умолчанию.

public string $redirectView = null

$successCallback публичное свойство

PHP обратный вызов, который должен быть вызван в случае успешной аутентификации. Этот обратный вызов должен принимать экземпляр yii\authclient\ClientInterface в качестве аргумента. Например:

public function onAuthSuccess($client)
{
    $attributes = $client->getUserAttributes();
    // user login or signup comes here
}

Если этот обработчик возвращает экземпляр yii\web\Response, он будет использован в качестве ответа действия, в противном случае произойдёт переадресация на $successUrl.

public callable $successCallback = null

$successUrl общее свойство

Успешный URL.

public string getSuccessUrl ( )
public void setSuccessUrl ( $url )

Подробное описание методов