Open Journal Systems  3.3.0
QuickSubmitPlugin Class Reference
Inheritance diagram for QuickSubmitPlugin:
ImportExportPlugin Plugin

Public Member Functions

 display ($args, $request)
 
 executeCLI ($scriptName, &$args)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 register ($category, $path, $mainContextId=NULL)
 
 smartyPluginUrl ($params, $smarty)
 
 usage ($scriptName)
 
- Public Member Functions inherited from ImportExportPlugin
 displayXMLValidationErrors ($errors, $xml)
 
 getActions ($request, $actionArgs)
 
 getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')
 
 getExportPath ()
 
 getPluginSettingsPrefix ()
 
 isAllowedMethod ($url)
 
 isRelativePath ($url)
 
 pluginUrl ($params, $smarty)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCanDisable ()
 
 getCanEnable ()
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Protected Member Functions

 _cancelSubmit ($request)
 
 _deleteUploadedImage ($request)
 
 _reloadForm ($request)
 
 _saveSubmit ($request)
 
 _saveUploadedImage ($request)
 
 _showFileUploadForm ($request)
 
 _uploadImage ($request)
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Additional Inherited Members

- Data Fields inherited from ImportExportPlugin
 $_request
 
- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Quick Submit one-page submission plugin.

Definition at line 19 of file QuickSubmitPlugin.inc.php.

Member Function Documentation

◆ _cancelSubmit()

QuickSubmitPlugin::_cancelSubmit (   $request)
protected

Cancels the submission

Parameters
$requestRequest

Definition at line 100 of file QuickSubmitPlugin.inc.php.

References Plugin\$request, PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

Referenced by display().

◆ _deleteUploadedImage()

QuickSubmitPlugin::_deleteUploadedImage (   $request)
protected

Delete the uploaded image

Parameters
$requestRequest.
Returns
JSONMessage JSON object

Definition at line 171 of file QuickSubmitPlugin.inc.php.

References Plugin\$request.

Referenced by display().

◆ _reloadForm()

QuickSubmitPlugin::_reloadForm (   $request)
protected

Reloads the form

Parameters
$requestRequest.

Definition at line 204 of file QuickSubmitPlugin.inc.php.

References Plugin\$request, and PKPTemplateManager\getManager().

Referenced by display().

◆ _saveSubmit()

QuickSubmitPlugin::_saveSubmit (   $request)
protected

Save the submitted form

Parameters
$requestRequest.

Definition at line 182 of file QuickSubmitPlugin.inc.php.

References Plugin\$request, PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

Referenced by display().

◆ _saveUploadedImage()

QuickSubmitPlugin::_saveUploadedImage (   $request)
protected

Save the new image file.

Parameters
$requestRequest.
Returns
JSONMessage JSON object

Definition at line 159 of file QuickSubmitPlugin.inc.php.

References Plugin\$request.

Referenced by display().

◆ _showFileUploadForm()

QuickSubmitPlugin::_showFileUploadForm (   $request)
protected

Show the upload image form.

Parameters
$requestRequest
Returns
JSONMessage JSON object

Definition at line 125 of file QuickSubmitPlugin.inc.php.

References Plugin\$request.

Referenced by display().

◆ _uploadImage()

QuickSubmitPlugin::_uploadImage (   $request)
protected

Upload the image to a temporary file

Parameters
$requestRequest
Returns
JSONMessage JSON object

Definition at line 137 of file QuickSubmitPlugin.inc.php.

References Plugin\$request.

Referenced by display().

◆ display()

QuickSubmitPlugin::display (   $args,
  $request 
)

◆ executeCLI()

QuickSubmitPlugin::executeCLI (   $scriptName,
$args 
)

Reimplemented from ImportExportPlugin.

Definition at line 242 of file QuickSubmitPlugin.inc.php.

References fatalError().

◆ getDescription()

QuickSubmitPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

Definition at line 54 of file QuickSubmitPlugin.inc.php.

◆ getDisplayName()

QuickSubmitPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

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

Referenced by display().

◆ getName()

QuickSubmitPlugin::getName ( )

Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns
string name of plugin

Reimplemented from Plugin.

Definition at line 40 of file QuickSubmitPlugin.inc.php.

Referenced by smartyPluginUrl().

◆ register()

QuickSubmitPlugin::register (   $category,
  $path,
  $mainContextId = NULL 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from Plugin.

Definition at line 24 of file QuickSubmitPlugin.inc.php.

References Plugin\addLocaleData(), and AppLocale\requireComponents().

◆ smartyPluginUrl()

QuickSubmitPlugin::smartyPluginUrl (   $params,
  $smarty 
)

Extend the {url ...} for smarty to support this plugin.

Reimplemented from Plugin.

Definition at line 215 of file QuickSubmitPlugin.inc.php.

References getName().

◆ usage()

QuickSubmitPlugin::usage (   $scriptName)

Reimplemented from ImportExportPlugin.

Definition at line 235 of file QuickSubmitPlugin.inc.php.

References fatalError().


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