PaperNoteDAO Class Reference
[Paper]

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

List of all members.

Public Member Functions
&	_returnPaperNoteFromRow ($row)
	clearAllPaperNotes ($paperId)
	deletePaperNoteById ($noteId)
	getAllPaperNoteFileIds ($paperId)
	getInsertPaperNoteId ()
	getPaperNoteById ($noteId)
&	getPaperNotes ($paperId, $rangeInfo=NULL)
&	getPaperNotesByUserId ($userId, $rangeInfo=NULL)
	insertPaperNote (&$paperNote)
	updatePaperNote ($paperNote)

---

Detailed Description

Operations for retrieving and modifying PaperNote objects.

See also:

PaperNote

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

---

Member Function Documentation

& PaperNoteDAO._returnPaperNoteFromRow

(

$

row

)

creates and returns a paper note object from a row

Parameters:

$row

array

Returns:

PaperNote object

Definition at line 71 of file PaperNoteDAO.inc.php.

Referenced by getPaperNoteById(), getPaperNotes(), and getPaperNotesByUserId().

PaperNoteDAO.clearAllPaperNotes

(

$

paperId

)

clear all paper notes

Parameters:

fileIds

array

Definition at line 185 of file PaperNoteDAO.inc.php.

PaperNoteDAO.deletePaperNoteById

(

$

noteId

)

removes a paper note by id

Parameters:

noteId

int

Definition at line 127 of file PaperNoteDAO.inc.php.

PaperNoteDAO.getAllPaperNoteFileIds

(

$

paperId

)

get all paper note file ids

Parameters:

fileIds

array

Definition at line 162 of file PaperNoteDAO.inc.php.

PaperNoteDAO.getInsertPaperNoteId

(

)

Get the ID of the last inserted paper note.

Returns:

int

Definition at line 119 of file PaperNoteDAO.inc.php.

Referenced by insertPaperNote().

PaperNoteDAO.getPaperNoteById

(

$

noteId

)

Retrieve Paper Note by note id

Parameters:

$noteId

int

Returns:

PaperNote object

Definition at line 54 of file PaperNoteDAO.inc.php.

References _returnPaperNoteFromRow().

& PaperNoteDAO.getPaperNotes	(	$	paperId,
		$	rangeInfo = NULL
	)

Retrieve Paper Notes by paper id.

Parameters:

$paperId

int

Returns:

DAOResultFactory containing PaperNotes

Definition at line 26 of file PaperNoteDAO.inc.php.

References _returnPaperNoteFromRow().

& PaperNoteDAO.getPaperNotesByUserId	(	$	userId,
		$	rangeInfo = NULL
	)

Retrieve Paper Notes by user id.

Parameters:

$userId

int

Returns:

DAOResultFactory containing PaperNotes

Definition at line 40 of file PaperNoteDAO.inc.php.

References _returnPaperNoteFromRow().

PaperNoteDAO.insertPaperNote

(

&$

paperNote

)

inserts a new paper note into paper_notes table

Parameters:

PaperNote

object

Returns:

Paper Note Id int

Definition at line 95 of file PaperNoteDAO.inc.php.

References getInsertPaperNoteId().

PaperNoteDAO.updatePaperNote

(

$

paperNote

)

updates a paper note

Parameters:

PaperNote

object

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

---

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

• classes/paper/PaperNoteDAO.inc.php

---