ChangePasswordForm Class Reference

Inheritance diagram for ChangePasswordForm:

Public Member Functions
	__construct ($user, $site)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getSite ()
	getUser ()
	readInputData ()
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 ()
	initData ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_site
	$_user
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form to change a user's password.

Definition at line 19 of file ChangePasswordForm.inc.php.

Constructor & Destructor Documentation

__construct()

ChangePasswordForm::__construct	(		$user,
			$site
	)

Constructor.

Definition at line 36 of file ChangePasswordForm.inc.php.

References Form\addCheck(), and Validation\checkCredentials().

Member Function Documentation

execute()

ChangePasswordForm::execute

(

$functionArgs

)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters

mixed

$functionArgs,...

Arguments from the caller to be passed to the hook consumer

Returns

mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 96 of file ChangePasswordForm.inc.php.

References Validation\encryptCredentials(), Validation\generatePassword(), DAORegistry\getDAO(), and getUser().

fetch()

ChangePasswordForm::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 77 of file ChangePasswordForm.inc.php.

References PKPTemplateManager\getManager(), getSite(), and getUser().

getSite()

ChangePasswordForm::getSite

(

)

Get the site

Definition at line 70 of file ChangePasswordForm.inc.php.

References $_site.

Referenced by fetch().

getUser()

ChangePasswordForm::getUser

(

)

Get the user associated with this password

Definition at line 63 of file ChangePasswordForm.inc.php.

References $_user.

Referenced by execute(), and fetch().

readInputData()

ChangePasswordForm::readInputData

(

)

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 89 of file ChangePasswordForm.inc.php.

References Form\readUserVars().

Field Documentation

$_site

object ChangePasswordForm::$_site

Definition at line 31 of file ChangePasswordForm.inc.php.

Referenced by getSite().

$_user

object ChangePasswordForm::$_user

Definition at line 25 of file ChangePasswordForm.inc.php.

Referenced by getUser().

---

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

• ChangePasswordForm.inc.php