PaperFileDAO Class Reference
[Paper]

Operations for retrieving and modifying PaperFile objects. More...

List of all members.

Public Member Functions
&	_returnPaperFileFromRow (&$row)
	deletePaperFile (&$paperFile)
	deletePaperFileById ($fileId, $revision=null)
	deletePaperFiles ($paperId)
	getInsertPaperFileId ()
&	getPaperFile ($fileId, $revision=null, $paperId=null)
&	getPaperFileRevisions ($fileId, $stage=null)
&	getPaperFileRevisionsInRange ($fileId, $start=1, $end=null)
&	getPaperFilesByPaper ($paperId)
&	getRevisionNumber ($fileId)
	insertPaperFile (&$paperFile)
	isInlineable (&$paperFile)
	updatePaperFile (&$paperFile)
Public Attributes
	$inlineableTypes

---

Detailed Description

Operations for retrieving and modifying PaperFile objects.

See also:

PaperFile

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

---

Member Function Documentation

& PaperFileDAO._returnPaperFileFromRow

(

&$

row

)

Internal function to return an PaperFile object from a row.

Parameters:

$row

array

Returns:

PaperFile

Definition at line 203 of file PaperFileDAO.inc.php.

Referenced by getPaperFile(), getPaperFileRevisions(), getPaperFileRevisionsInRange(), and getPaperFilesByPaper().

PaperFileDAO.deletePaperFile

(

&$

paperFile

)

Delete a paper file.

Parameters:

$paper

PaperFile

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

References deletePaperFileById().

PaperFileDAO.deletePaperFileById	(	$	fileId,
		$	revision = null
	)

Delete a paper file by ID.

Parameters:

	$paperId	int
	$revision	int

Definition at line 311 of file PaperFileDAO.inc.php.

Referenced by deletePaperFile().

PaperFileDAO.deletePaperFiles

(

$

paperId

)

Delete all paper files for a paper.

Parameters:

$paperId

int

Definition at line 327 of file PaperFileDAO.inc.php.

PaperFileDAO.getInsertPaperFileId

(

)

Get the ID of the last inserted paper file.

Returns:

int

Definition at line 337 of file PaperFileDAO.inc.php.

Referenced by insertPaperFile().

& PaperFileDAO.getPaperFile	(	$	fileId,
		$	revision = null,
		$	paperId = null
	)

Retrieve a paper by ID.

Parameters:

	$fileId	int
	$revision	int optional, if omitted latest revision is used
	$paperId	int optional

Returns:

PaperFile

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

References _returnPaperFileFromRow().

& PaperFileDAO.getPaperFileRevisions	(	$	fileId,
		$	stage = null
	)

Retrieve all revisions of a paper file.

Parameters:

$paperId

int

Returns:

PaperFile

Definition at line 83 of file PaperFileDAO.inc.php.

References _returnPaperFileFromRow().

& PaperFileDAO.getPaperFileRevisionsInRange	(	$	fileId,
		$	start = 1,
		$	end = null
	)

Retrieve revisions of a paper file in a range.

Parameters:

$paperId

int

Returns:

PaperFile

Definition at line 116 of file PaperFileDAO.inc.php.

References _returnPaperFileFromRow().

& PaperFileDAO.getPaperFilesByPaper

(

$

paperId

)

Retrieve all paper files for a paper.

Parameters:

$paperId

int

Returns:

array PaperFiles

Definition at line 179 of file PaperFileDAO.inc.php.

References _returnPaperFileFromRow().

& PaperFileDAO.getRevisionNumber

(

$

fileId

)

Retrieve the current revision number for a file.

Parameters:

$fileId

int

Returns:

int

Definition at line 151 of file PaperFileDAO.inc.php.

PaperFileDAO.insertPaperFile

(

&$

paperFile

)

Insert a new PaperFile.

Parameters:

$paperFile

PaperFile

Returns:

int

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

References getInsertPaperFileId().

PaperFileDAO.isInlineable

(

&$

paperFile

)

Check whether a file may be displayed inline.

Parameters:

$paperFile

object

Returns:

boolean

Definition at line 346 of file PaperFileDAO.inc.php.

PaperFileDAO.updatePaperFile

(

&$

paperFile

)

Update an existing paper file.

Parameters:

$paper

PaperFile

Definition at line 264 of file PaperFileDAO.inc.php.

---

Member Data Documentation

PaperFileDAO.$inlineableTypes

Array of MIME types that can be displayed inline in a browser

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

---

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

• classes/paper/PaperFileDAO.inc.php

---