Inheritance diagram for SubmissionFileManager:

Public Member Functions
	__construct ($contextId, $submissionId)

	_getFile ($fileId, $revision=null)

	_handleCopy ($filePath, $fileStage, $copyUserId, $revisedFileId=null, $genreId=null, $assocType=null, $assocId=null)

	_handleUpload ($fileName, $fileStage, $uploaderUserId, $revisedFileId=null, $genreId=null, $assocType=null, $assocId=null)

	_instantiateSubmissionFile ($sourceFilePath, $fileStage, $revisedFileId=null, $genreId=null, $assocType=null, $assocId=null)

	copyFileToFileStage ($sourceFileId, $sourceRevision, $newFileStage, $destFileId=null, $viewable=false)

	copySubmissionFile ($filePath, $fileStage, $copyUserId, $revisedFileId=null, $genreId=null, $assocType=null, $assocId=null)

	deleteById ($fileId, $revision=null)

	downloadById ($fileId, $revision=null, $inline=false, $filename=null)

	recordView ($submissionFile)

	uploadSubmissionFile ($fileName, $fileStage, $uploaderUserId, $revisedFileId=null, $genreId=null, $assocType=null, $assocId=null)

Public Member Functions inherited from BaseSubmissionFileManager
	getBasePath ()

	getSubmissionId ()

Public Member Functions inherited from ContextFileManager
	__construct ($contextId)

Public Member Functions inherited from PrivateFileManager
	__construct ()

Public Member Functions inherited from FileManager
	compressFile ($filePath)

	copyDir ($source, $dest)

	copyFile ($source, $dest)

	decompressFile ($filePath)

	deleteByPath ($filePath)

	downloadByPath ($filePath, $mediaType=null, $inline=false, $fileName=null)

	fileExists ($filePath, $type='file')

	getDocumentExtension ($type)

	getDocumentType ($type)

	getExtension ($fileName)

	getFirstUploadedPostName ()

	getImageExtension ($type)

	getNiceFileSize ($size)

	getUploadedFileName ($fileName)

	getUploadedFilePath ($fileName)

	getUploadedFileType ($fileName)

	getUploadErrorCode ($fileName)

	mkdir ($dirPath, $perms=null)

	mkdirtree ($dirPath, $perms=null)

	parseFileExtension ($fileName)

	readFileFromPath ($filePath, $output=false)

	rmdir ($dirPath)

	rmtree ($file)

	setMode ($path, $mask)

	truncateFileName ($fileName, $length=127)

	uploadedFileExists ($fileName)

	uploadError ($fileName)

	uploadFile ($fileName, $destFileName)

	writeFile ($dest, &$contents)

Additional Inherited Members
Data Fields inherited from BaseSubmissionFileManager
	$_submissionId

Data Fields inherited from ContextFileManager
	$contextId

Data Fields inherited from PrivateFileManager
	$filesDir

Detailed Description

Helper class for database-backed submission file management tasks.

Submission directory structure: [submission id]/note [submission id]/public [submission id]/submission [submission id]/submission/original [submission id]/submission/review [submission id]/submission/review/attachment [submission id]/submission/editor [submission id]/submission/copyedit [submission id]/submission/layout [submission id]/attachment

Definition at line 30 of file SubmissionFileManager.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubmissionFileManager::__construct	(	$contextId,
		$submissionId
	)

Constructor.

Parameters

$contextId	int
$submissionId	int

Reimplemented from BaseSubmissionFileManager.

Definition at line 36 of file SubmissionFileManager.inc.php.

References ContextFileManager\$contextId.

Member Function Documentation

◆ _getFile()

SubmissionFileManager::_getFile	(	$fileId,
		$revision = `null`
	)

Internal helper method to retrieve file information by file ID.

Parameters

$fileId	integer
$revision	integer

Returns: SubmissionFile

Definition at line 388 of file SubmissionFileManager.inc.php.

References DAORegistry\getDAO().

Referenced by deleteById(), and downloadById().

◆ _handleCopy()

SubmissionFileManager::_handleCopy	(	$filePath,
		$fileStage,
		$copyUserId,
		$revisedFileId = `null`,
		$genreId = `null`,
		$assocType = `null`,
		$assocId = `null`
	)

Copy a file and add it to the database.

Parameters

$filePath	string full path to file on the file system
$fileStage	int submission file stage (one of the SUBMISSION_FILE_* constants)
$copyUserId	int The id of the user that is copying the file.
$revisedFileId	int ID of an existing file to revise
$genreId	int foreign key into genres table (e.g. manuscript, etc.)
$assocType	int
$assocId	int

Returns: SubmissionFile the submission file or null if an error occured.

Definition at line 245 of file SubmissionFileManager.inc.php.

References _instantiateSubmissionFile(), FileManager\fileExists(), DAORegistry\getDAO(), PKPString\mime_content_type(), and FileManager\truncateFileName().

Referenced by copySubmissionFile().

◆ _handleUpload()

SubmissionFileManager::_handleUpload	(	$fileName,
		$fileStage,
		$uploaderUserId,
		$revisedFileId = `null`,
		$genreId = `null`,
		$assocType = `null`,
		$assocId = `null`
	)

Upload the file and add it to the database.

Parameters

$fileName	string index into the $_FILES array
$fileStage	int submission file stage (one of the SUBMISSION_FILE_* constants)
$uploaderUserId	int The id of the user that uploaded the file.
$revisedFileId	int ID of an existing file to revise
$genreId	int foreign key into genres table (e.g. manuscript, etc.)
$assocType	int
$assocId	int

Returns: SubmissionFile the uploaded submission file or null if an error occured.

Definition at line 202 of file SubmissionFileManager.inc.php.

References _instantiateSubmissionFile(), DAORegistry\getDAO(), FileManager\getUploadedFileName(), FileManager\getUploadedFilePath(), FileManager\getUploadedFileType(), FileManager\truncateFileName(), and FileManager\uploadedFileExists().

Referenced by uploadSubmissionFile().

◆ _instantiateSubmissionFile()

SubmissionFileManager::_instantiateSubmissionFile	(	$sourceFilePath,
		$fileStage,
		$revisedFileId = `null`,
		$genreId = `null`,
		$assocType = `null`,
		$assocId = `null`
	)

Routine to instantiate and pre-populate a new submission file.

Parameters

$sourceFilePath	string
$fileStage	integer SUBMISSION_FILE_...
$revisedFileId	integer optional
$genreId	integer optional
$assocId	integer optional
$assocType	integer optional

Returns: SubmissionFile returns the instantiated submission file or null if an error occurs.

Definition at line 283 of file SubmissionFileManager.inc.php.

References fatalError(), Core\getCurrentDate(), DAORegistry\getDAO(), and BaseSubmissionFileManager\getSubmissionId().

Referenced by _handleCopy(), and _handleUpload().

◆ copyFileToFileStage()

SubmissionFileManager::copyFileToFileStage	(	$sourceFileId,
		$sourceRevision,
		$newFileStage,
		$destFileId = `null`,
		$viewable = `false`
	)

Copies an existing SubmissionFile and renames it.

Parameters

$sourceFileId	int
$sourceRevision	int
$fileStage	int
$destFileId	int (optional)
$viewable	boolean (optional)

Returns: array? array(file_id, revision) on success; null on failure

Definition at line 147 of file SubmissionFileManager.inc.php.

References HookRegistry\call(), Core\getCurrentDate(), and DAORegistry\getDAO().

◆ copySubmissionFile()

SubmissionFileManager::copySubmissionFile	(	$filePath,
		$fileStage,
		$copyUserId,
		$revisedFileId = `null`,
		$genreId = `null`,
		$assocType = `null`,
		$assocId = `null`
	)

Copy a submission file.

Parameters

$filePath	string the path of the file on the file system
$fileStage	int submission file workflow stage
$copyUserId	int The id of the user that originates the file copy
$revisedFileId	int
$genreId	int (e.g. Manuscript, Appendix, etc.)

Returns: SubmissionFile

Definition at line 70 of file SubmissionFileManager.inc.php.

References _handleCopy().

◆ deleteById()

SubmissionFileManager::deleteById	(	$fileId,
		$revision = `null`
	)

Delete a file.

Parameters

$fileId	integer
$revisionId	integer

Returns: boolean returns true if successful

Definition at line 84 of file SubmissionFileManager.inc.php.

References _getFile().

◆ downloadById()

SubmissionFileManager::downloadById	(	$fileId,
		$revision = `null`,
		$inline = `false`,
		$filename = `null`
	)

Download a file.

Parameters

$fileId	int the file id of the file to download
$revision	int the revision of the file to download
$inline	boolean print file as inline instead of attachment, optional
$filename	string The client-side download filename (optional)

Returns: boolean

Definition at line 101 of file SubmissionFileManager.inc.php.

References _getFile(), fatalError(), and recordView().

◆ recordView()

SubmissionFileManager::recordView ( $submissionFile )

Record a file view in database.

Parameters

$submissionFile SubmissionFile

Definition at line 124 of file SubmissionFileManager.inc.php.

References DAORegistry\getDAO(), and SessionManager\getManager().

Referenced by downloadById().

◆ uploadSubmissionFile()

SubmissionFileManager::uploadSubmissionFile	(	$fileName,
		$fileStage,
		$uploaderUserId,
		$revisedFileId = `null`,
		$genreId = `null`,
		$assocType = `null`,
		$assocId = `null`
	)

Upload a submission file.

Parameters

$fileName	string the name of the file used in the POST form
$fileStage	int submission file workflow stage
$uploaderUserId	int The id of the user that uploaded the file.
$revisedFileId	int
$genreId	int (e.g. Manuscript, Appendix, etc.)