RegistrationForm Class Reference

Inheritance diagram for RegistrationForm:

Public Member Functions
	__construct ($site)
	_setMailFrom ($request, $mail)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	initData ()
	readInputData ()
	validate ($callHooks=true)
Public Member Functions inherited from Form
	__construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
	_decomposeArray ($name, $value, $stack)
	addCheck ($formValidator)
	addError ($field, $message)
	addErrorField ($field)
	addSupportedFormLocale ($supportedLocale)
	display ($request=null, $template=null)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)

Data Fields
	$captchaEnabled
	$defaultAuth
	$existingUser
	$user
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for user registration.

Definition at line 21 of file RegistrationForm.inc.php.

Constructor & Destructor Documentation

__construct()

RegistrationForm::__construct

(

$site

)

Constructor.

Definition at line 50 of file RegistrationForm.inc.php.

References $defaultAuth, Form\addCheck(), PKPApplication\get(), DAORegistry\getDAO(), and Config\getVar().

Member Function Documentation

_setMailFrom()

RegistrationForm::_setMailFrom	(		$request,
			$mail
	)

Set mail from address

Parameters

$request	PKPRequest
$mail	MailTemplate

Definition at line 359 of file RegistrationForm.inc.php.

Referenced by execute().

execute()

RegistrationForm::execute

(

$functionArgs

)

Register a new user.

Returns

int|null User ID, or false on failure

Reimplemented from Form.

Definition at line 227 of file RegistrationForm.inc.php.

References $user, _setMailFrom(), Validation\encryptCredentials(), PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), AppLocale\getLocale(), SessionManager\getManager(), and Config\getVar().

fetch()

RegistrationForm::fetch	(		$request,
			$template = null,
			$display = false
	)

Returns a string of the rendered form

Parameters

$request	PKPRequest
$template	string the template to be rendered, mandatory if no template has been specified on class instantiation.
$display	boolean

Returns

string the rendered form

Reimplemented from Form.

Definition at line 99 of file RegistrationForm.inc.php.

References PKPTemplateManager\getManager(), and Config\getVar().

initData()

RegistrationForm::initData

(

)

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 138 of file RegistrationForm.inc.php.

readInputData()

RegistrationForm::readInputData

(

)

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 148 of file RegistrationForm.inc.php.

References Form\getData(), Form\readUserVars(), and Form\setData().

validate()

RegistrationForm::validate

(

$callHooks = true

)

Validate form data.

Parameters

$callHooks

boolean True (default) iff hooks are to be called.

Reimplemented from Form.

Definition at line 183 of file RegistrationForm.inc.php.

References Form\addError(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and Config\getVar().

Field Documentation

$captchaEnabled

boolean RegistrationForm::$captchaEnabled

whether or not captcha is enabled for this form

Definition at line 45 of file RegistrationForm.inc.php.

$defaultAuth

AuthPlugin RegistrationForm::$defaultAuth

default authentication source, if specified

Definition at line 39 of file RegistrationForm.inc.php.

Referenced by __construct().

$existingUser

boolean RegistrationForm::$existingUser

user is already registered with another context

Definition at line 33 of file RegistrationForm.inc.php.

$user

User RegistrationForm::$user

The user object being created (available to hooks during registrationform::execute hook)

Definition at line 27 of file RegistrationForm.inc.php.

Referenced by execute().

---

The documentation for this class was generated from the following file:

• RegistrationForm.inc.php