PHP Class Airship\Cabin\Bridge\Landing\Account

Landing for user account stuff. Also contains the login and registration forms.
Inheritance: extends LandingGear, use trait Security
Afficher le fichier Open project: paragonie/airship

Protected Properties

Свойство Type Description
$acct Airship\Cabin\Bridge\Blueprint\UserAccounts

Méthodes publiques

Méthode Description
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.

Méthodes protégées

Méthode Description
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

Method Details

airshipLand() public méthode

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

board() public méthode

Process the /board API endpoint.
public board ( )

findMotif() protected méthode

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

getGPGPublicKey() protected méthode

Return the public key corresponding to a fingerprint
protected getGPGPublicKey ( string $fingerprint ) : string
$fingerprint string
Résultat string

getOffsetAndLimit() protected méthode

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

login() public méthode

Handle login requests
public login ( )

logout() public méthode

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

my() public méthode

public my ( )

myIndex() public méthode

public myIndex ( )

preferences() public méthode

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

processAccountUpdate() protected méthode

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

processBoard() protected méthode

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

processLogin() protected méthode

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

processRecoverAccount() protected méthode

Process account recovery
protected processRecoverAccount ( array $post ) : boolean
$post array
Résultat boolean

processRecoveryToken() protected méthode

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

publicDirectory() public méthode

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

recoverAccount() public méthode

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

recoveryMessage() protected méthode

protected recoveryMessage ( string $token ) : string
$token string
Résultat string

savePreferences() protected méthode

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

twoFactorPreamble() protected méthode

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

twoFactorSetup() public méthode

public twoFactorSetup ( )

twoFactorSetupQRCode() public méthode

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

Property Details

$acct protected_oe property

protected UserAccounts,Airship\Cabin\Bridge\Blueprint $acct
Résultat Airship\Cabin\Bridge\Blueprint\UserAccounts