Open Journal Systems  3.3.0
DataciteSettingsForm Class Reference
Inheritance diagram for DataciteSettingsForm:
Form

Public Member Functions

 __construct ($plugin, $contextId)
 
 _getContextId ()
 
 _getPlugin ()
 
 execute (... $functionArgs)
 
 getFormFields ()
 
 initData ()
 
 isOptional ($settingName)
 
 readInputData ()
 
- 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)
 
 fetch ($request, $template=null, $display=false)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $_contextId
 
 $_plugin
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for journal managers to setup the DataCite plugin.

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

Constructor & Destructor Documentation

◆ __construct()

DataciteSettingsForm::__construct (   $plugin,
  $contextId 
)

Constructor

Parameters
$pluginDataciteExportPlugin
$contextIdinteger

Definition at line 59 of file DataciteSettingsForm.inc.php.

References $application, Form\addCheck(), PKPApplication\get(), PluginRegistry\loadCategory(), and Form\setData().

Member Function Documentation

◆ _getContextId()

DataciteSettingsForm::_getContextId ( )

Get the context ID.

Returns
integer

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

References $_contextId.

Referenced by execute(), and initData().

◆ _getPlugin()

DataciteSettingsForm::_getPlugin ( )

Get the plugin.

Returns
DataciteExportPlugin

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

References $_plugin.

Referenced by execute(), and initData().

◆ execute()

DataciteSettingsForm::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 115 of file DataciteSettingsForm.inc.php.

References _getContextId(), _getPlugin(), Form\getData(), and getFormFields().

◆ getFormFields()

DataciteSettingsForm::getFormFields ( )

Get form fields

Returns
array (field name => field type)

Definition at line 132 of file DataciteSettingsForm.inc.php.

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

◆ initData()

DataciteSettingsForm::initData ( )

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 97 of file DataciteSettingsForm.inc.php.

References _getContextId(), _getPlugin(), getFormFields(), and Form\setData().

◆ isOptional()

DataciteSettingsForm::isOptional (   $settingName)

Is the form field optional

Parameters
$settingNamestring
Returns
boolean

Definition at line 146 of file DataciteSettingsForm.inc.php.

◆ readInputData()

DataciteSettingsForm::readInputData ( )

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

Reimplemented from Form.

Definition at line 108 of file DataciteSettingsForm.inc.php.

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

Field Documentation

◆ $_contextId

integer DataciteSettingsForm::$_contextId

Definition at line 27 of file DataciteSettingsForm.inc.php.

Referenced by _getContextId().

◆ $_plugin

DataciteExportPlugin DataciteSettingsForm::$_plugin

Definition at line 41 of file DataciteSettingsForm.inc.php.

Referenced by _getPlugin().


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