Open Monograph Press: PublicationFormatMetadataForm Class Reference

Open Monograph Press 3.3.0

Inheritance diagram for PublicationFormatMetadataForm:

Public Member Functions
	__construct ($submission, $publication, $representation, $isPhysicalFormat=true, $remoteURL=null, $stageId=null, $formParams=null)

	_getPubIdPluginHelper ()

	execute (... $functionArgs)

	fetch ($request, $template=null, $display=false)

	getFormParams ()

	getPhysicalFormat ()

	getPublication ()

	getPublicationFormat ()

	getRemoteURL ()

	getStageId ()

	getSubmission ()

	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
	$_formParams

	$_isPhysicalFormat

	$_pubIdPluginHelper

	$_publication

	$_publicationFormat

	$_remoteURL

	$_stageId

	$_submission

Data Fields inherited from Form
	$_checks

	$_data

	$_errors

	$_template

	$cssValidation

	$defaultLocale

	$errorFields

	$errorsArray

	$formSectionErrors

	$requiredLocale

	$supportedLocales

Detailed Description

Form to edit a publication format's metadata.

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

Constructor & Destructor Documentation

◆ __construct()

PublicationFormatMetadataForm::__construct	(		$submission,
			$publication,
			$representation,
			$isPhysicalFormat = `true`,
			$remoteURL = `null`,
			$stageId = `null`,
			$formParams = `null`
	)

Constructor.

Parameters

$submission	Submission
$publication	Publication
$representation	Representation
$isPhysicalFormat	integer
$remoteURL	string
$stageId	integer
$formParams	array

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

References Form\addCheck().

Member Function Documentation

◆ _getPubIdPluginHelper()

PublicationFormatMetadataForm::_getPubIdPluginHelper ( )

returns the PKPPubIdPluginHelper associated with this form.

Returns: PKPPubIdPluginHelper

Definition at line 351 of file PublicationFormatMetadataForm.inc.php.

References $_pubIdPluginHelper.

Referenced by execute(), initData(), readInputData(), and validate().

◆ execute()

PublicationFormatMetadataForm::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 255 of file PublicationFormatMetadataForm.inc.php.

References _getPubIdPluginHelper(), DAORegistry\getDAO(), Form\getData(), getPublicationFormat(), and getSubmission().

◆ fetch()

PublicationFormatMetadataForm::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 106 of file PublicationFormatMetadataForm.inc.php.

References DAORegistry\getDAO(), getFormParams(), PKPTemplateManager\getManager(), Application\getPaymentManager(), getPhysicalFormat(), getPublication(), getPublicationFormat(), getRemoteURL(), getStageId(), getSubmission(), and PluginRegistry\loadCategory().

◆ getFormParams()

PublicationFormatMetadataForm::getFormParams ( )

Get the extra form parameters.

Definition at line 343 of file PublicationFormatMetadataForm.inc.php.

References $_formParams.

Referenced by fetch().

◆ getPhysicalFormat()

PublicationFormatMetadataForm::getPhysicalFormat ( )

Get physical format setting

Returns: bool

Definition at line 320 of file PublicationFormatMetadataForm.inc.php.

References $_isPhysicalFormat.

Referenced by fetch().

◆ getPublication()

PublicationFormatMetadataForm::getPublication ( )

Get the Publication

Returns: Publication

Definition at line 304 of file PublicationFormatMetadataForm.inc.php.

References $_publication.

Referenced by fetch().

◆ getPublicationFormat()

PublicationFormatMetadataForm::getPublicationFormat ( )

Get the publication format

Returns: PublicationFormat

Definition at line 336 of file PublicationFormatMetadataForm.inc.php.

References $_publicationFormat.

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

◆ getRemoteURL()

PublicationFormatMetadataForm::getRemoteURL ( )

Get the remote URL

Returns: string

Definition at line 328 of file PublicationFormatMetadataForm.inc.php.

References $_remoteURL.

Referenced by fetch().

◆ getStageId()

PublicationFormatMetadataForm::getStageId ( )

Get the stage id

Returns: int

Definition at line 312 of file PublicationFormatMetadataForm.inc.php.

References $_stageId.

Referenced by fetch().

◆ getSubmission()

PublicationFormatMetadataForm::getSubmission ( )

Get the Submission

Returns: Submission

Definition at line 296 of file PublicationFormatMetadataForm.inc.php.

References $_submission.

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

◆ initData()

PublicationFormatMetadataForm::initData ( )

Initialize form data for an instance of this form.

Reimplemented from Form.

Definition at line 166 of file PublicationFormatMetadataForm.inc.php.

References _getPubIdPluginHelper(), getPublicationFormat(), getSubmission(), and AppLocale\requireComponents().

◆ readInputData()

PublicationFormatMetadataForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 210 of file PublicationFormatMetadataForm.inc.php.

References _getPubIdPluginHelper(), getSubmission(), and Form\readUserVars().

◆ validate()

PublicationFormatMetadataForm::validate ( $callHooks = true )

Validate form data.

Parameters

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

Reimplemented from Form.

Definition at line 244 of file PublicationFormatMetadataForm.inc.php.

References _getPubIdPluginHelper(), getPublicationFormat(), and getSubmission().

Field Documentation

◆ $_formParams

array PublicationFormatMetadataForm::$_formParams

Parameters to configure the form template

Definition at line 67 of file PublicationFormatMetadataForm.inc.php.

Referenced by getFormParams().

◆ $_isPhysicalFormat

boolean PublicationFormatMetadataForm::$_isPhysicalFormat

is this a physical, non-digital format?

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

Referenced by getPhysicalFormat().

◆ $_pubIdPluginHelper

PKPPubIdPluginHelper PublicationFormatMetadataForm::$_pubIdPluginHelper

The pub id plugin helper

Definition at line 49 of file PublicationFormatMetadataForm.inc.php.

Referenced by _getPubIdPluginHelper().

◆ $_publication

Publication PublicationFormatMetadataForm::$_publication

The publication this publication format is related to

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

Referenced by getPublication().

◆ $_publicationFormat

PublicationFormat PublicationFormatMetadataForm::$_publicationFormat

The publication format

Definition at line 43 of file PublicationFormatMetadataForm.inc.php.

Referenced by getPublicationFormat().

◆ $_remoteURL

string PublicationFormatMetadataForm::$_remoteURL

a remote URL to retrieve the contents in this format

Definition at line 61 of file PublicationFormatMetadataForm.inc.php.

Referenced by getRemoteURL().

◆ $_stageId

int PublicationFormatMetadataForm::$_stageId

The current stage id

Definition at line 37 of file PublicationFormatMetadataForm.inc.php.

Referenced by getStageId().

◆ $_submission

Submission PublicationFormatMetadataForm::$_submission

The submission this publication format is related to

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

Referenced by getSubmission().

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

PublicationFormatMetadataForm.inc.php

PublicationFormatMetadataForm
Generated on Fri Aug 28 2020 14:54:09 for Open Monograph Press by 1.8.17