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

Inheritance diagram for MonographDAO:

Public Member Functions
	_cacheMiss (&$cache, $id)
&	_fromRow (&$row)
&	_getCache ()
	_monographFromRow (&$monograph, &$row)
	addCategory ($monographId, $categoryId)
	categoryAssociationExists ($monographId, $categoryId)
	deleteById ($monographId)
	deleteByPressId ($pressId)
	deleteObject (&$monograph)
	flushCache ()
&	getById ($monographId, $pressId=null, $useCache=false)
&	getByPressId ($pressId)
&	getByUserId ($userId, $pressId=null)
	getCategories ($monographId, $pressId=null)
	getInsertMonographId ()
	getLocaleFieldNames ()
&	getMonographsBySeriesEditorId ($pressId=null, $seriesEditorId=null)
	getUnassignedCategories ($monographId, $pressId=null)
&	getUnpublishedMonographsByPressId ($pressId)
	insertMonograph (&$monograph)
	MonographDAO ()
	newDataObject ()
	removeCategories ($monographId)
	removeCategory ($monographId, $categoryId)
	removeMonographsFromSeries ($seriesId)
	updateLocaleFields (&$monograph)
	updateMonograph ($monograph)

Detailed Description

Operations for retrieving and modifying Monograph objects.

See also:: Monograph

Definition at line 19 of file MonographDAO.inc.php.

Member Function Documentation

MonographDAO._cacheMiss	(	&$	cache,
		$	id
	)

Callback for a cache miss.

Parameters:

	$cache	Cache
	$id	string

Returns:: Monograph

Definition at line 37 of file MonographDAO.inc.php.

& MonographDAO._fromRow ( &$ row )

Internal function to return an Monograph object from a row.

Parameters:

$row

array

Returns:: Monograph

Reimplemented in ReviewerSubmissionDAO, and SeriesEditorSubmissionDAO.

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

References _monographFromRow(), and newDataObject().

Referenced by getById().

& MonographDAO._getCache ( )

Get the monograph cache.

Returns:: Cache

Definition at line 47 of file MonographDAO.inc.php.

Referenced by flushCache(), and getById().

MonographDAO._monographFromRow	(	&$	monograph,
		&$	row
	)

Internal function to fill in the passed monograph object from the row.

Parameters:

	$monograph	Monograph output monograph
	$row	array input row

Definition at line 156 of file MonographDAO.inc.php.

Referenced by _fromRow().

MonographDAO.addCategory	(	$	monographId,
		$	categoryId
	)

Associate a category with a monograph.

Parameters:

	$monographId	int
	$categoryId	int

Definition at line 586 of file MonographDAO.inc.php.

MonographDAO.categoryAssociationExists	(	$	monographId,
		$	categoryId
	)

Check if an monograph exists with the specified ID.

Parameters:

	$monographId	int
	$pressId	int

Returns:: boolean

Definition at line 695 of file MonographDAO.inc.php.

MonographDAO.deleteById ( $ monographId )

Delete an monograph by ID.

Parameters:

$monographId

int

Reimplemented in PublishedMonographDAO.

Definition at line 273 of file MonographDAO.inc.php.

References getById().

Referenced by deleteByPressId(), and deleteObject().

MonographDAO.deleteByPressId ( $ pressId )

Delete all monographs by press ID.

Parameters:

$pressId

int

Definition at line 454 of file MonographDAO.inc.php.

References deleteById(), MonographSearchIndex.deleteTextIndex(), and getByPressId().

MonographDAO.deleteObject ( &$ monograph )

Delete monograph by id.

Parameters:

$monograph

object Monograph

Definition at line 265 of file MonographDAO.inc.php.

References deleteById().

MonographDAO.flushCache ( )

Flush the monograph cache.

Definition at line 528 of file MonographDAO.inc.php.

References _getCache().

Referenced by removeMonographsFromSeries(), and updateMonograph().

& MonographDAO.getById	(	$	monographId,
		$	pressId = `null`,
		$	useCache = `false`
	)

Retrieve Monograph by monograph id

Parameters:

	$monographId	int
	$pressId	int optional
	$useCache	boolean optional

Returns:: Monograph

Reimplemented in PublishedMonographDAO.

Definition at line 86 of file MonographDAO.inc.php.

References _fromRow(), and _getCache().

Referenced by deleteById().

& MonographDAO.getByPressId ( $ pressId )

Get all monographs for a press.

Parameters:

$pressId

int

Returns:: DAOResultFactory containing matching Monographs

Definition at line 385 of file MonographDAO.inc.php.

Referenced by deleteByPressId().

& MonographDAO.getByUserId	(	$	userId,
		$	pressId = `null`
	)

Get all monographs for a user.

Parameters:

	$userId	int
	$pressId	int optional

Returns:: array Monographs

Definition at line 472 of file MonographDAO.inc.php.

MonographDAO.getCategories	(	$	monographId,
		$	pressId = `null`
	)

Get the categories associated with a given monograph.

Parameters:

$monographId

int

Returns:: DAOResultFactory

Definition at line 638 of file MonographDAO.inc.php.

MonographDAO.getInsertMonographId ( )

Get the ID of the last inserted monograph.

Returns:: int

Definition at line 521 of file MonographDAO.inc.php.

Referenced by insertMonograph().

MonographDAO.getLocaleFieldNames ( )

Get a list of fields for which localized data is supported

Returns:: array

Definition at line 59 of file MonographDAO.inc.php.

& MonographDAO.getMonographsBySeriesEditorId	(	$	pressId = `null`,
		$	seriesEditorId = `null`
	)

Get all unassigned monographs for a press or all presses

Parameters:

	$pressId	int optional the ID of the press to query.
	$seriesEditorId	int optional the ID of the series editor whose series will be included in the results (excluding others).

Returns:: DAOResultFactory containing matching Monographs

Definition at line 545 of file MonographDAO.inc.php.

MonographDAO.getUnassignedCategories	(	$	monographId,
		$	pressId = `null`
	)

Get the categories not associated with a given monograph.

Parameters:

$monographId

int

Returns:: DAOResultFactory

Definition at line 665 of file MonographDAO.inc.php.

& MonographDAO.getUnpublishedMonographsByPressId ( $ pressId )

Get unpublished monographs for a press.

Parameters:

$pressId

int

Returns:: DAOResultFactory containing matching Monographs

Definition at line 419 of file MonographDAO.inc.php.

MonographDAO.insertMonograph ( &$ monograph )

inserts a new monograph into monographs table

Parameters:

Monograph

object

Returns:: Monograph Id int

Definition at line 186 of file MonographDAO.inc.php.

References getInsertMonographId(), and updateLocaleFields().

MonographDAO.MonographDAO ( )

Constructor.

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

Referenced by PublishedMonographDAO.PublishedMonographDAO(), ReviewerSubmissionDAO.ReviewerSubmissionDAO(), and SeriesEditorSubmissionDAO.SeriesEditorSubmissionDAO().

MonographDAO.newDataObject ( )

Get a new data object representing the monograph.

Returns:: Monograph

Reimplemented in PublishedMonographDAO, ReviewerSubmissionDAO, and SeriesEditorSubmissionDAO.

Definition at line 147 of file MonographDAO.inc.php.

Referenced by _fromRow().

MonographDAO.removeCategories ( $ monographId )

Unassociate all categories.

Parameters:

$monographId

int

Definition at line 626 of file MonographDAO.inc.php.

MonographDAO.removeCategory	(	$	monographId,
		$	categoryId
	)

Unassociate a category with a monograph.

Parameters:

	$monographId	int
	$categoryId	int

Definition at line 604 of file MonographDAO.inc.php.

MonographDAO.removeMonographsFromSeries ( $ seriesId )

Remove all monographs from an series.

Parameters:

$seriesId

int

Definition at line 508 of file MonographDAO.inc.php.

References flushCache().

MonographDAO.updateLocaleFields ( &$ monograph )

Update the localized fields for this object.

Parameters:

$monograph

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

Referenced by insertMonograph(), and updateMonograph().

MonographDAO.updateMonograph ( $ monograph )

updates a monograph

Parameters:

Monograph

object

Definition at line 222 of file MonographDAO.inc.php.

References flushCache(), and updateLocaleFields().

Referenced by SeriesEditorSubmissionDAO.updateSeriesEditorSubmission().

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

classes/monograph/MonographDAO.inc.php

MonographDAO Class Reference [Monograph]

Public Member Functions

Detailed Description

Member Function Documentation

MonographDAO Class Reference
[Monograph]