Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SubmissionFile Class Reference
Inheritance diagram for SubmissionFile:
PKPFile DataObject ArticleFile ArticleGalley SuppFile ArticleHTMLGalley ArticleXMLGalley

Public Member Functions

 getAssocId ()
 
 getDateModified ()
 
 getFileId ()
 
 getFileIdAndRevision ()
 
 getFileStage ()
 
 getRevision ()
 
 getRound ()
 
 getSourceFileId ()
 
 getSourceRevision ()
 
 getSubmissionId ()
 
 getType ()
 
 getViewable ()
 
 isInlineable ()
 
 setAssocId ($assocId)
 
 setDateModified ($dateModified)
 
 setFileId ($fileId)
 
 setFileStage ($fileStage)
 
 setRevision ($revision)
 
 setRound ($round)
 
 setSourceFileId ($sourceFileId)
 
 setSourceRevision ($sourceRevision)
 
 setSubmissionId ($submissionId)
 
 setType ($type)
 
 setViewable ($viewable)
 
 SubmissionFile ()
 
- Public Member Functions inherited from PKPFile
 getDateUploaded ()
 
 getFileId ()
 
 getFileName ()
 
 getFilePath ()
 
 getFileSize ()
 
 getFileType ()
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 PKPFile ()
 
 setDateUploaded ($dateUploaded)
 
 setFileId ($fileId)
 
 setFileName ($fileName)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setOriginalFileName ($originalFileName)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Submission file class.

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

Member Function Documentation

SubmissionFile::getAssocId ( )

Get associated ID of file. (Used, e.g., for email log attachments.)

Returns
int

Definition at line 86 of file SubmissionFile.inc.php.

References DataObject\getData().

SubmissionFile::getDateModified ( )

Get modified date of file.

Returns
date

Definition at line 184 of file SubmissionFile.inc.php.

References DataObject\getData().

SubmissionFile::getFileId ( )

Get ID of file.

Returns
int

Definition at line 34 of file SubmissionFile.inc.php.

References DataObject\getData().

Referenced by getFileIdAndRevision(), and ArticleHTMLGalley\getHTMLContents().

SubmissionFile::getFileIdAndRevision ( )

Get the combined key of the file consisting of the file id and the revision.

Returns
string

Definition at line 111 of file SubmissionFile.inc.php.

References getFileId(), and getRevision().

SubmissionFile::getFileStage ( )

Get file stage of the file.

Returns
int

Definition at line 167 of file SubmissionFile.inc.php.

References DataObject\getData().

Referenced by ArticleFile\getFilePath(), and getType().

SubmissionFile::getRevision ( )

Get revision number.

Returns
int

Definition at line 102 of file SubmissionFile.inc.php.

References DataObject\getData().

Referenced by getFileIdAndRevision().

SubmissionFile::getRound ( )

Get round.

Returns
int

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

References DataObject\getData().

SubmissionFile::getSourceFileId ( )

Get source file ID of this file.

Returns
int

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

References DataObject\getData().

SubmissionFile::getSourceRevision ( )

Get source revision of this file.

Returns
int

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

References DataObject\getData().

SubmissionFile::getSubmissionId ( )

Get ID of submission.

Returns
int

Definition at line 133 of file SubmissionFile.inc.php.

References DataObject\getData().

Referenced by ArticleFile\getArticleId().

SubmissionFile::getType ( )

Get type of the file.

Returns
int

Definition at line 149 of file SubmissionFile.inc.php.

References getFileStage(), and Config\getVar().

SubmissionFile::getViewable ( )

Get viewable.

Returns
boolean

Definition at line 218 of file SubmissionFile.inc.php.

References DataObject\getData().

SubmissionFile::isInlineable ( )

Check if the file may be displayed inline. FIXME: Move to DAO to remove coupling of the domain object to its DAO.

Returns
boolean

Definition at line 241 of file SubmissionFile.inc.php.

References DAORegistry\getDAO().

SubmissionFile::setAssocId (   $assocId)

Set associated ID of file. (Used, e.g., for email log attachments.)

Parameters
$assocIdint

Definition at line 94 of file SubmissionFile.inc.php.

References DataObject\setData().

SubmissionFile::setDateModified (   $dateModified)

Set modified date of file.

Parameters
$dateModifieddate

Definition at line 193 of file SubmissionFile.inc.php.

SubmissionFile::setFileId (   $fileId)

Set ID of file.

Parameters
$fileIdint

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

References DataObject\setData().

SubmissionFile::setFileStage (   $fileStage)

Set file stage of the file.

Parameters
$fileStageint

Definition at line 175 of file SubmissionFile.inc.php.

References DataObject\setData().

Referenced by setType().

SubmissionFile::setRevision (   $revision)

Set revision number.

Parameters
$revisionint

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

References DataObject\setData().

SubmissionFile::setRound (   $round)

Set round.

Parameters
$roundint

Definition at line 210 of file SubmissionFile.inc.php.

SubmissionFile::setSourceFileId (   $sourceFileId)

Set source file ID of this file.

Parameters
$sourceFileIdint

Definition at line 62 of file SubmissionFile.inc.php.

References DataObject\setData().

SubmissionFile::setSourceRevision (   $sourceRevision)

Set source revision of this file.

Parameters
$sourceRevisionint

Definition at line 78 of file SubmissionFile.inc.php.

References DataObject\setData().

SubmissionFile::setSubmissionId (   $submissionId)

Set ID of submission.

Parameters
$submissionIdint

Definition at line 141 of file SubmissionFile.inc.php.

References DataObject\setData().

Referenced by ArticleFile\setArticleId().

SubmissionFile::setType (   $type)

Set type of the file.

Parameters
$typeint

Definition at line 158 of file SubmissionFile.inc.php.

References Config\getVar(), and setFileStage().

SubmissionFile::setViewable (   $viewable)

Set viewable.

Parameters
$viewableboolean

Definition at line 227 of file SubmissionFile.inc.php.

SubmissionFile::SubmissionFile ( )

Constructor.

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


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