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

Public Member Functions

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

Protected Member Functions

 _getDepositableDepositPoints ($context)
 

Protected Attributes

 $_context = null
 
 $_plugin = null
 
 $_submission = null
 

Additional Inherited Members

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

Detailed Description

Form to perform an author's SWORD deposit(s)

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

Constructor & Destructor Documentation

◆ __construct()

AuthorDepositForm::__construct ( SwordPlugin  $plugin,
Context  $context,
Submission  $submission 
)

Constructor

Parameters
$pluginSwordPlugin
$contextContext
$submissionSubmission

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

References Plugin\getTemplateResource(), and PKPLocale\requireComponents().

Member Function Documentation

◆ _getDepositableDepositPoints()

AuthorDepositForm::_getDepositableDepositPoints (   $context)
protected

Build a list of collections available for deposit points of type SWORD_DEPOSIT_TYPE_OPTIONAL_SELECTION

Parameters
$contextContext
Returns
array

Definition at line 176 of file AuthorDepositForm.inc.php.

References DAORegistry\getDAO(), getSwordPlugin(), and DepositPointsHelper\loadCollectionsFromServer().

Referenced by display(), and execute().

◆ display()

AuthorDepositForm::display ( )

Display the form.

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.

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

References _getDepositableDepositPoints(), PKPTemplateManager\getManager(), PKPApplication\getRequest(), and getSwordPlugin().

◆ execute()

AuthorDepositForm::execute (   $request)

Save form.

Parameters
$requestPKPRequest

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

References _getDepositableDepositPoints(), Form\getData(), and getSwordPlugin().

◆ getSwordPlugin()

AuthorDepositForm::getSwordPlugin ( )

Get reference to the sword plugin

Returns
SwordPlugin

Definition at line 53 of file AuthorDepositForm.inc.php.

References $_plugin.

Referenced by _getDepositableDepositPoints(), display(), and execute().

◆ readInputData()

AuthorDepositForm::readInputData ( )

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

Reimplemented from Form.

Definition at line 60 of file AuthorDepositForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $_context

$_context AuthorDepositForm::$_context = null
protected

Context

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

◆ $_plugin

$_plugin AuthorDepositForm::$_plugin = null
protected

SwordPlugin

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

Referenced by getSwordPlugin().

◆ $_submission

$_submission AuthorDepositForm::$_submission = null
protected

Submission

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


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