Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
MonographDAO Class Reference
Inheritance diagram for MonographDAO:
PublishedMonographDAO ReviewerSubmissionDAO SeriesEditorSubmissionDAO

Public Member Functions

 _fromRow ($row)
 
 addCategory ($monographId, $categoryId)
 
 categoryAssociationExists ($monographId, $categoryId)
 
 deleteById ($monographId)
 
 getByPressId ($pressId)
 
 getBySubEditorId ($contextId=null, $subEditorId=null, $includeDeclined=true, $includePublished=true, $rangeInfo=null)
 
 getCategories ($monographId, $pressId=null)
 
 getLocaleFieldNames ()
 
 getUnassignedCategories ($monographId, $pressId=null)
 
 getUnpublishedMonographsByPressId ($pressId)
 
 insertObject ($monograph)
 
 MonographDAO ()
 
 newDataObject ()
 
 removeCategories ($monographId)
 
 removeCategory ($monographId, $categoryId)
 
 removeMonographsFromSeries ($seriesId)
 
 updateObject ($monograph)
 

Protected Member Functions

 _getFetchColumns ()
 
 _getFetchJoins ()
 
 _getFetchParameters ()
 

Detailed Description

Operations for retrieving and modifying Monograph objects.

See Also
Monograph

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

Member Function Documentation

MonographDAO::_fromRow (   $row)

Internal function to return an Monograph object from a row.

Parameters
$rowarray
Returns
Monograph

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

References HookRegistry\call().

MonographDAO::_getFetchColumns ( )
protected
MonographDAO::_getFetchJoins ( )
protected
MonographDAO::_getFetchParameters ( )
protected
MonographDAO::addCategory (   $monographId,
  $categoryId 
)

Associate a category with a monograph.

Parameters
$monographIdint
$categoryIdint

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

MonographDAO::categoryAssociationExists (   $monographId,
  $categoryId 
)

Check if an monograph exists with the specified ID.

Parameters
$monographIdint
$pressIdint
Returns
boolean

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

MonographDAO::deleteById (   $monographId)

Delete an monograph by ID.

Parameters
$monographIdint

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

References MonographSearchIndex\deleteTextIndex(), and DAORegistry\getDAO().

MonographDAO::getByPressId (   $pressId)

Get all monographs for a press.

Parameters
$pressIdint
Returns
DAOResultFactory containing matching Monographs

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

MonographDAO::getBySubEditorId (   $contextId = null,
  $subEditorId = null,
  $includeDeclined = true,
  $includePublished = true,
  $rangeInfo = null 
)

Get all unassigned submissions for a context or all contexts

Parameters
$contextIdmixed optional the ID of the journal to query, or an array containing possible context ids.
$subEditorIdint optional the ID of the sub editor whose series will be included in the results (excluding others).
$includeDeclinedboolean optional include submissions which have STATUS_DECLINED
$includePublishedboolean optional include submissions which are published
$rangeInfoDBRangeInfo
Returns
DAOResultFactory containing matching Submissions

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

References _getFetchColumns(), _getFetchJoins(), _getFetchParameters(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

MonographDAO::getCategories (   $monographId,
  $pressId = null 
)

Get the categories associated with a given monograph.

Parameters
$monographIdint
Returns
DAOResultFactory

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

References DAORegistry\getDAO().

MonographDAO::getLocaleFieldNames ( )

Get a list of fields for which localized data is supported

Returns
array

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

MonographDAO::getUnassignedCategories (   $monographId,
  $pressId = null 
)

Get the categories not associated with a given monograph.

Parameters
$monographIdint
Returns
DAOResultFactory

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

References DAORegistry\getDAO().

MonographDAO::getUnpublishedMonographsByPressId (   $pressId)

Get unpublished monographs for a press.

Parameters
$pressIdint
Returns
DAOResultFactory containing matching Monographs

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

References _getFetchColumns(), _getFetchJoins(), and _getFetchParameters().

MonographDAO::insertObject (   $monograph)

inserts a new monograph into submissions table

Parameters
Monographobject
Returns
Monograph Id int

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

MonographDAO::MonographDAO ( )

Constructor.

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

MonographDAO::newDataObject ( )

Get a new data object representing the monograph.

Returns
Monograph

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

MonographDAO::removeCategories (   $monographId)

Unassociate all categories.

Parameters
$monographIdint

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

MonographDAO::removeCategory (   $monographId,
  $categoryId 
)

Unassociate a category with a monograph.

Parameters
$monographIdint
$categoryIdint

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

References DAORegistry\getDAO().

MonographDAO::removeMonographsFromSeries (   $seriesId)

Remove all monographs from an series.

Parameters
$seriesIdint

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

MonographDAO::updateObject (   $monograph)

updates a monograph

Parameters
Monographobject

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


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