authclient\AuthAction $clientIdGetParamName

$clientIdGetParamName public property Name of the GET param, which is used to passed auth client id to this action. Note: watch for the naming, make sure you do not choose name used in some auth protocol. public string $clientIdGetParamName = 'authclient'

authclient\AuthAction $redirectView

$redirectView public property Name or alias of the view file, which should be rendered in order to perform redirection. If not set default one will be used. public string $redirectView = null

authclient\AuthAction $successCallback

$successCallback public property PHP callback, which should be triggered in case of successful authentication. This callback should accept yii\authclient\ClientInterface instance as an argument. For example: public function onAuthSuccess($client) { $attributes = $client->getUserAttributes(); // user login or signup comes here } If this callback returns yii\web\Response instance, it will be used as action response, otherwise redirection to $successUrl will be performed. public c

authclient\AuthAction $successUrl

$successUrl public property Successful URL. public string getSuccessUrl ( )public void setSuccessUrl ( $url )

authclient\AuthAction auth()

auth() protected method protected yii\web\Response auth ( $client )$client mixed Auth client instance. return yii\web\Response Response instance. throws yii\base\NotSupportedException on invalid client.

authclient\AuthAction authOAuth1()

authOAuth1() protected method Performs OAuth1 auth flow. protected yii\web\Response authOAuth1 ( $client )$client yii\authclient\OAuth1 Auth client instance. return yii\web\Response Action response.

authclient\AuthAction authOAuth2()

authOAuth2() protected method Performs OAuth2 auth flow. protected yii\web\Response authOAuth2 ( $client )$client yii\authclient\OAuth2 Auth client instance. return yii\web\Response Action response. throws yii\base\Exception on failure.

authclient\AuthAction authOpenId()

authOpenId() protected method Performs OpenID auth flow. protected yii\web\Response authOpenId ( $client )$client yii\authclient\OpenId Auth client instance. return yii\web\Response Action response. throws yii\base\Exception on failure. throws yii\web\HttpException on failure.

authclient\AuthAction authSuccess()

authSuccess() protected method This method is invoked in case of successful authentication via auth client. protected yii\web\Response authSuccess ( $client )$client yii\authclient\ClientInterface Auth client instance. return yii\web\Response Response instance. throws yii\base\InvalidConfigException on invalid success callback.

authclient\AuthAction defaultCancelUrl()

defaultCancelUrl() protected method Creates default $cancelUrl value. protected string defaultCancelUrl ( )return string Cancel URL value.