Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionFilesMetadataForm Class Reference
Inheritance diagram for SubmissionFilesMetadataForm:
Form SubmissionFilesArtworkMetadataForm

Public Member Functions

 execute ($args, $request)
 
 fetch ($request)
 
 getLocaleFieldNames ()
 
 getReviewRound ()
 
 getStageId ()
 
getSubmissionFile ()
 
 readInputData ()
 
 SubmissionFilesMetadataForm (&$submissionFile, $stageId, $reviewRound=null)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for editing a submission file's metadata.

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

Member Function Documentation

SubmissionFilesMetadataForm::execute (   $args,
  $request 
)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
$objectobject The object edited by this form.
Returns
$object The same object, potentially changed via hook.

Definition at line 131 of file SubmissionFilesMetadataForm.inc.php.

SubmissionFilesMetadataForm::fetch (   $request)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

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

SubmissionFilesMetadataForm::getLocaleFieldNames ( )

Get the list of field names that need to support multiple locales

Returns
array

Definition at line 95 of file SubmissionFilesMetadataForm.inc.php.

SubmissionFilesMetadataForm::getReviewRound ( )

Get review round.

Returns
ReviewRound

Definition at line 84 of file SubmissionFilesMetadataForm.inc.php.

SubmissionFilesMetadataForm::getStageId ( )

Get the workflow stage id.

Returns
integer

Definition at line 76 of file SubmissionFilesMetadataForm.inc.php.

& SubmissionFilesMetadataForm::getSubmissionFile ( )

Get the submission file.

Returns
SubmissionFile

Definition at line 68 of file SubmissionFilesMetadataForm.inc.php.

Referenced by SubmissionFilesArtworkMetadataForm\execute().

SubmissionFilesMetadataForm::readInputData ( )

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

Definition at line 102 of file SubmissionFilesMetadataForm.inc.php.

SubmissionFilesMetadataForm::SubmissionFilesMetadataForm ( $submissionFile,
  $stageId,
  $reviewRound = null 
)

Constructor.

Parameters
$submissionFileSubmissionFile
$stageIdinteger One of the WORKFLOW_STAGE_ID_* constants.
$reviewRoundReviewRound (optional) Current review round, if any.

Definition at line 45 of file SubmissionFilesMetadataForm.inc.php.


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