PHP Класс Airship\Cabin\Bridge\Landing\Account

Landing for user account stuff. Also contains the login and registration forms.
Наследование: extends LandingGear, use trait Security
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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