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

Public Member Functions

 copyEditableMetadataFrom ($submissionFile)
 
 getCreator ($locale)
 
 getDateCreated ()
 
 getDescription ($locale)
 
 getLanguage ()
 
 getLocalizedCreator ($preferredLocale=null)
 
 getLocalizedDescription ()
 
 getLocalizedPublisher ()
 
 getLocalizedSource ()
 
 getLocalizedSponsor ()
 
 getLocalizedSubject ()
 
 getMetadataForm ($stageId, $reviewRound)
 
 getPublisher ($locale)
 
 getSource ($locale)
 
 getSponsor ($locale)
 
 getSubject ($locale)
 
 setCreator ($creator, $locale)
 
 setDateCreated ($dateCreated)
 
 setDescription ($description, $locale)
 
 setLanguage ($language)
 
 setPublisher ($publisher, $locale)
 
 setSource ($source, $locale)
 
 setSponsor ($sponsor, $locale)
 
 setSubject ($subject, $locale)
 
- Public Member Functions inherited from SubmissionFile
 _fileStageToPath ($fileStage)
 
 _generateFileName ()
 
 _generateName ($anonymous=false)
 
 getAssocId ()
 
 getAssocType ()
 
 getBestId ()
 
 getChapterId ()
 
 getClientFileName ()
 
 getDAO ()
 
 getDateModified ()
 
 getDirectSalesPrice ()
 
 getDocumentType ()
 
 getExtension ()
 
 getFileId ()
 
 getFileIdAndRevision ()
 
 getFileLabel ($locale=null)
 
 getFilePath ()
 
 getFileStage ()
 
 getGenreId ()
 
 getId ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedName ()
 
 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

Supplementary file class. This represents submission files that support a complete Dublin Core metadata set, and are typically indexed separately from the submission document itself (e.g. the article). This typically would be used for genres such as data sets etc.

See also
SubmissionFileDAO

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

Member Function Documentation

◆ copyEditableMetadataFrom()

SupplementaryFile::copyEditableMetadataFrom (   $submissionFile)

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

Parameters
$submissionFileSubmissionFile

Reimplemented from SubmissionFile.

Definition at line 221 of file SupplementaryFile.inc.php.

References setCreator(), setDateCreated(), setDescription(), setLanguage(), setPublisher(), setSource(), setSponsor(), and setSubject().

◆ getCreator()

SupplementaryFile::getCreator (   $locale)

Get creator.

Parameters
$locale
Returns
string

Definition at line 41 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ getDateCreated()

SupplementaryFile::getDateCreated ( )

Get date created.

Returns
date

Definition at line 162 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ getDescription()

SupplementaryFile::getDescription (   $locale)

Get file description.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

◆ getLanguage()

SupplementaryFile::getLanguage ( )

Get language.

Returns
string

Definition at line 204 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ getLocalizedCreator()

SupplementaryFile::getLocalizedCreator (   $preferredLocale = null)

Get "localized" creator (if applicable).

Parameters
$preferredLocalestring
Returns
string

Definition at line 32 of file SupplementaryFile.inc.php.

References SubmissionFile\getLocalizedData().

◆ getLocalizedDescription()

SupplementaryFile::getLocalizedDescription ( )

Get localized description

Returns
string

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

References SubmissionFile\getLocalizedData().

◆ getLocalizedPublisher()

SupplementaryFile::getLocalizedPublisher ( )

Get localized publisher

Returns
string

Definition at line 110 of file SupplementaryFile.inc.php.

References SubmissionFile\getLocalizedData().

◆ getLocalizedSource()

SupplementaryFile::getLocalizedSource ( )

Get localized source

Returns
string

Definition at line 178 of file SupplementaryFile.inc.php.

References SubmissionFile\getLocalizedData().

◆ getLocalizedSponsor()

SupplementaryFile::getLocalizedSponsor ( )

Get localized sponsor

Returns
string

Definition at line 136 of file SupplementaryFile.inc.php.

References SubmissionFile\getLocalizedData().

◆ getLocalizedSubject()

SupplementaryFile::getLocalizedSubject ( )

Get localized subject

Returns
string

Definition at line 58 of file SupplementaryFile.inc.php.

References SubmissionFile\getLocalizedData().

◆ getMetadataForm()

SupplementaryFile::getMetadataForm (   $stageId,
  $reviewRound 
)

Get the metadata form for this submission file.

Parameters
$stageIdint FILE_STAGE_...
$reviewRoundReviewRound
Returns
Form

Reimplemented from SubmissionFile.

Definition at line 239 of file SupplementaryFile.inc.php.

◆ getPublisher()

SupplementaryFile::getPublisher (   $locale)

Get publisher.

Parameters
$localestring
Returns
string

Definition at line 119 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ getSource()

SupplementaryFile::getSource (   $locale)

Get source.

Parameters
$localestring
Returns
string

Definition at line 187 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ getSponsor()

SupplementaryFile::getSponsor (   $locale)

Get sponsor.

Parameters
$localestring
Returns
string

Definition at line 145 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ getSubject()

SupplementaryFile::getSubject (   $locale)

Get subject.

Parameters
$localestring
Returns
string

Definition at line 67 of file SupplementaryFile.inc.php.

References DataObject\getData().

◆ setCreator()

SupplementaryFile::setCreator (   $creator,
  $locale 
)

Set creator.

Parameters
$creatorstring
$locale

Definition at line 50 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setDateCreated()

SupplementaryFile::setDateCreated (   $dateCreated)

Set date created.

Parameters
$dateCreateddate

Definition at line 170 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setDescription()

SupplementaryFile::setDescription (   $description,
  $locale 
)

Set file description.

Parameters
$descriptionstring
$localestring

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

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setLanguage()

SupplementaryFile::setLanguage (   $language)

Set language.

Parameters
$languagestring

Definition at line 212 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setPublisher()

SupplementaryFile::setPublisher (   $publisher,
  $locale 
)

Set publisher.

Parameters
$publisherstring
$localestring

Definition at line 128 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setSource()

SupplementaryFile::setSource (   $source,
  $locale 
)

Set source.

Parameters
$sourcestring
$localestring

Definition at line 196 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setSponsor()

SupplementaryFile::setSponsor (   $sponsor,
  $locale 
)

Set sponsor.

Parameters
$sponsorstring
$localestring

Definition at line 154 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().

◆ setSubject()

SupplementaryFile::setSubject (   $subject,
  $locale 
)

Set subject.

Parameters
$subjectstring
$localestring

Definition at line 76 of file SupplementaryFile.inc.php.

References DataObject\setData().

Referenced by copyEditableMetadataFrom().


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