API Documentation
Back to top  

FormLoginHandler

Handler that handles login from a form on a custom login page.

Used in conjunction with the @see \io\vertx\jphp\ext\web\handler\RedirectAuthHandler.

package

Default

Methods

__construct

__construct()

Create a handler

create( $arg0,  $arg1 = null,  $arg2 = null,  $arg3 = null,  $arg4 = null) : \io\vertx\jphp\ext\web\handler\FormLoginHandler
static

param $authProvider [AuthProvider] the auth service to use create($authProvider)

Create a handler

param $authProvider [AuthProvider] the auth service to use param $usernameParam [string] the value of the form attribute which will contain the username param $passwordParam [string] the value of the form attribute which will contain the password param $returnURLParam [string] the value of the session attribute which will contain the return url param $directLoggedInOKURL [string] a url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first create($authProvider, $usernameParam, $passwordParam, $returnURLParam, $directLoggedInOKURL)

Arguments

$arg0

AuthProvider

$arg1

string

$arg2

string

$arg3

string

$arg4

string

Response

\io\vertx\jphp\ext\web\handler\FormLoginHandler

the handler

Something has happened, so handle it.

handle( $arg0) : void

Arguments

$arg0

RoutingContext

Set the url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first

setDirectLoggedInOKURL( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this for a fluent API

Set the name of the form param used to submit the password

setPasswordParam( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this for a fluent API

Set the name of the session attrioute used to specify the return url

setReturnURLParam( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this for a fluent API

Set the name of the form param used to submit the username

setUsernameParam( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this for a fluent API

Constants

The default value of the form attribute which will contain the username

DEFAULT_USERNAME_PARAM
var

php文件只是为了写代码方便，常量的实际值请参考原java文件

The default value of the form attribute which will contain the password

DEFAULT_PASSWORD_PARAM
var

php文件只是为了写代码方便，常量的实际值请参考原java文件

The default value of the session attribute which will contain the return url

DEFAULT_RETURN_URL_PARAM
var

php文件只是为了写代码方便，常量的实际值请参考原java文件