SuppFileDAO Class Reference
[Paper]

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

List of all members.

Public Member Functions
&	_returnSuppFileFromRow (&$row)
	deleteSuppFile (&$suppFile)
	deleteSuppFileById ($suppFileId, $paperId=null)
	deleteSuppFilesByPaper ($paperId)
	getInsertSuppFileId ()
	getLocaleFieldNames ()
	getNextSuppFileSequence ($paperId)
&	getSuppFile ($suppFileId, $paperId=null)
&	getSuppFileByBestSuppFileId ($paperId, $suppId)
&	getSuppFileByPublicSuppFileId ($publicSuppId, $paperId)
&	getSuppFilesByPaper ($paperId)
	insertSuppFile (&$suppFile)
	resequenceSuppFiles ($paperId)
	suppFileExistsByFileId ($paperId, $fileId)
	suppFileExistsByPublicId ($publicSuppFileId, $suppId, $schedConfId)
	updateLocaleFields (&$suppFile)
	updateSuppFile (&$suppFile)

---

Detailed Description

Operations for retrieving and modifying SuppFile objects.

See also:

SuppFile

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

---

Member Function Documentation

& SuppFileDAO._returnSuppFileFromRow

(

&$

row

)

Internal function to return a SuppFile object from a row.

Parameters:

$row

array

Returns:

SuppFile

Definition at line 117 of file SuppFileDAO.inc.php.

Referenced by getSuppFile(), getSuppFileByPublicSuppFileId(), and getSuppFilesByPaper().

SuppFileDAO.deleteSuppFile

(

&$

suppFile

)

Delete a SuppFile.

Parameters:

$suppFile

SuppFile

Definition at line 212 of file SuppFileDAO.inc.php.

References deleteSuppFileById().

Referenced by deleteSuppFilesByPaper().

SuppFileDAO.deleteSuppFileById	(	$	suppFileId,
		$	paperId = null
	)

Delete a supplementary file by ID.

Parameters:

	$suppFileId	int
	$paperId	int optional

Definition at line 221 of file SuppFileDAO.inc.php.

Referenced by deleteSuppFile().

SuppFileDAO.deleteSuppFilesByPaper

(

$

paperId

)

Delete supplementary files by paper.

Parameters:

$paperId

int

Definition at line 239 of file SuppFileDAO.inc.php.

References deleteSuppFile(), and getSuppFilesByPaper().

SuppFileDAO.getInsertSuppFileId

(

)

Get the ID of the last inserted supplementary file.

Returns:

int

Definition at line 312 of file SuppFileDAO.inc.php.

Referenced by insertSuppFile().

SuppFileDAO.getLocaleFieldNames

(

)

Get the list of fields for which data is localized.

Returns:

array

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

SuppFileDAO.getNextSuppFileSequence

(

$

paperId

)

Get the the next sequence number for a paper's supplementary files (i.e., current max + 1).

Parameters:

$paperId

int

Returns:

int

Definition at line 295 of file SuppFileDAO.inc.php.

Referenced by insertSuppFile().

& SuppFileDAO.getSuppFile	(	$	suppFileId,
		$	paperId = null
	)

Retrieve a supplementary file by ID.

Parameters:

	$suppFileId	int
	$paperId	int optional

Returns:

SuppFile

Definition at line 27 of file SuppFileDAO.inc.php.

References _returnSuppFileFromRow().

Referenced by getSuppFileByBestSuppFileId().

& SuppFileDAO.getSuppFileByBestSuppFileId	(	$	paperId,
		$	suppId
	)

Retrieve supp file by public supp file id or, failing that, internal supp file ID; public ID takes precedence.

Parameters:

	$paperId	int
	$suppId	string

Returns:

SuppFile object

Definition at line 323 of file SuppFileDAO.inc.php.

References getSuppFile(), and getSuppFileByPublicSuppFileId().

& SuppFileDAO.getSuppFileByPublicSuppFileId	(	$	publicSuppId,
		$	paperId
	)

Retrieve a supplementary file by public supp file ID.

Parameters:

	$publicSuppId	string
	$paperId	int

Returns:

SuppFile

Definition at line 53 of file SuppFileDAO.inc.php.

References _returnSuppFileFromRow().

Referenced by getSuppFileByBestSuppFileId().

& SuppFileDAO.getSuppFilesByPaper

(

$

paperId

)

Retrieve all supplementary files for a paper.

Parameters:

$paperId

int

Returns:

array SuppFiles

Definition at line 75 of file SuppFileDAO.inc.php.

References _returnSuppFileFromRow().

Referenced by deleteSuppFilesByPaper().

SuppFileDAO.insertSuppFile

(

&$

suppFile

)

Insert a new SuppFile.

Parameters:

$suppFile

SuppFile

Definition at line 149 of file SuppFileDAO.inc.php.

References getInsertSuppFileId(), getNextSuppFileSequence(), and updateLocaleFields().

SuppFileDAO.resequenceSuppFiles

(

$

paperId

)

Sequentially renumber supplementary files for a paper in their sequence order.

Parameters:

$paperId

int

Definition at line 271 of file SuppFileDAO.inc.php.

SuppFileDAO.suppFileExistsByFileId	(	$	paperId,
		$	fileId
	)

Check if a supplementary file exists with the associated file ID.

Parameters:

	$paperId	int
	$fileId	int

Returns:

boolean

Definition at line 252 of file SuppFileDAO.inc.php.

SuppFileDAO.suppFileExistsByPublicId	(	$	publicSuppFileId,
		$	suppId,
		$	schedConfId
	)

Checks if public identifier exists

Parameters:

	$publicSuppFileId	string
	$suppId	int A supplemental file ID to exempt from the test
	$schedConfId	int

Returns:

boolean

Definition at line 336 of file SuppFileDAO.inc.php.

SuppFileDAO.updateLocaleFields

(

&$

suppFile

)

Update the localized fields for this supp file.

Parameters:

$suppFile

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

Referenced by insertSuppFile(), and updateSuppFile().

SuppFileDAO.updateSuppFile

(

&$

suppFile

)

Update an existing SuppFile.

Parameters:

$suppFile

SuppFile

Definition at line 181 of file SuppFileDAO.inc.php.

References updateLocaleFields().

---

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

• classes/paper/SuppFileDAO.inc.php

---