PHP 클래스 Gdn_Authenticator, vanilla

상속: extends Gdn_Pluggable
파일 보기 프로젝트 열기: vanilla/vanilla 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$_DataHooks array

보호된 프로퍼티들

프로퍼티 타입 설명
$_AuthenticationSchemeAlias Alias of the authentication scheme to use, e.g. "password" or "openid".
$_DataSource null
$_DataSourceType string

공개 메소드들

메소드 설명
__construct ( )
authenticate ( ) Returns the unique id assigned to the user in the database.
authorizeToken ( $TokenKey ) : boolean
clearNonces ( $TokenKey )
createToken ( $TokenType, $ProviderKey, null $UserKey = null, boolean $Authorized = false ) : array | boolean
currentStep ( )
dataSourceType ( ) : string
deAuthenticate ( )
deleteToken ( $ProviderKey, $UserKey, $TokenType )
failedResponse ( ) What to do if the entry/auth/* page is triggered but login is denied or fails.
fetchData ( $DataSource, array $DirectSupplied = [] )
getAuthenticationSchemeAlias ( ) : string
getNonce ( ) : array | boolean | stdClass
getProvider ( null $ProviderKey = null, boolean $Force = false ) : array | boolean | stdClass
getProviderKey ( ) : boolean
getProviderSecret ( ) : boolean
getProviderUrl ( ) : boolean
getProviderValue ( $Key, boolean $Default = false ) : boolean
getToken ( ) : array | boolean | stdClass
getURL ( $URLType ) : mixed Get one of the three Forwarding URLs (Registration, SignIn, SignOut).
getValue ( $Key, boolean $Default = false ) : boolean
hookDataField ( $InternalFieldName, $DataFieldName, boolean $DataFieldRequired = true )
loginResponse ( ) What to do if entry/auth/* is called while the user is logged out.
logoutResponse ( ) What to do if the entry/leave/* page is triggered for a user that is logged in and successfully logs out.
lookupNonce ( $TokenKey, null $Nonce = null ) : boolean
lookupToken ( $ProviderKey, $UserKey, null $TokenType = null ) : array | boolean | stdClass
partialResponse ( ) What to do after part 1 of a 2 part authentication process.
repeatResponse ( ) What to do if the entry/auth/* page is triggered for a user that is already logged in.
requireLogoutTransientKey ( ) : boolean
setIdentity ( $UserID, boolean $Persist = true )
setNonce ( $TokenKey, $Nonce, null $Timestamp = null ) : boolean
successResponse ( ) What to do after authentication has succeeded.
wakeUp ( )

보호된 메소드들

메소드 설명
_checkHookedFields ( ) : string

메소드 상세

__construct() 공개 메소드

public __construct ( )

_checkHookedFields() 보호된 메소드

protected _checkHookedFields ( ) : string
리턴 string

authenticate() 추상적인 공개 메소드

This method should return 0 if the username/password combination were not found, or -1 if the user does not have permission to sign in.
abstract public authenticate ( )

authorizeToken() 공개 메소드

public authorizeToken ( $TokenKey ) : boolean
$TokenKey
리턴 boolean

clearNonces() 공개 메소드

public clearNonces ( $TokenKey )
$TokenKey

createToken() 공개 메소드

public createToken ( $TokenType, $ProviderKey, null $UserKey = null, boolean $Authorized = false ) : array | boolean
$TokenType
$ProviderKey
$UserKey null
$Authorized boolean
리턴 array | boolean

currentStep() 추상적인 공개 메소드

abstract public currentStep ( )

dataSourceType() 공개 메소드

public dataSourceType ( ) : string
리턴 string

deAuthenticate() 추상적인 공개 메소드

abstract public deAuthenticate ( )

deleteToken() 공개 메소드

public deleteToken ( $ProviderKey, $UserKey, $TokenType )
$ProviderKey
$UserKey
$TokenType

failedResponse() 공개 메소드

What to do if the entry/auth/* page is triggered but login is denied or fails.
public failedResponse ( )

fetchData() 공개 메소드

public fetchData ( $DataSource, array $DirectSupplied = [] )
$DataSource
$DirectSupplied array

getAuthenticationSchemeAlias() 공개 메소드

getNonce() 공개 메소드

public getNonce ( ) : array | boolean | stdClass
리턴 array | boolean | stdClass

getProvider() 공개 메소드

public getProvider ( null $ProviderKey = null, boolean $Force = false ) : array | boolean | stdClass
$ProviderKey null
$Force boolean
리턴 array | boolean | stdClass

getProviderKey() 공개 메소드

public getProviderKey ( ) : boolean
리턴 boolean

getProviderSecret() 공개 메소드

public getProviderSecret ( ) : boolean
리턴 boolean

getProviderUrl() 공개 메소드

public getProviderUrl ( ) : boolean
리턴 boolean

getProviderValue() 공개 메소드

public getProviderValue ( $Key, boolean $Default = false ) : boolean
$Key
$Default boolean
리턴 boolean

getToken() 공개 메소드

public getToken ( ) : array | boolean | stdClass
리턴 array | boolean | stdClass

getURL() 추상적인 공개 메소드

Get one of the three Forwarding URLs (Registration, SignIn, SignOut).
abstract public getURL ( $URLType ) : mixed
$URLType
리턴 mixed

getValue() 공개 메소드

public getValue ( $Key, boolean $Default = false ) : boolean
$Key
$Default boolean
리턴 boolean

hookDataField() 공개 메소드

public hookDataField ( $InternalFieldName, $DataFieldName, boolean $DataFieldRequired = true )
$InternalFieldName
$DataFieldName
$DataFieldRequired boolean

loginResponse() 추상적인 공개 메소드

Should normally be REACT_RENDER.
abstract public loginResponse ( )

logoutResponse() 공개 메소드

What to do if the entry/leave/* page is triggered for a user that is logged in and successfully logs out.
public logoutResponse ( )

lookupNonce() 공개 메소드

public lookupNonce ( $TokenKey, null $Nonce = null ) : boolean
$TokenKey
$Nonce null
리턴 boolean

lookupToken() 공개 메소드

public lookupToken ( $ProviderKey, $UserKey, null $TokenType = null ) : array | boolean | stdClass
$ProviderKey
$UserKey
$TokenType null
리턴 array | boolean | stdClass

partialResponse() 추상적인 공개 메소드

This is used in conjunction with OAauth/OpenID type authentication schemes.
abstract public partialResponse ( )

repeatResponse() 추상적인 공개 메소드

What to do if the entry/auth/* page is triggered for a user that is already logged in.
abstract public repeatResponse ( )

requireLogoutTransientKey() 공개 메소드

setIdentity() 공개 메소드

public setIdentity ( $UserID, boolean $Persist = true )
$UserID
$Persist boolean

setNonce() 공개 메소드

public setNonce ( $TokenKey, $Nonce, null $Timestamp = null ) : boolean
$TokenKey
$Nonce
$Timestamp null
리턴 boolean

successResponse() 추상적인 공개 메소드

What to do after authentication has succeeded.
abstract public successResponse ( )

wakeUp() 추상적인 공개 메소드

abstract public wakeUp ( )

프로퍼티 상세

$_AuthenticationSchemeAlias 보호되어 있는 프로퍼티

Alias of the authentication scheme to use, e.g. "password" or "openid".
protected $_AuthenticationSchemeAlias

$_DataHooks 공개적으로 프로퍼티

public array $_DataHooks
리턴 array

$_DataSource 보호되어 있는 프로퍼티

protected null $_DataSource
리턴 null

$_DataSourceType 보호되어 있는 프로퍼티

protected string $_DataSourceType
리턴 string