PHP 클래스 Airship\Cabin\Bridge\Landing\Account

Landing for user account stuff. Also contains the login and registration forms.
상속: extends LandingGear, use trait Security
파일 보기 프로젝트 열기: paragonie/airship

보호된 프로퍼티들

프로퍼티 타입 설명
$acct Airship\Cabin\Bridge\Blueprint\UserAccounts

공개 메소드들

메소드 설명
airshipLand ( ) This function is called after the dependencies have been injected by AutoPilot. Think of it as a user-land constructor.
board ( ) Process the /board API endpoint.
login ( ) Handle login requests
logout ( string $token ) CSRF-resistant logout script
my ( )
myIndex ( )
preferences ( ) Allows users to select which Motif to use
publicDirectory ( string $page = '' ) A directory of public users
recoverAccount ( string $token = '' )
twoFactorSetup ( )
twoFactorSetupQRCode ( ) Returns the user's QR code.

보호된 메소드들

메소드 설명
findMotif ( array $motifs, string $supplier, string $motifName ) : boolean Is this motif part of this cabin?
getGPGPublicKey ( string $fingerprint ) : string Return the public key corresponding to a fingerprint
getOffsetAndLimit ( string $page = null, integer $per_page ) : int[] Gets [offset, limit] based on configuration
processAccountUpdate ( array $post = [], array $account = [], string $gpg_public_key = '' ) Process a user account update
processBoard ( array $post = [] ) Process a user account registration request
processLogin ( array $post = [] ) Handle user authentication
processRecoverAccount ( array $post ) : boolean Process account recovery
processRecoveryToken ( string $token ) If the token is valid, log in as the user.
recoveryMessage ( string $token ) : string
savePreferences ( array $prefs = [], array $cabins = [], array $motifs = [] ) : boolean Save a user's preferences
twoFactorPreamble ( integer $userID ) : ParagonIE\MultiFactor\Vendor\GoogleAuth Make sure the secret exists, then get the GoogleAuth object

메소드 상세

airshipLand() 공개 메소드

This function is called after the dependencies have been injected by AutoPilot. Think of it as a user-land constructor.
public airshipLand ( )

board() 공개 메소드

Process the /board API endpoint.
public board ( )

findMotif() 보호된 메소드

Is this motif part of this cabin?
protected findMotif ( array $motifs, string $supplier, string $motifName ) : boolean
$motifs array
$supplier string
$motifName string
리턴 boolean

getGPGPublicKey() 보호된 메소드

Return the public key corresponding to a fingerprint
protected getGPGPublicKey ( string $fingerprint ) : string
$fingerprint string
리턴 string

getOffsetAndLimit() 보호된 메소드

Gets [offset, limit] based on configuration
protected getOffsetAndLimit ( string $page = null, integer $per_page ) : int[]
$page string
$per_page integer
리턴 int[]

login() 공개 메소드

Handle login requests
public login ( )

logout() 공개 메소드

CSRF-resistant logout script
public logout ( string $token )
$token string

my() 공개 메소드

public my ( )

myIndex() 공개 메소드

public myIndex ( )

preferences() 공개 메소드

Allows users to select which Motif to use
public preferences ( )

processAccountUpdate() 보호된 메소드

Process a user account update
protected processAccountUpdate ( array $post = [], array $account = [], string $gpg_public_key = '' )
$post array
$account array
$gpg_public_key string

processBoard() 보호된 메소드

Process a user account registration request
protected processBoard ( array $post = [] )
$post array

processLogin() 보호된 메소드

Handle user authentication
protected processLogin ( array $post = [] )
$post array

processRecoverAccount() 보호된 메소드

Process account recovery
protected processRecoverAccount ( array $post ) : boolean
$post array
리턴 boolean

processRecoveryToken() 보호된 메소드

If the token is valid, log in as the user.
protected processRecoveryToken ( string $token )
$token string

publicDirectory() 공개 메소드

A directory of public users
public publicDirectory ( string $page = '' )
$page string

recoverAccount() 공개 메소드

public recoverAccount ( string $token = '' )
$token string

recoveryMessage() 보호된 메소드

protected recoveryMessage ( string $token ) : string
$token string
리턴 string

savePreferences() 보호된 메소드

Save a user's preferences
protected savePreferences ( array $prefs = [], array $cabins = [], array $motifs = [] ) : boolean
$prefs array
$cabins array
$motifs array
리턴 boolean

twoFactorPreamble() 보호된 메소드

Make sure the secret exists, then get the GoogleAuth object
protected twoFactorPreamble ( integer $userID ) : ParagonIE\MultiFactor\Vendor\GoogleAuth
$userID integer
리턴 ParagonIE\MultiFactor\Vendor\GoogleAuth

twoFactorSetup() 공개 메소드

public twoFactorSetup ( )

twoFactorSetupQRCode() 공개 메소드

Returns the user's QR code.
public twoFactorSetupQRCode ( )

프로퍼티 상세

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

protected UserAccounts,Airship\Cabin\Bridge\Blueprint $acct
리턴 Airship\Cabin\Bridge\Blueprint\UserAccounts