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

Public Member Functions

 _getPubIdPluginHelper ()
 
 CatalogEntryFormatMetadataForm ($monographId, $publicationFormatId, $isPhysicalFormat=true, $stageId=null, $formParams=null)
 
 execute ($request)
 
 fetch ($request)
 
 getFormParams ()
 
getMonograph ()
 
 getPhysicalFormat ()
 
 getPublicationFormatId ()
 
 getStageId ()
 
 initData ()
 
 readInputData ()
 
- 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)
 

Public Attributes

 $_formParams
 
 $_isPhysicalFormat
 
 $_monograph
 
 $_publicationFormatId
 
 $_stageId
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Parent class for forms used by the various publication formats.

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

Member Function Documentation

CatalogEntryFormatMetadataForm::_getPubIdPluginHelper ( )

returns the PubIdPluginHelper associated with this form.

Returns
PubIdPluginHelper

Definition at line 310 of file CatalogEntryFormatMetadataForm.inc.php.

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

CatalogEntryFormatMetadataForm::CatalogEntryFormatMetadataForm (   $monographId,
  $publicationFormatId,
  $isPhysicalFormat = true,
  $stageId = null,
  $formParams = null 
)

Constructor.

Parameters
$monographMonograph
$publicationFormatinteger
$isPhysicalFormatinteger
$stageIdinteger
$formParamsarray

Definition at line 46 of file CatalogEntryFormatMetadataForm.inc.php.

References Form\addCheck(), and DAORegistry\getDAO().

CatalogEntryFormatMetadataForm::execute (   $request)

Save the metadata and store the catalog data for this specific publication format.

Definition at line 206 of file CatalogEntryFormatMetadataForm.inc.php.

References _getPubIdPluginHelper(), DAORegistry\getDAO(), Form\getData(), getMonograph(), getPublicationFormatId(), and SubmissionLog\logEvent().

CatalogEntryFormatMetadataForm::fetch (   $request)

Fetch the HTML contents of the form.

Parameters
$requestPKPRequest return string

Definition at line 69 of file CatalogEntryFormatMetadataForm.inc.php.

References DAORegistry\getDAO(), getFormParams(), getMonograph(), getPhysicalFormat(), getPublicationFormatId(), getStageId(), and PluginRegistry\loadCategory().

CatalogEntryFormatMetadataForm::getFormParams ( )

Get the extra form parameters.

Definition at line 302 of file CatalogEntryFormatMetadataForm.inc.php.

References $_formParams.

Referenced by fetch().

& CatalogEntryFormatMetadataForm::getMonograph ( )

Get the Monograph

Returns
Monograph

Definition at line 271 of file CatalogEntryFormatMetadataForm.inc.php.

References $_monograph.

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

CatalogEntryFormatMetadataForm::getPhysicalFormat ( )

Get physical format setting

Returns
bool

Definition at line 287 of file CatalogEntryFormatMetadataForm.inc.php.

References $_isPhysicalFormat.

Referenced by fetch().

CatalogEntryFormatMetadataForm::getPublicationFormatId ( )

Get the publication format id

Returns
int

Definition at line 295 of file CatalogEntryFormatMetadataForm.inc.php.

References $_publicationFormatId.

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

CatalogEntryFormatMetadataForm::getStageId ( )

Get the stage id

Returns
int

Definition at line 279 of file CatalogEntryFormatMetadataForm.inc.php.

References $_stageId.

Referenced by fetch().

CatalogEntryFormatMetadataForm::initData ( )
CatalogEntryFormatMetadataForm::readInputData ( )

Assign form data to user-submitted data.

Definition at line 173 of file CatalogEntryFormatMetadataForm.inc.php.

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

Member Data Documentation

CatalogEntryFormatMetadataForm::$_formParams

Parameters to configure the form template.

Definition at line 36 of file CatalogEntryFormatMetadataForm.inc.php.

Referenced by getFormParams().

CatalogEntryFormatMetadataForm::$_isPhysicalFormat

is this a physical, non-digital format?

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

Referenced by getPhysicalFormat().

CatalogEntryFormatMetadataForm::$_monograph

The monograph used to show metadata information

Definition at line 22 of file CatalogEntryFormatMetadataForm.inc.php.

Referenced by getMonograph().

CatalogEntryFormatMetadataForm::$_publicationFormatId

The publication format id

Definition at line 28 of file CatalogEntryFormatMetadataForm.inc.php.

Referenced by getPublicationFormatId().

CatalogEntryFormatMetadataForm::$_stageId

The current stage id

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

Referenced by getStageId().


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