Open Journal Systems
3.3.0
|
Additional Inherited Members | |
Data Fields inherited from DataObject | |
$_data = array() | |
$_extractionAdaptersLoaded = false | |
$_hasLoadableAdapters = false | |
$_injectionAdaptersLoaded = false | |
$_metadataExtractionAdapters = array() | |
$_metadataInjectionAdapters = array() | |
Submission file class.
Definition at line 35 of file SubmissionFile.inc.php.
SubmissionFile::_fileStageToPath | ( | $fileStage | ) |
Return path associated with a file stage code.
$fileStage | string |
Definition at line 648 of file SubmissionFile.inc.php.
Referenced by getFilePath().
SubmissionFile::_generateFileName | ( | ) |
Generate the unique filename for this submission file.
Definition at line 596 of file SubmissionFile.inc.php.
References PKPFile\getDateUploaded(), getExtension(), getFileId(), getFileStage(), getGenreId(), getRevision(), getSubmissionId(), and strtolower_codesafe().
Referenced by getServerFileName().
SubmissionFile::_generateName | ( | $anonymous = false | ) |
Generate a user-facing name for the file
$anonymous | boolean Whether the user name should be excluded |
Definition at line 617 of file SubmissionFile.inc.php.
References DAORegistry\getDAO(), getDocumentType(), getGenreId(), getSubmissionLocale(), getUploaderUserId(), and AppLocale\requireComponents().
SubmissionFile::copyEditableMetadataFrom | ( | $submissionFile | ) |
Copy the user-facing (editable) metadata from another submission file.
$submissionFile | SubmissionFile |
Reimplemented in SupplementaryFile, and SubmissionArtworkFile.
Definition at line 529 of file SubmissionFile.inc.php.
References setChapterId(), and setName().
SubmissionFile::getAssocId | ( | ) |
Get associated ID of file.
Definition at line 167 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getAssocType | ( | ) |
Get type that is associated with this file.
Definition at line 457 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getBestId | ( | ) |
Return the "best" file ID – If a public ID is set, use it; otherwise use the internal ID and revision.
Definition at line 324 of file SubmissionFile.inc.php.
References getFileIdAndRevision(), and getStoredPubId().
SubmissionFile::getChapterId | ( | ) |
Get the submission chapter id.
Definition at line 473 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getClientFileName | ( | ) |
Get the filename that should be sent to clients when downloading.
Definition at line 539 of file SubmissionFile.inc.php.
References DAORegistry\getDAO(), PKPFile\getDateUploaded(), getExtension(), getFileId(), getFileStage(), getGenreId(), getRevision(), and getSubmissionId().
SubmissionFile::getDAO | ( | ) |
Get DAO class name for this object.
Reimplemented from DataObject.
Definition at line 688 of file SubmissionFile.inc.php.
References DAORegistry\getDAO().
SubmissionFile::getDateModified | ( | ) |
Get modified date of file.
Definition at line 390 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getDirectSalesPrice | ( | ) |
Get price of submission file. A null return indicates "not available"; 0 is free.
Definition at line 206 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getDocumentType | ( | ) |
Get the file's document type (enumerated types)
Definition at line 287 of file SubmissionFile.inc.php.
References PKPFile\getFileType().
Referenced by _generateName().
SubmissionFile::getExtension | ( | ) |
Get the file's extension.
Definition at line 277 of file SubmissionFile.inc.php.
References PKPFile\getOriginalFileName().
Referenced by _generateFileName(), and getClientFileName().
SubmissionFile::getFileId | ( | ) |
Get ID of file.
Definition at line 73 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateFileName(), getClientFileName(), getFileIdAndRevision(), and getViews().
SubmissionFile::getFileIdAndRevision | ( | ) |
Get the combined key of the file consisting of the file id and the revision.
Definition at line 335 of file SubmissionFile.inc.php.
References getFileId(), and getRevision().
Referenced by getBestId().
SubmissionFile::getFileLabel | ( | $locale = null | ) |
Build a file name label.
Definition at line 506 of file SubmissionFile.inc.php.
References getLocalizedName(), getName(), PKPFile\getOriginalFileName(), and getRevision().
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().
SubmissionFile::getFileStage | ( | ) |
Get file stage of the file.
Definition at line 373 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateFileName(), getClientFileName(), getFilePath(), and supportsDependentFiles().
SubmissionFile::getGenreId | ( | ) |
Get the genre id of this file (i.e. referring to Manuscript, Index, etc) Foreign key into genres table
Definition at line 307 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateFileName(), _generateName(), and getClientFileName().
SubmissionFile::getId | ( | ) |
Get ID of file.
Reimplemented from DataObject.
Definition at line 93 of file SubmissionFile.inc.php.
References DataObject\getData().
& SubmissionFile::getLocalizedData | ( | $key, | |
$preferredLocale = null |
|||
) |
Get a piece of data for this object, localized to the current locale if possible.
$key | string |
$preferredLocale | string |
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().
SubmissionFile::getLocalizedName | ( | ) |
Get the localized name of the file
Definition at line 257 of file SubmissionFile.inc.php.
References getLocalizedData().
Referenced by getFileLabel().
SubmissionFile::getMetadataForm | ( | $stageId, | |
$reviewRound | |||
) |
Get the metadata form for this submission file.
$stageId | int FILE_STAGE_... |
$reviewRound | ReviewRound |
Reimplemented in SupplementaryFile, and SubmissionArtworkFile.
Definition at line 680 of file SubmissionFile.inc.php.
SubmissionFile::getName | ( | $locale | ) |
Get the name of the file
$locale | string |
Definition at line 249 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by getFileLabel().
SubmissionFile::getRevision | ( | ) |
Get revision number.
Definition at line 315 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateFileName(), getClientFileName(), getFileIdAndRevision(), and getFileLabel().
SubmissionFile::getRound | ( | ) |
Get round.
Definition at line 408 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getSalesType | ( | ) |
Get sales type of submission file.
Definition at line 223 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getServerFileName | ( | ) |
Reimplemented from PKPFile.
Definition at line 566 of file SubmissionFile.inc.php.
References _generateFileName().
Referenced by getFilePath().
SubmissionFile::getSourceFileId | ( | ) |
Get source file ID of this file.
Definition at line 135 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getSourceRevision | ( | ) |
Get source revision of this file.
Definition at line 151 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getStoredPubId | ( | $pubIdType | ) |
Get stored public ID of the file.
Definition at line 186 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by getBestId().
SubmissionFile::getSubmissionId | ( | ) |
Get ID of submission.
Definition at line 357 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateFileName(), getClientFileName(), and getFilePath().
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
Definition at line 116 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateName(), and getLocalizedData().
SubmissionFile::getUploaderUserId | ( | ) |
Get the uploader's user id.
Definition at line 449 of file SubmissionFile.inc.php.
References DataObject\getData().
Referenced by _generateName().
SubmissionFile::getViewable | ( | ) |
Get viewable.
Definition at line 424 of file SubmissionFile.inc.php.
References DataObject\getData().
SubmissionFile::getViews | ( | ) |
Get submission file number of public downloads.
Definition at line 583 of file SubmissionFile.inc.php.
References $application, PKPApplication\get(), and getFileId().
SubmissionFile::setAssocId | ( | $assocId | ) |
Set associated ID of file.
$assocId | int |
Definition at line 175 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setAssocType | ( | $assocType | ) |
Set type that is associated with this file.
$assocType | int |
Definition at line 465 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setChapterId | ( | $chapterId | ) |
Set the submission chapter id.
$chapterId | int |
Definition at line 481 of file SubmissionFile.inc.php.
References DataObject\setData().
Referenced by copyEditableMetadataFrom().
SubmissionFile::setDateModified | ( | $dateModified | ) |
Set modified date of file.
$dateModified | date |
Definition at line 399 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setDirectSalesPrice | ( | $directSalesPrice | ) |
Set direct sales price. A null return indicates "not available"; 0 is free.
$directSalesPrice | numeric|null |
Definition at line 215 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setFileId | ( | $fileId | ) |
Set ID of file.
$fileId | int |
Definition at line 83 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setFileStage | ( | $fileStage | ) |
Set file stage of the file.
$fileStage | int SUBMISSION_FILE_... |
Definition at line 381 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setGenreId | ( | $genreId | ) |
Set the genre id of this file (i.e. referring to Manuscript, Index, etc) Foreign key into genres table
$genreId | int |
Definition at line 298 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setId | ( | $fileId | ) |
Set ID of file.
$fileId | int |
Reimplemented from DataObject.
Definition at line 103 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setName | ( | $name, | |
$locale | |||
) |
Set the name of the file
$name | string |
$locale | string |
Definition at line 240 of file SubmissionFile.inc.php.
References DataObject\setData().
Referenced by copyEditableMetadataFrom().
SubmissionFile::setRevision | ( | $revision | ) |
Set revision number.
$revision | int |
Definition at line 349 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setRound | ( | $round | ) |
Set round.
$round | int |
Definition at line 416 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setSalesType | ( | $salesType | ) |
Set sales type.
$salesType | string |
Definition at line 231 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setServerFileName | ( | $fileName | ) |
Reimplemented from PKPFile.
Definition at line 575 of file SubmissionFile.inc.php.
SubmissionFile::setSourceFileId | ( | $sourceFileId | ) |
Set source file ID of this file.
$sourceFileId | int |
Definition at line 143 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setSourceRevision | ( | $sourceRevision | ) |
Set source revision of this file.
$sourceRevision | int |
Definition at line 159 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setStoredPubId | ( | $pubIdType, | |
$pubId | |||
) |
Set the stored public ID of the file.
$pubIdType | string 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). |
$pubId | string |
Definition at line 197 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setSubmissionId | ( | $submissionId | ) |
Set ID of submission.
$submissionId | int |
Definition at line 365 of file SubmissionFile.inc.php.
References DataObject\setData().
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
$submissionLocale | string |
Definition at line 127 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setUploaderUserId | ( | $uploaderUserId | ) |
Set the uploader's user id.
$uploaderUserId | integer |
Definition at line 441 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::setViewable | ( | $viewable | ) |
Set viewable.
$viewable | boolean |
Definition at line 433 of file SubmissionFile.inc.php.
References DataObject\setData().
SubmissionFile::supportsDependentFiles | ( | ) |
Determine whether this file supports dependent content.
Definition at line 265 of file SubmissionFile.inc.php.
References getFileStage(), and PKPFile\getFileType().