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

Public Member Functions

 __construct ($plugin, $journalId)
 
 execute (... $functionArgs)
 
 fetch ($request)
 
 initData ()
 
 readInputData ()
 
 validate ()
 
- 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)
 

Protected Attributes

 $_journalId
 
 $_plugin
 
 $_settings
 

Additional Inherited Members

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

Detailed Description

Form for Document Markup gateway plugin settings.

Definition at line 21 of file MarkupSettingsForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MarkupSettingsForm::__construct (   $plugin,
  $journalId 
)

Constructor

Parameters
$pluginmixed Plugin object
$journalIdint JournalId

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

Member Function Documentation

◆ execute()

MarkupSettingsForm::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 195 of file MarkupSettingsForm.inc.php.

References $_journalId, $_plugin, MarkupConversionHelper\canUseCredentialsFromConfig(), Form\getData(), Config\getVar(), and MarkupConversionHelper\readCredentialsFromConfig().

◆ fetch()

MarkupSettingsForm::fetch (   $request)
See also
Form::fetch()

Definition at line 177 of file MarkupSettingsForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

MarkupSettingsForm::initData ( )

Initialize plugin settings form

Returns
void

Reimplemented from Form.

Definition at line 70 of file MarkupSettingsForm.inc.php.

References $_journalId, $_plugin, MarkupConversionHelper\canUseCredentialsFromConfig(), Config\getVar(), MarkupConversionHelper\readCredentialsFromConfig(), and Form\setData().

◆ readInputData()

MarkupSettingsForm::readInputData ( )

Assign form data to user-submitted data

Returns
void

Reimplemented from Form.

Definition at line 129 of file MarkupSettingsForm.inc.php.

References Form\readUserVars().

◆ validate()

MarkupSettingsForm::validate ( )

Validate the form

Returns
bool Whether or not the form validated

Definition at line 148 of file MarkupSettingsForm.inc.php.

References Form\addCheck(), MarkupConversionHelper\canUseCredentialsFromConfig(), Form\getData(), Config\getVar(), and MarkupConversionHelper\readCredentialsFromConfig().

Field Documentation

◆ $_journalId

$journalId MarkupSettingsForm::$_journalId
protected

int

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

Referenced by execute(), and initData().

◆ $_plugin

$plugin MarkupSettingsForm::$_plugin
protected

object

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

Referenced by execute(), and initData().

◆ $_settings

$settings MarkupSettingsForm::$_settings
protected

array

Definition at line 39 of file MarkupSettingsForm.inc.php.


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