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

Public Member Functions

 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

Article file class.

See Also
ArticleFileDAO

Definition at line 30 of file ArticleFile.inc.php.

Member Function Documentation

ArticleFile::ArticleFile ( )

Constructor.

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

ArticleFile::getFilePath ( )

Return absolute path to the file on the host filesystem.

Returns
string

Definition at line 43 of file ArticleFile.inc.php.

References getArticleId(), DAORegistry\getDAO(), PKPFile\getFileName(), SubmissionFile\getFileStage(), and Config\getVar().

Referenced by ArticleXMLGalley\_getXSLTCache(), ArticleXMLGalley\_xsltCacheMiss(), and ArticleXMLGalley\viewFileContents().

ArticleFile::getStoredPubId (   $pubIdType)

Get stored public ID of the galley.

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).
Returns
string

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

References DataObject\getData().

ArticleFile::isInlineable ( )

Check if the file may be displayed inline.

Returns
boolean

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

References DAORegistry\getDAO().

ArticleFile::setArticleId (   $articleId)

Set ID of article.

Parameters
$articleIdint

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

References SubmissionFile\setSubmissionId().

ArticleFile::setStoredPubId (   $pubIdType,
  $pubId 
)

Set stored public galley id.

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 133 of file ArticleFile.inc.php.

References DataObject\setData().


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