PHP Class RegistrationForm, pkp-lib

RegistrationForm is the data structure for keeping user registration form data. It is used by the 'registration' action of 'UserController'.
Inheritance: extends User
Show file Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property Type Description
$captchaEnabled whether or not captcha is enabled for this form
$defaultAuth default authentication source, if specified
$existingUser user is already registered with another context

Public Methods

Method Description
__construct ( $site ) Constructor.
_setMailFrom ( $request, MailTemplate $mail ) Set mail from address
execute ( $request ) : integer | null Register a new user.
fetch ( $request, $template = null, $display = false )
initData ( $request )
readInputData ( ) Assign form data to user-submitted data.
validate ( ) Validate the form

Method Details

__construct() public method

Constructor.
public __construct ( $site )

_setMailFrom() public method

Set mail from address
public _setMailFrom ( $request, MailTemplate $mail )
$request PKPRequest
$mail MailTemplate

execute() public method

Register a new user.
public execute ( $request ) : integer | null
$request PKPRequest
return integer | null User ID, or false on failure

fetch() public method

public fetch ( $request, $template = null, $display = false )

initData() public method

public initData ( $request )
$request Request

readInputData() public method

Assign form data to user-submitted data.
public readInputData ( )

validate() public method

Validate the form
public validate ( )

Property Details

$captchaEnabled public property

whether or not captcha is enabled for this form
public $captchaEnabled

$defaultAuth public property

default authentication source, if specified
public $defaultAuth

$existingUser public property

user is already registered with another context
public $existingUser