IdentificationCodeForm Class Reference

Inheritance diagram for IdentificationCodeForm:

Public Member Functions
	__construct ($submission, $publication, $identificationCode)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getIdentificationCode ()
	getPublication ()
	getSubmission ()
	initData ()
	readInputData ()
	setIdentificationCode ($identificationCode)
	setPublication ($publication)
	setSubmission ($submission)
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)
	validate ($callHooks=true)

Data Fields
	$_identificationCode
	$_publication
	$_submission
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing an identification code.

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

Constructor & Destructor Documentation

__construct()

IdentificationCodeForm::__construct	(		$submission,
			$publication,
			$identificationCode
	)

Constructor.

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

References Form\addCheck(), setIdentificationCode(), setPublication(), and setSubmission().

Member Function Documentation

execute()

IdentificationCodeForm::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 176 of file IdentificationCodeForm.inc.php.

References fatalError(), DAORegistry\getDAO(), Form\getData(), getIdentificationCode(), getPublication(), and getSubmission().

fetch()

IdentificationCodeForm::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 118 of file IdentificationCodeForm.inc.php.

References fatalError(), DAORegistry\getDAO(), getIdentificationCode(), PKPTemplateManager\getManager(), getPublication(), getSubmission(), and PluginRegistry\loadCategory().

getIdentificationCode()

IdentificationCodeForm::getIdentificationCode

(

)

Get the code

Returns

IdentificationCode

Definition at line 52 of file IdentificationCodeForm.inc.php.

References $_identificationCode.

Referenced by execute(), fetch(), and initData().

getPublication()

IdentificationCodeForm::getPublication

(

)

Get the Publication

Returns

Publication

Definition at line 84 of file IdentificationCodeForm.inc.php.

References $_publication.

Referenced by execute(), and fetch().

getSubmission()

IdentificationCodeForm::getSubmission

(

)

Get the Submission

Returns

Submission

Definition at line 68 of file IdentificationCodeForm.inc.php.

References $_submission.

Referenced by execute(), and fetch().

initData()

IdentificationCodeForm::initData

(

)

Initialize form data from the identification code.

Reimplemented from Form.

Definition at line 103 of file IdentificationCodeForm.inc.php.

References getIdentificationCode().

readInputData()

IdentificationCodeForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 164 of file IdentificationCodeForm.inc.php.

References Form\readUserVars().

setIdentificationCode()

IdentificationCodeForm::setIdentificationCode

(

$identificationCode

)

Set the code

Parameters

Definition at line 60 of file IdentificationCodeForm.inc.php.

Referenced by __construct().

setPublication()

IdentificationCodeForm::setPublication

(

$publication

)

Set the Publication

Parameters

Publication

Definition at line 92 of file IdentificationCodeForm.inc.php.

Referenced by __construct().

setSubmission()

IdentificationCodeForm::setSubmission

(

$submission

)

Set the Submission

Parameters

Submission

Definition at line 76 of file IdentificationCodeForm.inc.php.

Referenced by __construct().

Field Documentation

$_identificationCode

IdentificationCodeForm::$_identificationCode

Identification Code the code being edited

Definition at line 26 of file IdentificationCodeForm.inc.php.

Referenced by getIdentificationCode().

$_publication

IdentificationCodeForm::$_publication

The publication associated with the format being edited

Definition at line 23 of file IdentificationCodeForm.inc.php.

Referenced by getPublication().

$_submission

IdentificationCodeForm::$_submission

The submission associated with the format being edited

Definition at line 20 of file IdentificationCodeForm.inc.php.

Referenced by getSubmission().

---

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

• IdentificationCodeForm.inc.php