PKPFile Class Reference

Inheritance diagram for PKPFile:

Public Member Functions
	getDateUploaded ()
	getFilePath ()
	getFileSize ()
	getFileType ()
	getNiceFileSize ()
	getOriginalFileName ()
	getServerFileName ()
	setDateUploaded ($dateUploaded)
	setFileSize ($fileSize)
	setFileType ($fileType)
	setOriginalFileName ($originalFileName)
	setServerFileName ($fileName)
Public Member Functions inherited from DataObject
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	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)
	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

Base PKP file class.

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

Member Function Documentation

getDateUploaded()

PKPFile::getDateUploaded

(

)

Get uploaded date of file.

Returns

date

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

References DataObject\getData().

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

getFilePath()

PKPFile::getFilePath

(

)

Return absolute path to the file on the host filesystem.

Returns

string

Reimplemented in SubmissionFile, and TemporaryFile.

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

getFileSize()

PKPFile::getFileSize

(

)

Get file size of file.

Returns

int

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

References DataObject\getData().

getFileType()

PKPFile::getFileType

(

)

Get type of the file.

Returns

string

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

References DataObject\getData().

Referenced by SubmissionFile\getDocumentType(), IssueGalley\isPdfGalley(), and SubmissionFile\supportsDependentFiles().

getNiceFileSize()

PKPFile::getNiceFileSize

(

)

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

Returns

string

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

References DataObject\getData().

getOriginalFileName()

PKPFile::getOriginalFileName

(

)

Get original uploaded file name of the file.

Parameters

return

string

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

References DataObject\getData().

Referenced by SubmissionFile\getExtension(), and SubmissionFile\getFileLabel().

getServerFileName()

PKPFile::getServerFileName

(

)

Get server-side file name of the file.

Parameters

return

string

Reimplemented in SubmissionFile.

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

References DataObject\getData().

Referenced by TemporaryFile\getFilePath().

setDateUploaded()

PKPFile::setDateUploaded

(

$dateUploaded

)

Set uploaded date of file.

Parameters

$dateUploaded

date

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

setFileSize()

PKPFile::setFileSize

(

$fileSize

)

Set file size of file.

Parameters

$fileSize

int

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

setFileType()

PKPFile::setFileType

(

$fileType

)

Set type of the file.

Parameters

$type

string

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

References DataObject\setData().

setOriginalFileName()

PKPFile::setOriginalFileName

(

$originalFileName

)

Set original uploaded file name of the file.

Parameters

$originalFileName

string

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

References DataObject\setData().

setServerFileName()

PKPFile::setServerFileName

(

$fileName

)

Set server-side file name of the file.

Parameters

$fileName

string

Reimplemented in SubmissionFile.

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

References DataObject\setData().

---

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

• PKPFile.inc.php