PHP Класс EntryController, vanilla

Наследование: extends BaseAppController
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$Form Gdn_Form
$UserModel UserModel
$UsernameError Reusable username requirement error message.
$Uses Models to include.

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

Свойство Тип Описание
$_RealDeliveryType Place to store DeliveryType.

Открытые методы

Метод Описание
__construct ( ) Setup error message & override MasterView for popups.
auth ( string $AuthenticationSchemeAlias = 'default' ) Authenticate the user attempting to sign in.
connect ( string $Method ) SSO facilitator page. Plugins use event ConnectData to complete SSO connections.
emailConfirm ( integer $UserID, string $EmailKey = '' ) Confirm email address is valid via sent code.
emailConfirmRequest ( integer $UserID = '' ) Send email confirmation message to user.
handshake ( string $AuthenticationSchemeAlias = 'default' ) Create secure handshake with remote authenticator.
index ( ) Default to SignIn().
initialize ( ) Include JS and CSS used by all methods.
leave ( string $AuthenticationSchemeAlias = 'default', string $TransientKey = '' ) Does actual de-authentication of a user. Used by SignOut().
password ( ) Auth via password.
passwordRequest ( ) Request password reset.
passwordReset ( integer $UserID = '', string $PasswordResetKey = '' ) Do password reset.
redirectTo ( ) : string Go to requested Target() or the default controller if none was set.
register ( string $InvitationCode = '' ) Calls the appropriate registration method based on the configuration setting.
registerInvitation ( integer $InvitationCode ) Invitation-only registration. Requires code.
registerThanks ( ) Display registration thank-you message
signIn ( string $Method = false, array $Arg1 = false ) : string Signin process that multiple authentication methods.
signIn2 ( ) : void Auth via default method. Simpler, old version of SignIn().
signOut ( string $TransientKey = "", $Override = "0" ) Good afternoon, good evening, and goodnight.
syncScreen ( object $Authenticator, array $UserInfo, array $Payload ) Attempt to syncronize user data from remote system into Dashboard.
target ( string $Target = false ) : string Set where to go after signin.

Защищенные методы

Метод Описание
_registrationView ( ) : string Alias of EntryController::getRegistrationHandler
_setRedirect ( boolean $CheckPopup = false ) After sign in, send them along.
checkOverride ( string $Type, string $Target, string $TransientKey = null ) Check the default provider to see if it overrides one of the entry methods and then redirect.
getRegistrationhandler ( ) : string Select view/method to be used for registration (from config).

Приватные методы

Метод Описание
registerApproval ( ) Registration that requires approval.
registerBasic ( ) Captcha-authenticated registration. Used by default.
registerCaptcha ( ) Captcha-authenticated registration.
registerClosed ( ) Registration not allowed.
registerConnect ( ) Connect registration

Описание методов

__construct() публичный Метод

Setup error message & override MasterView for popups.
С версии: 2.0.0
public __construct ( )

_registrationView() защищенный Метод

Alias of EntryController::getRegistrationHandler
Устаревший: since 2.3
protected _registrationView ( ) : string
Результат string

_setRedirect() защищенный Метод

After sign in, send them along.
С версии: 2.0.0
protected _setRedirect ( boolean $CheckPopup = false )
$CheckPopup boolean

auth() публичный Метод

Events: BeforeAuth
С версии: 2.0.0
public auth ( string $AuthenticationSchemeAlias = 'default' )
$AuthenticationSchemeAlias string Type of authentication we're attempting.

checkOverride() защищенный Метод

Check the default provider to see if it overrides one of the entry methods and then redirect.
protected checkOverride ( string $Type, string $Target, string $TransientKey = null )
$Type string One of the following. - SignIn - Register - SignOut (not complete)
$Target string
$TransientKey string

connect() публичный Метод

Users only see this page for non-seamless connections that prompt them to finish connecting by entering a username and/or password (and possibly email).
С версии: 2.0.0
public connect ( string $Method )
$Method string Used to register multiple providers on ConnectData event.

emailConfirm() публичный Метод

Confirm email address is valid via sent code.
С версии: 2.0.0
public emailConfirm ( integer $UserID, string $EmailKey = '' )
$UserID integer
$EmailKey string Authenticate with unique, 1-time code sent via email.

emailConfirmRequest() публичный Метод

Send email confirmation message to user.
С версии: 2.0.?
public emailConfirmRequest ( integer $UserID = '' )
$UserID integer

getRegistrationhandler() защищенный Метод

Select view/method to be used for registration (from config).
С версии: 2.3
protected getRegistrationhandler ( ) : string
Результат string Method name to invoke for registration

handshake() публичный Метод

Create secure handshake with remote authenticator.
С версии: 2.0.?
Автор: Tim Gunter
public handshake ( string $AuthenticationSchemeAlias = 'default' )
$AuthenticationSchemeAlias string (default: 'default')

index() публичный Метод

Default to SignIn().
С версии: 2.0.0
public index ( )

initialize() публичный Метод

Always called by dispatcher before controller's requested method.
С версии: 2.0.0
public initialize ( )

leave() публичный Метод

Does actual de-authentication of a user. Used by SignOut().
С версии: 2.0.0
public leave ( string $AuthenticationSchemeAlias = 'default', string $TransientKey = '' )
$AuthenticationSchemeAlias string
$TransientKey string Unique value to prove intent.

password() публичный Метод

Auth via password.
С версии: 2.0.0
public password ( )

passwordRequest() публичный Метод

Request password reset.
С версии: 2.0.0
public passwordRequest ( )

passwordReset() публичный Метод

Do password reset.
С версии: 2.0.0
public passwordReset ( integer $UserID = '', string $PasswordResetKey = '' )
$UserID integer Unique.
$PasswordResetKey string Authenticate with unique, 1-time code sent via email.

redirectTo() публичный Метод

Go to requested Target() or the default controller if none was set.
С версии: 2.0.0
public redirectTo ( ) : string
Результат string URL.

register() публичный Метод

Events: Register
С версии: 2.0.0
public register ( string $InvitationCode = '' )
$InvitationCode string Unique code given to invited user.

registerInvitation() публичный Метод

Invitation-only registration. Requires code.
С версии: 2.0.0
public registerInvitation ( integer $InvitationCode )
$InvitationCode integer

registerThanks() публичный Метод

Display registration thank-you message
С версии: 2.1
public registerThanks ( )

signIn() публичный Метод

Signin process that multiple authentication methods.
С версии: 2.0.0
Автор: Tim Gunter
public signIn ( string $Method = false, array $Arg1 = false ) : string
$Method string
$Arg1 array
Результат string Rendered XHTML template.

signIn2() публичный Метод

Events: SignIn
public signIn2 ( ) : void
Результат void

signOut() публичный Метод

Events: SignOut
С версии: 2.0.0
public signOut ( string $TransientKey = "", $Override = "0" )
$TransientKey string (default: "")

syncScreen() публичный Метод

Attempt to syncronize user data from remote system into Dashboard.
С версии: 2.0.?
Автор: Tim Gunter
public syncScreen ( object $Authenticator, array $UserInfo, array $Payload )
$Authenticator object
$UserInfo array
$Payload array

target() публичный Метод

Set where to go after signin.
С версии: 2.0.0
public target ( string $Target = false ) : string
$Target string Where we're requested to go to.
Результат string URL to actually go to (validated & safe).

Описание свойств

$Form публичное свойство

public Gdn_Form $Form
Результат Gdn_Form

$UserModel публичное свойство

public UserModel $UserModel
Результат UserModel

$UsernameError публичное свойство

Reusable username requirement error message.
public $UsernameError

$Uses публичное свойство

Models to include.
public $Uses

$_RealDeliveryType защищенное свойство

Place to store DeliveryType.
protected $_RealDeliveryType