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

Public Member Functions

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

Data Fields

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

Detailed Description

Form to upload a plugin file.

Definition at line 22 of file UploadPluginForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

UploadPluginForm::__construct (   $function)

Constructor.

Parameters
$functionstring PLUGIN_ACTION_...

Definition at line 35 of file UploadPluginForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

UploadPluginForm::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 70 of file UploadPluginForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and PluginRegistry\getPlugin().

◆ fetch()

UploadPluginForm::fetch (   $request,
  $template = null,
  $display = false 
)

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

Reimplemented from Form.

Definition at line 56 of file UploadPluginForm.inc.php.

References PKPTemplateManager\getManager().

◆ readInputData()

UploadPluginForm::readInputData ( )

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

Reimplemented from Form.

Definition at line 49 of file UploadPluginForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $_function

String UploadPluginForm::$_function

PLUGIN_ACTION_...

Definition at line 28 of file UploadPluginForm.inc.php.


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