SeriesDAO Class Reference [Press]

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

List of all members.

Public Member Functions
	_fromRow (&$row)
	addCategory ($seriesId, $categoryId)
	categoryAssociationExists ($seriesId, $categoryId)
	deleteById ($seriesId, $pressId=null)
	deleteByPressId ($pressId)
	deleteObject (&$series)
&	getById ($seriesId, $pressId=null)
&	getByPath ($path, $pressId)
&	getByPressId ($pressId, $rangeInfo=null)
	getCategories ($seriesId, $pressId=null)
&	getEditorSeries ($pressId)
	getInsertSeriesId ()
	getLocaleFieldNames ()
&	getTitlesByPressId ($pressId, $submittableOnly=false)
	getUnassignedCategories ($seriesId, $pressId=null)
	insertObject (&$series)
	newDataObject ()
	removeCategory ($seriesId, $categoryId)
	SeriesDAO ()
	seriesExists ($seriesId, $pressId)
	updateLocaleFields (&$series)
	updateObject ($series)

---

Detailed Description

Operations for retrieving and modifying Series objects.

See also:

Series

Definition at line 18 of file SeriesDAO.inc.php.

---

Member Function Documentation

SeriesDAO._fromRow

(

&$

row

)

Internal function to return an Series object from a row.

Parameters:

$row

array

Returns:

Series

Definition at line 91 of file SeriesDAO.inc.php.

References newDataObject().

Referenced by getById(), getByPath(), and getEditorSeries().

SeriesDAO.addCategory	(	$	seriesId,
		$	categoryId
	)

Associate a category with a series.

Parameters:

	$seriesId	int
	$categoryId	int

Definition at line 322 of file SeriesDAO.inc.php.

SeriesDAO.categoryAssociationExists	(	$	seriesId,
		$	categoryId
	)

Check if an series exists with the specified ID.

Parameters:

	$seriesId	int
	$pressId	int

Returns:

boolean

Definition at line 409 of file SeriesDAO.inc.php.

SeriesDAO.deleteById	(	$	seriesId,
		$	pressId = null
	)

Delete an series by ID.

Parameters:

	$seriesId	int
	$pressId	int optional

Definition at line 187 of file SeriesDAO.inc.php.

References seriesExists().

Referenced by deleteObject().

SeriesDAO.deleteByPressId

(

$

pressId

)

Delete series by press ID NOTE: This does not delete dependent entries EXCEPT from series_editors. It is intended to be called only when deleting a press.

Parameters:

$pressId

int

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

References deleteObject(), and getByPressId().

SeriesDAO.deleteObject

(

&$

series

)

Delete an series.

Parameters:

$series

Series

Definition at line 178 of file SeriesDAO.inc.php.

References deleteById().

Referenced by deleteByPressId().

& SeriesDAO.getById	(	$	seriesId,
		$	pressId = null
	)

Retrieve an series by ID.

Parameters:

	$seriesId	int
	$pressId	int optional

Returns:

Series

Definition at line 32 of file SeriesDAO.inc.php.

References _fromRow().

& SeriesDAO.getByPath	(	$	path,
		$	pressId
	)

Retrieve a series by path.

Parameters:

	$path	string
	$pressId	int

Returns:

Series

Definition at line 61 of file SeriesDAO.inc.php.

References _fromRow().

& SeriesDAO.getByPressId	(	$	pressId,
		$	rangeInfo = null
	)

Retrieve all series for a press.

Returns:

DAOResultFactory containing Series ordered by sequence

Definition at line 257 of file SeriesDAO.inc.php.

Referenced by deleteByPressId(), and getTitlesByPressId().

SeriesDAO.getCategories	(	$	seriesId,
		$	pressId = null
	)

Get the categories associated with a given series.

Parameters:

$seriesId

int

Returns:

DAOResultFactory

Definition at line 355 of file SeriesDAO.inc.php.

& SeriesDAO.getEditorSeries

(

$

pressId

)

Retrieve an array associating all series editor IDs with arrays containing the series they edit.

Returns:

array editorId => array(series they edit)

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

References _fromRow().

SeriesDAO.getInsertSeriesId

(

)

Get the ID of the last inserted series.

Returns:

int

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

Referenced by insertObject().

SeriesDAO.getLocaleFieldNames

(

)

Get the list of fields for which data can be localized.

Returns:

array

Definition at line 111 of file SeriesDAO.inc.php.

& SeriesDAO.getTitlesByPressId	(	$	pressId,
		$	submittableOnly = false
	)

Retrieve the IDs and titles of the series for a press in an associative array.

Returns:

array

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

References getByPressId().

SeriesDAO.getUnassignedCategories	(	$	seriesId,
		$	pressId = null
	)

Get the categories not associated with a given series.

Parameters:

$seriesId

int

Returns:

DAOResultFactory

Definition at line 382 of file SeriesDAO.inc.php.

SeriesDAO.insertObject

(

&$

series

)

Insert a new series.

Parameters:

$series

Series

Definition at line 131 of file SeriesDAO.inc.php.

References getInsertSeriesId(), and updateLocaleFields().

SeriesDAO.newDataObject

(

)

Construct a new data object corresponding to this DAO.

Returns:

Series

Definition at line 82 of file SeriesDAO.inc.php.

Referenced by _fromRow().

SeriesDAO.removeCategory	(	$	seriesId,
		$	categoryId
	)

Unassociate a category with a series.

Parameters:

	$seriesId	int
	$categoryId	int

Definition at line 340 of file SeriesDAO.inc.php.

SeriesDAO.SeriesDAO

(

)

Constructor

Definition at line 22 of file SeriesDAO.inc.php.

SeriesDAO.seriesExists	(	$	seriesId,
		$	pressId
	)

Check if an series exists with the specified ID.

Parameters:

	$seriesId	int
	$pressId	int

Returns:

boolean

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

Referenced by deleteById().

SeriesDAO.updateLocaleFields

(

&$

series

)

Update the localized fields for this table

Parameters:

$series

object

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

Referenced by insertObject(), and updateObject().

SeriesDAO.updateObject

(

$

series

)

Update an existing series.

Parameters:

$series

Series

Definition at line 154 of file SeriesDAO.inc.php.

References updateLocaleFields().

---

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

• classes/press/SeriesDAO.inc.php