RepresentativeForm Class Reference

Inheritance diagram for RepresentativeForm:

Public Member Functions
	__construct ($monograph, $representative)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getMonograph ()
&	getRepresentative ()
	initData ()
	readInputData ()
	setMonograph ($monograph)
	setRepresentative ($representative)
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
	$_monograph
	$_representative
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a representative entry.

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

Constructor & Destructor Documentation

__construct()

RepresentativeForm::__construct	(		$monograph,
			$representative
	)

Constructor.

Definition at line 28 of file RepresentativeForm.inc.php.

References Form\addCheck(), PKPApplication\get(), DAORegistry\getDAO(), setMonograph(), and setRepresentative().

Member Function Documentation

execute()

RepresentativeForm::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 164 of file RepresentativeForm.inc.php.

References fatalError(), DAORegistry\getDAO(), Form\getData(), getMonograph(), and getRepresentative().

fetch()

RepresentativeForm::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 112 of file RepresentativeForm.inc.php.

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), getMonograph(), and getRepresentative().

getMonograph()

RepresentativeForm::getMonograph

(

)

Get the Monograph

Returns

Monograph

Definition at line 72 of file RepresentativeForm.inc.php.

References $_monograph.

Referenced by execute(), and fetch().

getRepresentative()

& RepresentativeForm::getRepresentative

(

)

Get the representative

Returns

Representative

Definition at line 56 of file RepresentativeForm.inc.php.

References $_representative.

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

initData()

RepresentativeForm::initData

(

)

Initialize form data from the representative entry.

Reimplemented from Form.

Definition at line 91 of file RepresentativeForm.inc.php.

References getRepresentative().

readInputData()

RepresentativeForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 146 of file RepresentativeForm.inc.php.

References Form\readUserVars().

setMonograph()

RepresentativeForm::setMonograph

(

$monograph

)

Set the Monograph

Parameters

Monograph

Definition at line 80 of file RepresentativeForm.inc.php.

Referenced by __construct().

setRepresentative()

RepresentativeForm::setRepresentative

(

$representative

)

Set the representative

Parameters

Definition at line 64 of file RepresentativeForm.inc.php.

Referenced by __construct().

Field Documentation

$_monograph

RepresentativeForm::$_monograph

The monograph associated with the format being edited

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

Referenced by getMonograph().

$_representative

RepresentativeForm::$_representative

Representative the entry being edited

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

Referenced by getRepresentative().

---

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

• RepresentativeForm.inc.php