PaperGalleyDAO Class Reference
[Paper]

Operations for retrieving and modifying PaperGalley/PaperHTMLGalley objects. More...

List of all members.

Public Member Functions
&	_returnGalleyFromRow (&$row)
	deleteGalley (&$galley)
	deleteGalleyById ($galleyId, $paperId=null)
	deleteGalleyImage ($galleyId, $fileId)
	deleteGalleysByPaper ($paperId)
	deleteImagesByGalley ($galleyId)
	galleyExistsByFileId ($paperId, $fileId)
&	getGalley ($galleyId, $paperId=null)
&	getGalleyImages ($galleyId)
&	getGalleysByPaper ($paperId)
	getInsertGalleyId ()
	getNextGalleySequence ($paperId)
	incrementViews ($galleyId)
	insertGalley (&$galley)
	insertGalleyImage ($galleyId, $fileId)
	PaperGalleyDAO ()
	resequenceGalleys ($paperId)
	updateGalley (&$galley)
Public Attributes
	$paperFileDao

---

Detailed Description

Operations for retrieving and modifying PaperGalley/PaperHTMLGalley objects.

See also:

Papergalley

Definition at line 21 of file PaperGalleyDAO.inc.php.

---

Member Function Documentation

& PaperGalleyDAO._returnGalleyFromRow

(

&$

row

)

Internal function to return an PaperGalley object from a row.

Parameters:

$row

array

Returns:

PaperGalley

Definition at line 107 of file PaperGalleyDAO.inc.php.

References getGalleyImages().

Referenced by getGalley(), and getGalleysByPaper().

PaperGalleyDAO.deleteGalley

(

&$

galley

)

Delete an PaperGalley.

Parameters:

$galley

PaperGalley

Definition at line 200 of file PaperGalleyDAO.inc.php.

References deleteGalleyById().

PaperGalleyDAO.deleteGalleyById	(	$	galleyId,
		$	paperId = null
	)

Delete a galley by ID.

Parameters:

	$galleyId	int
	$paperId	int optional

Definition at line 209 of file PaperGalleyDAO.inc.php.

References deleteImagesByGalley().

Referenced by deleteGalley(), and deleteGalleysByPaper().

PaperGalleyDAO.deleteGalleyImage	(	$	galleyId,
		$	fileId
	)

Delete an image from an HTML galley.

Parameters:

	$galleyId	int
	$fileId	int

Definition at line 367 of file PaperGalleyDAO.inc.php.

PaperGalleyDAO.deleteGalleysByPaper

(

$

paperId

)

Delete galleys (and dependent galley image entries) by paper. NOTE that this will not delete paper_file entities or the respective files.

Parameters:

$paperId

int

Definition at line 229 of file PaperGalleyDAO.inc.php.

References deleteGalleyById(), and getGalleysByPaper().

PaperGalleyDAO.deleteImagesByGalley

(

$

galleyId

)

Delete HTML galley images by galley.

Parameters:

$galleyId

int

Definition at line 379 of file PaperGalleyDAO.inc.php.

Referenced by deleteGalleyById().

PaperGalleyDAO.galleyExistsByFileId	(	$	paperId,
		$	fileId
	)

Check if a galley exists with the associated file ID.

Parameters:

	$paperId	int
	$fileId	int

Returns:

boolean

Definition at line 242 of file PaperGalleyDAO.inc.php.

& PaperGalleyDAO.getGalley	(	$	galleyId,
		$	paperId = null
	)

Retrieve a galley by ID.

Parameters:

	$galleyId	int
	$paperId	int optional

Returns:

PaperGalley

Definition at line 39 of file PaperGalleyDAO.inc.php.

References _returnGalleyFromRow().

& PaperGalleyDAO.getGalleyImages

(

$

galleyId

)

Retrieve array of the images for an HTML galley.

Parameters:

$galleyId

int

Returns:

array PaperFile

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

Referenced by _returnGalleyFromRow().

& PaperGalleyDAO.getGalleysByPaper

(

$

paperId

)

Retrieve all galleys for a paper.

Parameters:

$paperId

int

Returns:

array PaperGalleys

Definition at line 77 of file PaperGalleyDAO.inc.php.

References _returnGalleyFromRow().

Referenced by deleteGalleysByPaper().

PaperGalleyDAO.getInsertGalleyId

(

)

Get the ID of the last inserted gallery.

Returns:

int

Definition at line 313 of file PaperGalleyDAO.inc.php.

Referenced by insertGalley().

PaperGalleyDAO.getNextGalleySequence

(

$

paperId

)

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

Parameters:

$paperId

int

Returns:

int

Definition at line 296 of file PaperGalleyDAO.inc.php.

Referenced by insertGalley().

PaperGalleyDAO.incrementViews

(

$

galleyId

)

Increment the views count for a galley.

Parameters:

$galleyId

int

Definition at line 261 of file PaperGalleyDAO.inc.php.

PaperGalleyDAO.insertGalley

(

&$

galley

)

Insert a new PaperGalley.

Parameters:

$galley

PaperGalley

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

References getInsertGalleyId(), and getNextGalleySequence().

PaperGalleyDAO.insertGalleyImage	(	$	galleyId,
		$	fileId
	)

Attach an image to an HTML galley.

Parameters:

	$galleyId	int
	$fileId	int

Definition at line 352 of file PaperGalleyDAO.inc.php.

PaperGalleyDAO.PaperGalleyDAO

(

)

Constructor.

Definition at line 28 of file PaperGalleyDAO.inc.php.

PaperGalleyDAO.resequenceGalleys

(

$

paperId

)

Sequentially renumber galleys for a paper in their sequence order.

Parameters:

$paperId

int

Definition at line 272 of file PaperGalleyDAO.inc.php.

PaperGalleyDAO.updateGalley

(

&$

galley

)

Update an existing PaperGalley.

Parameters:

$galley

PaperGalley

Definition at line 173 of file PaperGalleyDAO.inc.php.

---

Member Data Documentation

PaperGalleyDAO.$paperFileDao

Helper file DAOs.

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

---

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

• classes/paper/PaperGalleyDAO.inc.php

---