Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
DOIExportSettingsForm Class Reference
Inheritance diagram for DOIExportSettingsForm:
Form DataciteSettingsForm MedraSettingsForm

Public Member Functions

 DOIExportSettingsForm (&$plugin, $journalId)
 
 execute ()
 
 getData ($key)
 
 getFormFields ()
 
 getJournalId ()
 
getPlugIn ()
 
 getSetting ($settingName)
 
 initData ()
 
 isOptional ($settingName)
 
 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)
 

Additional Inherited Members

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

Detailed Description

Form base class for journal managers to setup DOI export plug-ins.

...

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

Member Function Documentation

DOIExportSettingsForm::DOIExportSettingsForm ( $plugin,
  $journalId 
)

Constructor

Parameters
$pluginDoiExportPlugin
$journalIdinteger

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

References Form\addCheck().

DOIExportSettingsForm::execute ( )
DOIExportSettingsForm::getData (   $key)
See Also
Form::getData()

Definition at line 72 of file DOIExportSettingsForm.inc.php.

Referenced by execute().

DOIExportSettingsForm::getFormFields ( )

Return a list of form fields.

Returns
array

Definition at line 122 of file DOIExportSettingsForm.inc.php.

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

DOIExportSettingsForm::getJournalId ( )

Get the journal ID.

Returns
integer

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

Referenced by execute(), and getSetting().

& DOIExportSettingsForm::getPlugIn ( )

Get the plugin.

Returns
DoiExportPlugin

Definition at line 42 of file DOIExportSettingsForm.inc.php.

Referenced by execute(), and getSetting().

DOIExportSettingsForm::getSetting (   $settingName)

Get a plugin setting.

Parameters
$settingName
Returns
mixed The setting value.

Definition at line 112 of file DOIExportSettingsForm.inc.php.

References getJournalId(), and getPlugIn().

Referenced by initData().

DOIExportSettingsForm::initData ( )
See Also
Form::initData()

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

References getFormFields(), getSetting(), and Form\setData().

DOIExportSettingsForm::isOptional (   $settingName)

Check whether a given setting is optional.

Parameters
$settingNamestring
Returns
boolean

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

DOIExportSettingsForm::readInputData ( )
See Also
Form::readInputData()

Definition at line 89 of file DOIExportSettingsForm.inc.php.

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


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