Open Journal Systems  3.3.0
BaseSubmissionFileManager Class Reference
Inheritance diagram for BaseSubmissionFileManager:
ContextFileManager PrivateFileManager FileManager SubmissionFileManager

Public Member Functions

 __construct ($contextId, $submissionId)
 
 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)
 

Data Fields

 $_submissionId
 
- Data Fields inherited from ContextFileManager
 $contextId
 
- Data Fields inherited from PrivateFileManager
 $filesDir
 

Detailed Description

Base helper class for 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 BaseSubmissionFileManager.inc.php.

Constructor & Destructor Documentation

◆ __construct()

BaseSubmissionFileManager::__construct (   $contextId,
  $submissionId 
)

Constructor.

Parameters
$contextIdint
$submissionIdint

Reimplemented in SubmissionFileManager.

Definition at line 42 of file BaseSubmissionFileManager.inc.php.

References ContextFileManager\$contextId.

Member Function Documentation

◆ getBasePath()

BaseSubmissionFileManager::getBasePath ( )

Get the base path for file storage.

Returns
string

Reimplemented from ContextFileManager.

Definition at line 55 of file BaseSubmissionFileManager.inc.php.

References Application\getFileDirectories().

◆ getSubmissionId()

BaseSubmissionFileManager::getSubmissionId ( )

Get the submission ID that this manager operates upon.

Returns
int

Definition at line 64 of file BaseSubmissionFileManager.inc.php.

References $_submissionId.

Referenced by SubmissionFileManager\_instantiateSubmissionFile().

Field Documentation

◆ $_submissionId

int BaseSubmissionFileManager::$_submissionId

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

Referenced by getSubmissionId().


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