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

Public Member Functions

 getArticleId ()
 
 getBestSuppFileId ($journal=null)
 
 getCreator ($locale)
 
 getDateCreated ()
 
 getDateSubmitted ()
 
 getDescription ($locale)
 
 getLanguage ()
 
 getPublisher ($locale)
 
 getRemoteURL ()
 
 getSequence ()
 
 getShowReviewers ()
 
 getSource ($locale)
 
 getSponsor ($locale)
 
 getSubject ($locale)
 
 getSuppFileCreator ()
 
 getSuppFileDescription ()
 
 getSuppFileId ()
 
 getSuppFilePublisher ()
 
 getSuppFileSource ()
 
 getSuppFileSponsor ()
 
 getSuppFileSubject ()
 
 getSuppFileTitle ()
 
 getSuppFileTypeOther ()
 
 getTitle ($locale)
 
 getType ()
 
 getTypeOther ($locale)
 
 setArticleId ($articleId)
 
 setCreator ($creator, $locale)
 
 setDateCreated ($dateCreated)
 
 setDateSubmitted ($dateSubmitted)
 
 setDescription ($description, $locale)
 
 setLanguage ($language)
 
 setPublisher ($publisher, $locale)
 
 setRemoteURL ($remoteURL)
 
 setSequence ($sequence)
 
 setShowReviewers ($showReviewers)
 
 setSource ($source, $locale)
 
 setSponsor ($sponsor, $locale)
 
 setSubject ($subject, $locale)
 
 setSuppFileId ($suppFileId)
 
 setTitle ($title, $locale)
 
 setType ($type)
 
 setTypeOther ($typeOther, $locale)
 
 SuppFile ()
 
- Public Member Functions inherited from ArticleFile
 ArticleFile ()
 
 getArticleId ()
 
 getFilePath ()
 
 getStoredPubId ($pubIdType)
 
 isInlineable ()
 
 setArticleId ($articleId)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from SubmissionFile
 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

Supplementary file class.

See Also
SuppFileDAO

Definition at line 19 of file SuppFile.inc.php.

Member Function Documentation

SuppFile::getArticleId ( )

Get ID of article.

Returns
int

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

References DataObject\getData().

Referenced by getBestSuppFileId().

SuppFile::getBestSuppFileId (   $journal = null)

Return the "best" supp file ID – If a public ID is set, use it; otherwise use the internal Id. (Checks the journal settings to ensure that the public ID feature is enabled.)

Parameters
$journalObject the journal this article is in
Returns
string

Definition at line 393 of file SuppFile.inc.php.

References getArticleId(), DAORegistry\getDAO(), and DataObject\getId().

SuppFile::getCreator (   $locale)

Get creator.

Parameters
$localestring
Returns
string

Definition at line 105 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getDateCreated ( )

Get date created.

Returns
date

Definition at line 268 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getDateSubmitted ( )

Get date file was submitted.

Returns
datetime

Definition at line 342 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getDescription (   $locale)

Get file description.

Parameters
$localestring
Returns
string

Definition at line 199 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getLanguage ( )

Get language.

Returns
string

Definition at line 310 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getPublisher (   $locale)

Get publisher.

Parameters
$localestring
Returns
string

Definition at line 225 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getRemoteURL ( )

Get remote URL of supplementary file.

Returns
string

Definition at line 382 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getSequence ( )

Get sequence order of supplementary file.

Returns
float

Definition at line 358 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getShowReviewers ( )

Check if file is available to peer reviewers.

Returns
boolean

Definition at line 326 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getSource (   $locale)

Get source.

Parameters
$localestring
Returns
string

Definition at line 293 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getSponsor (   $locale)

Get sponsor.

Parameters
$localestring
Returns
string

Definition at line 251 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getSubject (   $locale)

Get subject.

Parameters
$localestring
Returns
string

Definition at line 131 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getSuppFileCreator ( )

Get localized creator

Returns
string

Definition at line 96 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getSuppFileDescription ( )

Get localized description

Returns
string

Definition at line 190 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getSuppFileId ( )

Get ID of supplementary file.

Returns
int

Definition at line 36 of file SuppFile.inc.php.

References DataObject\getId(), and Config\getVar().

SuppFile::getSuppFilePublisher ( )

Get localized publisher

Returns
string

Definition at line 216 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getSuppFileSource ( )

Get localized source

Returns
string

Definition at line 284 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getSuppFileSponsor ( )

Get localized sponsor

Returns
string

Definition at line 242 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getSuppFileSubject ( )

Get localized subject

Returns
string

Definition at line 122 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getSuppFileTitle ( )

Get localized title

Returns
string

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

References DataObject\getLocalizedData().

SuppFile::getSuppFileTypeOther ( )

Get localized subject

Returns
string

Definition at line 164 of file SuppFile.inc.php.

References DataObject\getLocalizedData().

SuppFile::getTitle (   $locale)

Get title.

Parameters
$localestring
Returns
string

Definition at line 79 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getType ( )

Get type (method/approach).

Returns
string

Definition at line 148 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::getTypeOther (   $locale)

Get custom type.

Parameters
$localestring
Returns
string

Definition at line 173 of file SuppFile.inc.php.

References DataObject\getData().

SuppFile::setArticleId (   $articleId)

Set ID of article.

Parameters
$articleIdint

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

References DataObject\setData().

SuppFile::setCreator (   $creator,
  $locale 
)

Set creator.

Parameters
$creatorstring
$localestring

Definition at line 114 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setDateCreated (   $dateCreated)

Set date created.

Parameters
$dateCreateddate

Definition at line 276 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setDateSubmitted (   $dateSubmitted)

Set date file was submitted.

Parameters
$dateSubmitteddatetime

Definition at line 350 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setDescription (   $description,
  $locale 
)

Set file description.

Parameters
$descriptionstring
$localestring

Definition at line 208 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setLanguage (   $language)

Set language.

Parameters
$languagestring

Definition at line 318 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setPublisher (   $publisher,
  $locale 
)

Set publisher.

Parameters
$publisherstring
$localestring

Definition at line 234 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setRemoteURL (   $remoteURL)

Set remote URL of supplementary file.

Parameters
$remoteURLstring

Definition at line 374 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setSequence (   $sequence)

Set sequence order of supplementary file.

Parameters
$sequencefloat

Definition at line 366 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setShowReviewers (   $showReviewers)

Set if file is available to peer reviewers or not.

Parameters
boolean

Definition at line 334 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setSource (   $source,
  $locale 
)

Set source.

Parameters
$sourcestring
$localestring

Definition at line 302 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setSponsor (   $sponsor,
  $locale 
)

Set sponsor.

Parameters
$sponsorstring
$localestring

Definition at line 260 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setSubject (   $subject,
  $locale 
)

Set subject.

Parameters
$subjectstring
$localestring

Definition at line 140 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setSuppFileId (   $suppFileId)

Set ID of supplementary file.

Parameters
$suppFileIdint

Definition at line 45 of file SuppFile.inc.php.

References Config\getVar(), and DataObject\setId().

SuppFile::setTitle (   $title,
  $locale 
)

Set title.

Parameters
$titlestring
$localestring

Definition at line 88 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setType (   $type)

Set type (method/approach).

Parameters
$typestring

Definition at line 156 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::setTypeOther (   $typeOther,
  $locale 
)

Set custom type.

Parameters
$typeOtherstring
$localestring

Definition at line 182 of file SuppFile.inc.php.

References DataObject\setData().

SuppFile::SuppFile ( )

Constructor.

Definition at line 24 of file SuppFile.inc.php.


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