UserDisableForm Class Reference

Inheritance diagram for UserDisableForm:

Public Member Functions
	__construct ($userId, $enable=false)
	display ($request=null, $template=null)
	execute (... $functionArgs)
	initData ()
	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)
	fetch ($request, $template=null, $display=false)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

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

Detailed Description

Form for enabling/disabling a user.

Definition at line 18 of file UserDisableForm.inc.php.

Constructor & Destructor Documentation

__construct()

UserDisableForm::__construct	(		$userId,
			$enable = false
	)

Constructor.

Definition at line 35 of file UserDisableForm.inc.php.

References Form\addCheck().

Member Function Documentation

display()

UserDisableForm::display	(		$request = null,
			$template = null
	)

Display the form.

Parameters

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

Reimplemented from Form.

Definition at line 77 of file UserDisableForm.inc.php.

References Form\fetch(), and PKPTemplateManager\getManager().

execute()

UserDisableForm::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 89 of file UserDisableForm.inc.php.

References DAORegistry\getDAO(), and Form\getData().

initData()

UserDisableForm::initData

(

)

Initialize form data.

Reimplemented from Form.

Definition at line 48 of file UserDisableForm.inc.php.

References DAORegistry\getDAO().

readInputData()

UserDisableForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 65 of file UserDisableForm.inc.php.

References Form\readUserVars().

Field Documentation

$_enable

UserDisableForm::$_enable

Definition at line 30 of file UserDisableForm.inc.php.

$_userId

UserDisableForm::$_userId

Definition at line 24 of file UserDisableForm.inc.php.

---

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

• UserDisableForm.inc.php