Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPFile Class Reference
Inheritance diagram for PKPFile:
DataObject SubmissionFile TemporaryFile MonographFile ArtworkFile

Public Member Functions

 getDateUploaded ()
 
 getFileId ()
 
 getFilePath ()
 
 getFileSize ()
 
 getFileType ()
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 getServerFileName ()
 
 PKPFile ()
 
 setDateUploaded ($dateUploaded)
 
 setFileId ($fileId)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setOriginalFileName ($originalFileName)
 
 setServerFileName ($fileName)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 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()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Base PKP file class.

Definition at line 16 of file PKPFile.inc.php.

Member Function Documentation

PKPFile::getDateUploaded ( )

Get uploaded date of file.

Returns
date

Definition at line 98 of file PKPFile.inc.php.

References DataObject\getData().

Referenced by SubmissionFile\_generateFileName(), and SubmissionFile\getClientFileName().

PKPFile::getFileId ( )

Get ID of file.

Returns
int

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

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

PKPFile::getFilePath ( )

Return absolute path to the file on the host filesystem.

Returns
string

Definition at line 147 of file PKPFile.inc.php.

PKPFile::getFileSize ( )

Get file size of file.

Returns
int

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

References DataObject\getData().

PKPFile::getFileType ( )

Get type of the file. @ return string

Definition at line 82 of file PKPFile.inc.php.

References DataObject\getData().

Referenced by SubmissionFile\getDocumentType().

PKPFile::getNiceFileSize ( )

Return pretty file size string (in B, KB, MB, or GB units).

Returns
string

Definition at line 130 of file PKPFile.inc.php.

References DataObject\getData().

PKPFile::getOriginalFileName ( )

Get original uploaded file name of the file.

Parameters
returnstring

Definition at line 66 of file PKPFile.inc.php.

References DataObject\getData().

Referenced by SubmissionFile\getFileLabel().

PKPFile::getServerFileName ( )

Get server-side file name of the file.

Parameters
returnstring

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

References DataObject\getData().

Referenced by TemporaryFile\getFilePath().

PKPFile::PKPFile ( )

Constructor.

Definition at line 20 of file PKPFile.inc.php.

PKPFile::setDateUploaded (   $dateUploaded)

Set uploaded date of file.

Parameters
$dateUploadeddate

Definition at line 106 of file PKPFile.inc.php.

PKPFile::setFileId (   $fileId)

Set ID of file.

Parameters
$fileIdint

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

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

PKPFile::setFileSize (   $fileSize)

Set file size of file.

Parameters
$fileSizeint

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

PKPFile::setFileType (   $fileType)

Set type of the file.

Parameters
$typestring

Definition at line 90 of file PKPFile.inc.php.

References DataObject\setData().

PKPFile::setOriginalFileName (   $originalFileName)

Set original uploaded file name of the file.

Parameters
$originalFileNamestring

Definition at line 74 of file PKPFile.inc.php.

References DataObject\setData().

PKPFile::setServerFileName (   $fileName)

Set server-side file name of the file.

Parameters
$fileNamestring

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

References DataObject\setData().


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