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

Public Member Functions

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

Protected Attributes

 $_contextId
 
 $_depositPointId
 
 $_plugin
 
 $selectedType = null
 

Additional Inherited Members

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

Detailed Description

Form to create and modify deposit points.

Definition at line 16 of file SwordDepositPointForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SwordDepositPointForm::__construct ( SwordPlugin  $swordPlugin,
  $contextId,
  $depositPointId = null 
)

Constructor

Parameters
$swordPluginSwordPlugin SWORD plugin
$contextIdint Context ID
$depositPointIdint Deposit Point (if any)

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

References Form\addCheck(), Form\getData(), and Plugin\getTemplateResource().

Member Function Documentation

◆ execute()

SwordDepositPointForm::execute ( )

Save form.

Definition at line 119 of file SwordDepositPointForm.inc.php.

References $_plugin, DAORegistry\getDAO(), and Form\getData().

◆ fetch()

SwordDepositPointForm::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 105 of file SwordDepositPointForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

SwordDepositPointForm::initData ( )

Initialize form data.

Reimplemented from Form.

Definition at line 71 of file SwordDepositPointForm.inc.php.

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

◆ readInputData()

SwordDepositPointForm::readInputData (   $request)

Assign form data to user-submitted data.

Parameters
$requestPKPRequest

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

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

Field Documentation

◆ $_contextId

int SwordDepositPointForm::$_contextId
protected

Context ID

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

◆ $_depositPointId

int SwordDepositPointForm::$_depositPointId
protected

depositPoint ID

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

◆ $_plugin

SwordPlugin SwordDepositPointForm::$_plugin
protected

SWORD plugin

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

Referenced by execute().

◆ $selectedType

int SwordDepositPointForm::$selectedType = null
protected

Selected deposit point type

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


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