PaperFile Class Reference
[Paper]

Paper file class. More...

Inheritance diagram for PaperFile:

List of all members.

Public Member Functions
	getDateModified ()
	getDateUploaded ()
	getFileId ()
	getFileName ()
	getFilePath ()
	getFileSize ()
	getFileType ()
	getNiceFileSize ()
	getOriginalFileName ()
	getPaperId ()
	getRevision ()
	getStage ()
	getType ()
	getViewable ()
	isInlineable ()
	PaperFile ()
	setDateModified ($dateModified)
	setDateUploaded ($dateUploaded)
	setFileId ($fileId)
	setFileName ($fileName)
	setFileSize ($fileSize)
	setFileType ($fileType)
	setOriginalFileName ($originalFileName)
	setPaperId ($paperId)
	setRevision ($revision)
	setStage ($stage)
	setType ($type)
	setViewable ($viewable)

---

Detailed Description

Paper file class.

See also:

PaperFileDAO

Definition at line 18 of file PaperFile.inc.php.

---

Member Function Documentation

PaperFile.getDateModified

(

)

Get modified date of file.

Returns:

date

Reimplemented in PaperNote.

Definition at line 197 of file PaperFile.inc.php.

PaperFile.getDateUploaded

(

)

Get uploaded date of file.

Returns:

date

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

PaperFile.getFileId

(

)

Get ID of file.

Returns:

int

Reimplemented in PaperNote.

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

Referenced by PaperHTMLGalley.getHTMLContents().

PaperFile.getFileName

(

)

Get file name of the file.

Parameters:

return

string

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

Referenced by getFilePath().

PaperFile.getFilePath

(

)

Return absolute path to the file on the host filesystem.

Returns:

string

Definition at line 31 of file PaperFile.inc.php.

References getFileName(), getPaperId(), and getType().

PaperFile.getFileSize

(

)

Get file size of file.

Returns:

int

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

PaperFile.getFileType

(

)

Get file type of the file. @ return string

Definition at line 113 of file PaperFile.inc.php.

Referenced by PaperGalley.isPdfGalley().

PaperFile.getNiceFileSize

(

)

Get nice file size of file.

Returns:

string

Definition at line 235 of file PaperFile.inc.php.

PaperFile.getOriginalFileName

(

)

Get original uploaded file name of the file.

Parameters:

return

string

Definition at line 129 of file PaperFile.inc.php.

Referenced by PaperHTMLGalley.getHTMLContents().

PaperFile.getPaperId

(

)

Get ID of paper.

Returns:

int

Reimplemented in PaperNote, and SuppFile.

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

Referenced by getFilePath(), and PaperHTMLGalley.getHTMLContents().

PaperFile.getRevision

(

)

Get revision number.

Returns:

int

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

PaperFile.getStage

(

)

Get review stage of the file. @ return int

Definition at line 161 of file PaperFile.inc.php.

PaperFile.getType

(

)

Get type of the file. @ return string

Reimplemented in SuppFile.

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

Referenced by getFilePath().

PaperFile.getViewable

(

)

Get viewable.

Returns:

boolean

Definition at line 244 of file PaperFile.inc.php.

PaperFile.isInlineable

(

)

Check if the file may be displayed inline.

Returns:

boolean

Definition at line 262 of file PaperFile.inc.php.

PaperFile.PaperFile

(

)

Constructor.

Definition at line 23 of file PaperFile.inc.php.

PaperFile.setDateModified

(

$

dateModified

)

Set modified date of file.

Parameters:

$dateModified

date

Reimplemented in PaperNote.

Definition at line 207 of file PaperFile.inc.php.

PaperFile.setDateUploaded

(

$

dateUploaded

)

Set uploaded date of file.

Parameters:

$dateUploaded

date

Definition at line 188 of file PaperFile.inc.php.

PaperFile.setFileId

(

$

fileId

)

Set ID of file.

Parameters:

$fileId

int

Reimplemented in PaperNote.

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

PaperFile.setFileName

(

$

fileName

)

Set file name of the file.

Parameters:

$fileName

string

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

PaperFile.setFileSize

(

$

fileSize

)

Set file size of file.

Parameters:

$fileSize

int

Definition at line 226 of file PaperFile.inc.php.

PaperFile.setFileType

(

$

fileType

)

Set file type of the file.

Parameters:

$fileType

string

Definition at line 121 of file PaperFile.inc.php.

PaperFile.setOriginalFileName

(

$

originalFileName

)

Set original uploaded file name of the file.

Parameters:

$originalFileName

string

Definition at line 137 of file PaperFile.inc.php.

PaperFile.setPaperId

(

$

paperId

)

Set ID of paper.

Parameters:

$paperId

int

Reimplemented in PaperNote, and SuppFile.

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

PaperFile.setRevision

(

$

revision

)

Set revision number.

Parameters:

$revision

int

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

PaperFile.setStage

(

$

stage

)

Set stage of the file.

Parameters:

$stage

string

Definition at line 169 of file PaperFile.inc.php.

PaperFile.setType

(

$

type

)

Set type of the file.

Parameters:

$type

string

Reimplemented in SuppFile.

Definition at line 153 of file PaperFile.inc.php.

PaperFile.setViewable

(

$

viewable

)

Set viewable.

Parameters:

$viewable

boolean

Definition at line 254 of file PaperFile.inc.php.

---

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

• classes/paper/PaperFile.inc.php

---