UploadImageForm Class Reference

Inheritance diagram for UploadImageForm:

Public Member Functions
	__construct ($plugin, $request)
	deleteCoverImage ($request)
	execute ($request)
	fetch ($request, $template=null, $display=false, $params=null)
	fetchTemporaryFile ($request)
	getFileSettingName ()
	getLocaleFieldNames ()
	initData ()
	readInputData ()
	removeTemporaryFile ($request)
	setFileSettingName ($fileSettingName)
	uploadFile ($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 ()
	getRequiredLocale ()
	getTemplate ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_fileSettingName
	$context
	$plugin
	$publication
	$request
	$submission
	$submissionId
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for upload an image.

Definition at line 18 of file UploadImageForm.inc.php.

Constructor & Destructor Documentation

__construct()

UploadImageForm::__construct	(		$plugin,
			$request
	)

Constructor.

Parameters

$plugin	object
$request	object

Definition at line 63 of file UploadImageForm.inc.php.

References $plugin, $request, Form\addCheck(), and DAORegistry\getDAO().

Member Function Documentation

deleteCoverImage()

UploadImageForm::deleteCoverImage

(

$request

)

An action to delete an article cover image.

Parameters

$request

PKPRequest

Returns

JSONMessage JSON object

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

References $request, DAORegistry\getDAO(), and AppLocale\getLocale().

execute()

UploadImageForm::execute

(

$request

)

Save file image to Submission

Parameters

$request

Request.

Definition at line 163 of file UploadImageForm.inc.php.

References fetchTemporaryFile(), DAORegistry\getDAO(), Form\getData(), DAO\getDataChangedEvent(), AppLocale\getLocale(), and removeTemporaryFile().

fetch()

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

See also

Form::fetch()

Parameters

$params

template parameters

Definition at line 231 of file UploadImageForm.inc.php.

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

fetchTemporaryFile()

UploadImageForm::fetchTemporaryFile

(

$request

)

Fecth the temporary file.

Parameters

$request

Request

Returns

TemporaryFile

Definition at line 250 of file UploadImageForm.inc.php.

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

Referenced by execute().

getFileSettingName()

UploadImageForm::getFileSettingName

(

)

Get the image that this form will upload a file to.

Returns

string

Definition at line 211 of file UploadImageForm.inc.php.

References $_fileSettingName.

Referenced by fetch().

getLocaleFieldNames()

UploadImageForm::getLocaleFieldNames

(

)

Get the list of field names that need to support multiple locales

Returns

array

Reimplemented from Form.

Definition at line 85 of file UploadImageForm.inc.php.

initData()

UploadImageForm::initData

(

)

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 92 of file UploadImageForm.inc.php.

References AppLocale\getLocale(), PKPTemplateManager\getManager(), and Form\setData().

readInputData()

UploadImageForm::readInputData

(

)

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

Reimplemented from Form.

Definition at line 128 of file UploadImageForm.inc.php.

References Form\readUserVars().

removeTemporaryFile()

UploadImageForm::removeTemporaryFile

(

$request

)

Clean temporary file.

Parameters

$request

Request

Definition at line 265 of file UploadImageForm.inc.php.

References $request, and Form\getData().

Referenced by execute().

setFileSettingName()

UploadImageForm::setFileSettingName

(

$fileSettingName

)

Set the image that this form will upload a file to.

Parameters

$image

string

Definition at line 219 of file UploadImageForm.inc.php.

uploadFile()

UploadImageForm::uploadFile

(

$request

)

Upload a temporary file.

Parameters

$request

Request

Definition at line 277 of file UploadImageForm.inc.php.

References $request.

Field Documentation

$_fileSettingName

UploadImageForm::$_fileSettingName

string Setting key that will be associated with the uploaded file.

Definition at line 20 of file UploadImageForm.inc.php.

Referenced by getFileSettingName().

$context

$context UploadImageForm::$context

Journal

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

$plugin

$plugin UploadImageForm::$plugin

QuickSubmitPlugin

Definition at line 50 of file UploadImageForm.inc.php.

Referenced by __construct().

$publication

$publication UploadImageForm::$publication

Publication

Definition at line 44 of file UploadImageForm.inc.php.

$request

$request UploadImageForm::$request

object

Definition at line 26 of file UploadImageForm.inc.php.

Referenced by __construct(), deleteCoverImage(), fetch(), fetchTemporaryFile(), removeTemporaryFile(), and uploadFile().

$submission

$submission UploadImageForm::$submission

Submission

Definition at line 38 of file UploadImageForm.inc.php.

$submissionId

$submissionId UploadImageForm::$submissionId

int

Definition at line 32 of file UploadImageForm.inc.php.

---

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

• UploadImageForm.inc.php