PKPAssignPublicIdentifiersForm Class Reference

Inheritance diagram for PKPAssignPublicIdentifiersForm:

Public Member Functions
	__construct ($template, $pubObject, $approval, $confirmationText)
	execute ($save=false,... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getApproval ()
	getConfirmationText ()
	getContextId ()
	getPubObject ()
	readInputData ()
Public Member Functions inherited from Form
	_decomposeArray ($name, $value, $stack)
	addCheck ($formValidator)
	addError ($field, $message)
	addErrorField ($field)
	addSupportedFormLocale ($supportedLocale)
	display ($request=null, $template=null)
	execute (... $functionArgs)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	initData ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_approval
	$_confirmationText
	$_contextId
	$_pubObject
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Displays the assign pub id form.

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

Constructor & Destructor Documentation

__construct()

PKPAssignPublicIdentifiersForm::__construct	(		$template,
			$pubObject,
			$approval,
			$confirmationText
	)

Constructor.

Parameters

$template	string Form template
$pubObject	object
$approval	boolean
$confirmationText	string

Reimplemented from Form.

Definition at line 57 of file PKPAssignPublicIdentifiersForm.inc.php.

References Form\addCheck(), and PKPApplication\get().

Member Function Documentation

execute()

PKPAssignPublicIdentifiersForm::execute	(		$save = false,
			$functionArgs
	)

Assign pub ids.

Parameters

$save

boolean true if the pub id shall be saved here false if this form is integrated somewhere else, where the pub object will be updated.

Definition at line 143 of file PKPAssignPublicIdentifiersForm.inc.php.

References getContextId(), and getPubObject().

fetch()

PKPAssignPublicIdentifiersForm::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.

Reimplemented in AssignPublicIdentifiersForm.

Definition at line 75 of file PKPAssignPublicIdentifiersForm.inc.php.

References getApproval(), getConfirmationText(), getContextId(), PKPTemplateManager\getManager(), getPubObject(), and PluginRegistry\loadCategory().

getApproval()

PKPAssignPublicIdentifiersForm::getApproval

(

)

Get weather it is an approval

Returns

boolean

Definition at line 109 of file PKPAssignPublicIdentifiersForm.inc.php.

References $_approval.

Referenced by fetch().

getConfirmationText()

PKPAssignPublicIdentifiersForm::getConfirmationText

(

)

Get the confirmation text.

Returns

string

Definition at line 125 of file PKPAssignPublicIdentifiersForm.inc.php.

References $_confirmationText.

Referenced by fetch().

getContextId()

PKPAssignPublicIdentifiersForm::getContextId

(

)

Get the context id

Returns

integer

Definition at line 117 of file PKPAssignPublicIdentifiersForm.inc.php.

References $_contextId.

Referenced by execute(), and fetch().

getPubObject()

PKPAssignPublicIdentifiersForm::getPubObject

(

)

Get the pub object

Returns

object

Definition at line 101 of file PKPAssignPublicIdentifiersForm.inc.php.

References $_pubObject.

Referenced by execute(), and fetch().

readInputData()

PKPAssignPublicIdentifiersForm::readInputData

(

)

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from Form.

Definition at line 132 of file PKPAssignPublicIdentifiersForm.inc.php.

Field Documentation

$_approval

boolean PKPAssignPublicIdentifiersForm::$_approval

Definition at line 40 of file PKPAssignPublicIdentifiersForm.inc.php.

Referenced by getApproval().

$_confirmationText

string PKPAssignPublicIdentifiersForm::$_confirmationText

Confirmation to display.

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

Referenced by getConfirmationText().

$_contextId

int PKPAssignPublicIdentifiersForm::$_contextId

The context id

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

Referenced by getContextId().

$_pubObject

object PKPAssignPublicIdentifiersForm::$_pubObject

The pub object, that are beeing approved, the pub ids can be considered for assignement there OJS Issue, Representation or SubmissionFile

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

Referenced by getPubObject().

---

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

• PKPAssignPublicIdentifiersForm.inc.php