PublicationFormatForm Class Reference

Inheritance diagram for PublicationFormatForm:

Public Member Functions
	__construct ($monograph, $publicationFormat, $publication)
	execute (... $functionParams)
	fetch ($request, $template=null, $display=false)
	getMonograph ()
	getPublication ()
	getPublicationFormat ()
	initData ()
	readInputData ()
	setMonograph ($monograph)
	setPublication ($publication)
	setPublicationFormat ($publicationFormat)
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
	$_publication = null
	$_publicationFormat
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a format.

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

Constructor & Destructor Documentation

__construct()

PublicationFormatForm::__construct	(		$monograph,
			$publicationFormat,
			$publication
	)

Constructor.

Definition at line 34 of file PublicationFormatForm.inc.php.

References Form\addCheck(), setMonograph(), setPublication(), and setPublicationFormat().

Member Function Documentation

execute()

PublicationFormatForm::execute

(

$functionParams

)

Save the assigned format

Returns

int Publication format ID

See also

Form::execute()

Reimplemented from Form.

Definition at line 160 of file PublicationFormatForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), getMonograph(), getPublication(), getPublicationFormat(), and SubmissionLog\logEvent().

fetch()

PublicationFormatForm::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 126 of file PublicationFormatForm.inc.php.

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

getMonograph()

PublicationFormatForm::getMonograph

(

)

Get the Monograph

Returns

Monograph

Definition at line 71 of file PublicationFormatForm.inc.php.

References $_monograph.

Referenced by execute(), and fetch().

getPublication()

PublicationFormatForm::getPublication

(

)

Get the Publication

Returns

Publication

Definition at line 88 of file PublicationFormatForm.inc.php.

References $_publication.

Referenced by execute(), and fetch().

getPublicationFormat()

PublicationFormatForm::getPublicationFormat

(

)

Get the format

Returns

PublicationFormat

Definition at line 55 of file PublicationFormatForm.inc.php.

References $_publicationFormat.

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

initData()

PublicationFormatForm::initData

(

)

Initialize form data from the associated publication format.

Reimplemented from Form.

Definition at line 107 of file PublicationFormatForm.inc.php.

References getPublicationFormat(), and Form\setData().

readInputData()

PublicationFormatForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 145 of file PublicationFormatForm.inc.php.

References Form\readUserVars().

setMonograph()

PublicationFormatForm::setMonograph

(

$monograph

)

Set the MonographId

Parameters

Monograph

Definition at line 79 of file PublicationFormatForm.inc.php.

Referenced by __construct().

setPublication()

PublicationFormatForm::setPublication

(

$publication

)

Set the PublicationId

Parameters

Publication

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

Referenced by __construct().

setPublicationFormat()

PublicationFormatForm::setPublicationFormat

(

$publicationFormat

)

Set the publication format

Parameters

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

Referenced by __construct().

Field Documentation

$_monograph

PublicationFormatForm::$_monograph

The monograph associated with the format being edited

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

Referenced by getMonograph().

$_publication

$_publication PublicationFormatForm::$_publication = null

Publication

Definition at line 29 of file PublicationFormatForm.inc.php.

Referenced by getPublication().

$_publicationFormat

PublicationFormatForm::$_publicationFormat

PublicationFormat the format being edited

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

Referenced by getPublicationFormat().

---

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

• PublicationFormatForm.inc.php