PKPPublicIdentifiersForm Class Reference

Inheritance diagram for PKPPublicIdentifiersForm:

Public Member Functions
	__construct ($pubObject, $stageId=null, $formParams=null)
	clearPubId ($pubIdPlugInClassName)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	getAssocType ($pubObject)
	getContextId ()
	getFormParams ()
	getPubObject ()
	getStageId ()
	initData ()
	readInputData ()
	validate ($callHooks=true)
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)

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

Detailed Description

Displays a pub ids form.

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

Constructor & Destructor Documentation

__construct()

PKPPublicIdentifiersForm::__construct	(		$pubObject,
			$stageId = null,
			$formParams = null
	)

Constructor.

Parameters

$template	string Form template path
$pubObject	object
$stageId	integer
$formParams	array

Reimplemented in PublicIdentifiersForm.

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

References Form\addCheck(), PKPApplication\get(), getContextId(), and AppLocale\requireComponents().

Member Function Documentation

clearPubId()

PKPPublicIdentifiersForm::clearPubId

(

$pubIdPlugInClassName

)

Clear pub id.

Parameters

$pubIdPlugInClassName

string

Definition at line 219 of file PKPPublicIdentifiersForm.inc.php.

References getContextId(), and getPubObject().

execute()

PKPPublicIdentifiersForm::execute

(

$functionArgs

)

Store objects with pub ids. 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.

Reimplemented in PublicIdentifiersForm.

Definition at line 197 of file PKPPublicIdentifiersForm.inc.php.

References getContextId(), DAORegistry\getDAO(), Form\getData(), getPubObject(), and Application\getRepresentationDAO().

fetch()

PKPPublicIdentifiersForm::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 PublicIdentifiersForm.

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

References PKPServices\get(), getContextId(), getFormParams(), PKPTemplateManager\getManager(), getPubObject(), getStageId(), and PluginRegistry\loadCategory().

getAssocType()

PKPPublicIdentifiersForm::getAssocType

(

$pubObject

)

Get assoc type of the given object.

Parameters

$pubObject

Returns

integer ASSOC_TYPE_

Reimplemented in PublicIdentifiersForm.

Definition at line 229 of file PKPPublicIdentifiersForm.inc.php.

Referenced by validate().

getContextId()

PKPPublicIdentifiersForm::getContextId

(

)

Get the context id

Returns

integer

Definition at line 136 of file PKPPublicIdentifiersForm.inc.php.

References $_contextId.

Referenced by __construct(), clearPubId(), execute(), fetch(), initData(), readInputData(), and validate().

getFormParams()

PKPPublicIdentifiersForm::getFormParams

(

)

Get the extra form parameters.

Returns

array

Definition at line 144 of file PKPPublicIdentifiersForm.inc.php.

References $_formParams.

Referenced by fetch().

getPubObject()

PKPPublicIdentifiersForm::getPubObject

(

)

Get the pub object

Returns

object

Definition at line 120 of file PKPPublicIdentifiersForm.inc.php.

References $_pubObject.

Referenced by clearPubId(), PublicIdentifiersForm\execute(), execute(), PublicIdentifiersForm\fetch(), fetch(), initData(), and validate().

getStageId()

PKPPublicIdentifiersForm::getStageId

(

)

Get the stage id

Returns

integer WORKFLOW_STAGE_ID_

Definition at line 128 of file PKPPublicIdentifiersForm.inc.php.

References $_stageId.

Referenced by fetch().

initData()

PKPPublicIdentifiersForm::initData

(

)

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 104 of file PKPPublicIdentifiersForm.inc.php.

References getContextId(), getPubObject(), and Form\setData().

readInputData()

PKPPublicIdentifiersForm::readInputData

(

)

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

Reimplemented from Form.

Definition at line 155 of file PKPPublicIdentifiersForm.inc.php.

References getContextId(), and Form\readUserVars().

validate()

PKPPublicIdentifiersForm::validate

(

$callHooks = true

)

Validate form data.

Parameters

$callHooks

boolean True (default) iff hooks are to be called.

Reimplemented from Form.

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

References Form\addError(), Form\addErrorField(), getAssocType(), Application\getContextDAO(), getContextId(), Form\getData(), and getPubObject().

Field Documentation

$_contextId

int PKPPublicIdentifiersForm::$_contextId

The context id

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

Referenced by getContextId().

$_formParams

array PKPPublicIdentifiersForm::$_formParams

Parameters to configure the form template.

Definition at line 47 of file PKPPublicIdentifiersForm.inc.php.

Referenced by getFormParams().

$_pubObject

object PKPPublicIdentifiersForm::$_pubObject

The pub object the identifiers are edited of Submission, Representation, SubmissionFile, OJS Issue and OMP Chapter

Definition at line 33 of file PKPPublicIdentifiersForm.inc.php.

Referenced by getPubObject().

$_stageId

int PKPPublicIdentifiersForm::$_stageId

The current stage id, WORKFLOW_STAGE_ID_

Definition at line 39 of file PKPPublicIdentifiersForm.inc.php.

Referenced by getStageId().

---

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

• PKPPublicIdentifiersForm.inc.php