Open Journal Systems  3.3.0
SubmissionFile Class Reference
Inheritance diagram for SubmissionFile:
PKPFile DataObject SubmissionArtworkFile SupplementaryFile

Public Member Functions

 _fileStageToPath ($fileStage)
 
 _generateFileName ()
 
 _generateName ($anonymous=false)
 
 copyEditableMetadataFrom ($submissionFile)
 
 getAssocId ()
 
 getAssocType ()
 
 getBestId ()
 
 getChapterId ()
 
 getClientFileName ()
 
 getDAO ()
 
 getDateModified ()
 
 getDirectSalesPrice ()
 
 getDocumentType ()
 
 getExtension ()
 
 getFileId ()
 
 getFileIdAndRevision ()
 
 getFileLabel ($locale=null)
 
 getFilePath ()
 
 getFileStage ()
 
 getGenreId ()
 
 getId ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedName ()
 
 getMetadataForm ($stageId, $reviewRound)
 
 getName ($locale)
 
 getRevision ()
 
 getRound ()
 
 getSalesType ()
 
 getServerFileName ()
 
 getSourceFileId ()
 
 getSourceRevision ()
 
 getStoredPubId ($pubIdType)
 
 getSubmissionId ()
 
 getSubmissionLocale ()
 
 getUploaderUserId ()
 
 getViewable ()
 
 getViews ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setChapterId ($chapterId)
 
 setDateModified ($dateModified)
 
 setDirectSalesPrice ($directSalesPrice)
 
 setFileId ($fileId)
 
 setFileStage ($fileStage)
 
 setGenreId ($genreId)
 
 setId ($fileId)
 
 setName ($name, $locale)
 
 setRevision ($revision)
 
 setRound ($round)
 
 setSalesType ($salesType)
 
 setServerFileName ($fileName)
 
 setSourceFileId ($sourceFileId)
 
 setSourceRevision ($sourceRevision)
 
 setStoredPubId ($pubIdType, $pubId)
 
 setSubmissionId ($submissionId)
 
 setSubmissionLocale ($submissionLocale)
 
 setUploaderUserId ($uploaderUserId)
 
 setViewable ($viewable)
 
 supportsDependentFiles ()
 
- Public Member Functions inherited from PKPFile
 getDateUploaded ()
 
 getFileSize ()
 
 getFileType ()
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 setDateUploaded ($dateUploaded)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setOriginalFileName ($originalFileName)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getLocaleMetadataFieldNames ()
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Submission file class.

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

Member Function Documentation

◆ _fileStageToPath()

SubmissionFile::_fileStageToPath (   $fileStage)

Return path associated with a file stage code.

Parameters
$fileStagestring
Returns
string

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

Referenced by getFilePath().

◆ _generateFileName()

SubmissionFile::_generateFileName ( )

Generate the unique filename for this submission file.

Returns
string

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

References PKPFile\getDateUploaded(), getExtension(), getFileId(), getFileStage(), getGenreId(), getRevision(), getSubmissionId(), and strtolower_codesafe().

Referenced by getServerFileName().

◆ _generateName()

SubmissionFile::_generateName (   $anonymous = false)

Generate a user-facing name for the file

Parameters
$anonymousboolean Whether the user name should be excluded
Returns
string

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

References DAORegistry\getDAO(), getDocumentType(), getGenreId(), getSubmissionLocale(), getUploaderUserId(), and AppLocale\requireComponents().

◆ copyEditableMetadataFrom()

SubmissionFile::copyEditableMetadataFrom (   $submissionFile)

Copy the user-facing (editable) metadata from another submission file.

Parameters
$submissionFileSubmissionFile

Reimplemented in SupplementaryFile, and SubmissionArtworkFile.

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

References setChapterId(), and setName().

◆ getAssocId()

SubmissionFile::getAssocId ( )

Get associated ID of file.

Returns
int

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

References DataObject\getData().

◆ getAssocType()

SubmissionFile::getAssocType ( )

Get type that is associated with this file.

Returns
int

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

References DataObject\getData().

◆ getBestId()

SubmissionFile::getBestId ( )

Return the "best" file ID – If a public ID is set, use it; otherwise use the internal ID and revision.

Returns
string

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

References getFileIdAndRevision(), and getStoredPubId().

◆ getChapterId()

SubmissionFile::getChapterId ( )

Get the submission chapter id.

Returns
int

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

References DataObject\getData().

◆ getClientFileName()

SubmissionFile::getClientFileName ( )

Get the filename that should be sent to clients when downloading.

Returns
string

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

References DAORegistry\getDAO(), PKPFile\getDateUploaded(), getExtension(), getFileId(), getFileStage(), getGenreId(), getRevision(), and getSubmissionId().

◆ getDAO()

SubmissionFile::getDAO ( )

Get DAO class name for this object.

Returns
DAO

Reimplemented from DataObject.

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

References DAORegistry\getDAO().

◆ getDateModified()

SubmissionFile::getDateModified ( )

Get modified date of file.

Returns
date

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

References DataObject\getData().

◆ getDirectSalesPrice()

SubmissionFile::getDirectSalesPrice ( )

Get price of submission file. A null return indicates "not available"; 0 is free.

Returns
numeric|null

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

References DataObject\getData().

◆ getDocumentType()

SubmissionFile::getDocumentType ( )

Get the file's document type (enumerated types)

Returns
string

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

References PKPFile\getFileType().

Referenced by _generateName().

◆ getExtension()

SubmissionFile::getExtension ( )

Get the file's extension.

Returns
string

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

References PKPFile\getOriginalFileName().

Referenced by _generateFileName(), and getClientFileName().

◆ getFileId()

SubmissionFile::getFileId ( )

Get ID of file.

Returns
int

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

References DataObject\getData().

Referenced by _generateFileName(), getClientFileName(), getFileIdAndRevision(), and getViews().

◆ getFileIdAndRevision()

SubmissionFile::getFileIdAndRevision ( )

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

Returns
string

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

References getFileId(), and getRevision().

Referenced by getBestId().

◆ getFileLabel()

SubmissionFile::getFileLabel (   $locale = null)

Build a file name label.

Returns
string

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

References getLocalizedName(), getName(), PKPFile\getOriginalFileName(), and getRevision().

◆ getFilePath()

SubmissionFile::getFilePath ( )

Return a context-aware file path.

Reimplemented from PKPFile.

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

References _fileStageToPath(), DAORegistry\getDAO(), getFileStage(), getServerFileName(), and getSubmissionId().

Referenced by SubmissionArtworkFile\getHeight(), and SubmissionArtworkFile\getWidth().

◆ getFileStage()

SubmissionFile::getFileStage ( )

Get file stage of the file.

Returns
int SUBMISSION_FILE_...

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

References DataObject\getData().

Referenced by _generateFileName(), getClientFileName(), getFilePath(), and supportsDependentFiles().

◆ getGenreId()

SubmissionFile::getGenreId ( )

Get the genre id of this file (i.e. referring to Manuscript, Index, etc) Foreign key into genres table

Returns
int

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

References DataObject\getData().

Referenced by _generateFileName(), _generateName(), and getClientFileName().

◆ getId()

SubmissionFile::getId ( )

Get ID of file.

Returns
int

Reimplemented from DataObject.

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

References DataObject\getData().

◆ getLocalizedData()

& SubmissionFile::getLocalizedData (   $key,
  $preferredLocale = null 
)

Get a piece of data for this object, localized to the current locale if possible.

Parameters
$keystring
$preferredLocalestring
Returns
mixed

Reimplemented from DataObject.

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

References DataObject\getData(), AppLocale\getLocale(), and getSubmissionLocale().

Referenced by SupplementaryFile\getLocalizedCreator(), SupplementaryFile\getLocalizedDescription(), getLocalizedName(), SupplementaryFile\getLocalizedPublisher(), SupplementaryFile\getLocalizedSource(), SupplementaryFile\getLocalizedSponsor(), and SupplementaryFile\getLocalizedSubject().

◆ getLocalizedName()

SubmissionFile::getLocalizedName ( )

Get the localized name of the file

Returns
string

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

References getLocalizedData().

Referenced by getFileLabel().

◆ getMetadataForm()

SubmissionFile::getMetadataForm (   $stageId,
  $reviewRound 
)

Get the metadata form for this submission file.

Parameters
$stageIdint FILE_STAGE_...
$reviewRoundReviewRound
Returns
Form

Reimplemented in SupplementaryFile, and SubmissionArtworkFile.

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

◆ getName()

SubmissionFile::getName (   $locale)

Get the name of the file

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Referenced by getFileLabel().

◆ getRevision()

SubmissionFile::getRevision ( )

Get revision number.

Returns
int

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

References DataObject\getData().

Referenced by _generateFileName(), getClientFileName(), getFileIdAndRevision(), and getFileLabel().

◆ getRound()

SubmissionFile::getRound ( )

Get round.

Returns
int

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

References DataObject\getData().

◆ getSalesType()

SubmissionFile::getSalesType ( )

Get sales type of submission file.

Returns
string

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

References DataObject\getData().

◆ getServerFileName()

SubmissionFile::getServerFileName ( )
See also
PKPFile::getServerFileName() Generate the File name from identification data rather than retrieving it from the database.

Reimplemented from PKPFile.

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

References _generateFileName().

Referenced by getFilePath().

◆ getSourceFileId()

SubmissionFile::getSourceFileId ( )

Get source file ID of this file.

Returns
int

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

References DataObject\getData().

◆ getSourceRevision()

SubmissionFile::getSourceRevision ( )

Get source revision of this file.

Returns
int

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

References DataObject\getData().

◆ getStoredPubId()

SubmissionFile::getStoredPubId (   $pubIdType)

Get stored public ID of the file.

Parameters

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

References DataObject\getData().

Referenced by getBestId().

◆ getSubmissionId()

SubmissionFile::getSubmissionId ( )

Get ID of submission.

Returns
int

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

References DataObject\getData().

Referenced by _generateFileName(), getClientFileName(), and getFilePath().

◆ getSubmissionLocale()

SubmissionFile::getSubmissionLocale ( )

Get the locale of the submission. This is not properly a property of the submission file (e.g. it won't be persisted to the DB with the update function) It helps solve submission locale requirement for file's multilingual metadata

Returns
string

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

References DataObject\getData().

Referenced by _generateName(), and getLocalizedData().

◆ getUploaderUserId()

SubmissionFile::getUploaderUserId ( )

Get the uploader's user id.

Returns
integer

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

References DataObject\getData().

Referenced by _generateName().

◆ getViewable()

SubmissionFile::getViewable ( )

Get viewable.

Returns
boolean

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

References DataObject\getData().

◆ getViews()

SubmissionFile::getViews ( )

Get submission file number of public downloads.

Returns
int

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

References $application, PKPApplication\get(), and getFileId().

◆ setAssocId()

SubmissionFile::setAssocId (   $assocId)

Set associated ID of file.

Parameters
$assocIdint

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

References DataObject\setData().

◆ setAssocType()

SubmissionFile::setAssocType (   $assocType)

Set type that is associated with this file.

Parameters
$assocTypeint

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

References DataObject\setData().

◆ setChapterId()

SubmissionFile::setChapterId (   $chapterId)

Set the submission chapter id.

Parameters
$chapterIdint

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

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setDateModified()

SubmissionFile::setDateModified (   $dateModified)

Set modified date of file.

Parameters
$dateModifieddate

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

References DataObject\setData().

◆ setDirectSalesPrice()

SubmissionFile::setDirectSalesPrice (   $directSalesPrice)

Set direct sales price. A null return indicates "not available"; 0 is free.

Parameters
$directSalesPricenumeric|null

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

References DataObject\setData().

◆ setFileId()

SubmissionFile::setFileId (   $fileId)

Set ID of file.

Parameters
$fileIdint

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

References DataObject\setData().

◆ setFileStage()

SubmissionFile::setFileStage (   $fileStage)

Set file stage of the file.

Parameters
$fileStageint SUBMISSION_FILE_...

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

References DataObject\setData().

◆ setGenreId()

SubmissionFile::setGenreId (   $genreId)

Set the genre id of this file (i.e. referring to Manuscript, Index, etc) Foreign key into genres table

Parameters
$genreIdint

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

References DataObject\setData().

◆ setId()

SubmissionFile::setId (   $fileId)

Set ID of file.

Parameters
$fileIdint

Reimplemented from DataObject.

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

References DataObject\setData().

◆ setName()

SubmissionFile::setName (   $name,
  $locale 
)

Set the name of the file

Parameters
$namestring
$localestring

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

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setRevision()

SubmissionFile::setRevision (   $revision)

Set revision number.

Parameters
$revisionint

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

References DataObject\setData().

◆ setRound()

SubmissionFile::setRound (   $round)

Set round.

Parameters
$roundint

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

References DataObject\setData().

◆ setSalesType()

SubmissionFile::setSalesType (   $salesType)

Set sales type.

Parameters
$salesTypestring

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

References DataObject\setData().

◆ setServerFileName()

SubmissionFile::setServerFileName (   $fileName)
See also
PKPFile::setFileName() Do not allow setting the File name of a Submission File directly because it is generated from identification data.

Reimplemented from PKPFile.

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

◆ setSourceFileId()

SubmissionFile::setSourceFileId (   $sourceFileId)

Set source file ID of this file.

Parameters
$sourceFileIdint

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

References DataObject\setData().

◆ setSourceRevision()

SubmissionFile::setSourceRevision (   $sourceRevision)

Set source revision of this file.

Parameters
$sourceRevisionint

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

References DataObject\setData().

◆ setStoredPubId()

SubmissionFile::setStoredPubId (   $pubIdType,
  $pubId 
)

Set the stored public ID of the file.

Parameters
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubIdstring

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

References DataObject\setData().

◆ setSubmissionId()

SubmissionFile::setSubmissionId (   $submissionId)

Set ID of submission.

Parameters
$submissionIdint

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

References DataObject\setData().

◆ setSubmissionLocale()

SubmissionFile::setSubmissionLocale (   $submissionLocale)

Set the locale of the submission. This is not properly a property of the submission file (e.g. it won't be persisted to the DB with the update function) It helps solve submission locale requirement for file's multilingual metadata

Parameters
$submissionLocalestring

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

References DataObject\setData().

◆ setUploaderUserId()

SubmissionFile::setUploaderUserId (   $uploaderUserId)

Set the uploader's user id.

Parameters
$uploaderUserIdinteger

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

References DataObject\setData().

◆ setViewable()

SubmissionFile::setViewable (   $viewable)

Set viewable.

Parameters
$viewableboolean

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

References DataObject\setData().

◆ supportsDependentFiles()

SubmissionFile::supportsDependentFiles ( )

Determine whether this file supports dependent content.

Returns
boolean

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

References getFileStage(), and PKPFile\getFileType().


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