• 홈
• yii
• authclient
• AuthAction

PHP 클래스 yii\authclient\AuthAction

It supports OpenId, OAuth1 and OAuth2 client types. Usage: php 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 } } Usually authentication via external services is performed inside the popup window. This action handles the redirection and closing of popup window correctly. 파일 보기 프로젝트 열기: yiisoft/yii2-authclient 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$clientCollection		name of the auth client collection application component. It should point to Collection instance.
$clientIdGetParamName		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.
$redirectView		name or alias of the view file, which should be rendered in order to perform redirection. If not set - default one will be used.
$successCallback		PHP callback, which should be triggered in case of successful authentication. This callback should accept [[ClientInterface]] instance as an argument. For example: php public function onAuthSuccess($client) { $attributes = $client->getUserAttributes(); user login or signup comes here } If this callback returns [[Response]] instance, it will be used as action response, otherwise redirection to [[successUrl]] will be performed.

공개 메소드들

메소드	설명
getCancelUrl ( ) : string
getSuccessUrl ( ) : string
redirect ( mixed $url, boolean $enforceRedirect = true ) : Response	Redirect to the given URL or simply close the popup window.
redirectCancel ( string $url = null ) : Response	Redirect to the [[cancelUrl]] or simply close the popup window.
redirectSuccess ( string $url = null ) : Response	Redirect to the URL. If URL is null, [[successUrl]] will be used.
run ( )	Runs the action.
setCancelUrl ( string $url )
setSuccessUrl ( string $url )

보호된 메소드들

메소드	설명
auth ( mixed $client ) : Response	Perform authentication for the given client.
authOAuth1 ( OAuth1 $client ) : Response	Performs OAuth1 auth flow.
authOAuth2 ( OAuth2 $client ) : Response	Performs OAuth2 auth flow.
authOpenId ( OpenId $client ) : Response	Performs OpenID auth flow.
authSuccess ( yii\authclient\ClientInterface $client ) : Response	This method is invoked in case of successful authentication via auth client.
defaultCancelUrl ( ) : string	Creates default [[cancelUrl]] value.
defaultSuccessUrl ( ) : string	Creates default [[successUrl]] value.

메소드 상세

프로퍼티 상세