Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
BookForReviewDAO Class Reference
Inheritance diagram for BookForReviewDAO:
DAO

Public Member Functions

_returnBookForReviewFromRow (&$row)
 
 BookForReviewDAO ($parentPluginName)
 
 changeBookForReviewStatus ($bookId, $status)
 
 deleteBookForReviewById ($bookId)
 
 deleteBooksForReviewByJournal ($journalId)
 
 deleteObject ($book)
 
getBookForReview ($bookId)
 
 getBookForReviewJournalId ($bookId)
 
getBooksForReviewAssignedByAuthor ($journalId, $userId, $rangeInfo=null)
 
getBooksForReviewByAuthor ($journalId, $userId, $rangeInfo=null)
 
getBooksForReviewByDateDue ($journalId, $dateDue, $rangeInfo=null)
 
getBooksForReviewByJournalId ($journalId, $searchType=null, $search=null, $searchMatch=null, $status=null, $userId=null, $editorId=null, $rangeInfo=null)
 
 getBooksForReviewStatusCount ($journalId, $status=null, $userId=null)
 
 getInsertBookForReviewId ()
 
 getLocaleFieldNames ()
 
getStatusCounts ($journalId, $userId=null)
 
getSubmittedBookForReviewByArticle ($journalId, $articleId)
 
 getSubmittedBookForReviewIdByArticle ($journalId, $articleId)
 
 insertObject (&$book)
 
 removeCoverPage ($bookId, $locale)
 
 updateLocaleFields (&$book)
 
 updateObject (&$book)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying BookForReview objects.

See Also
BookForReview

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

Member Function Documentation

& BookForReviewDAO::_returnBookForReviewFromRow ( $row)

Internal function to return a BookForReview object from a row.

Parameters
$rowarray
Returns
BookForReview

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

References HookRegistry\call(), and PluginRegistry\getPlugin().

Referenced by getBookForReview(), and getSubmittedBookForReviewByArticle().

BookForReviewDAO::BookForReviewDAO (   $parentPluginName)

Constructor.

Definition at line 38 of file BookForReviewDAO.inc.php.

References DAORegistry\getDAO().

BookForReviewDAO::changeBookForReviewStatus (   $bookId,
  $status 
)

Change the status of the book for review

Parameters
$bookIdint
$statusint

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

References DAO\update().

BookForReviewDAO::deleteBookForReviewById (   $bookId)

Delete a book for review by book ID.

Parameters
$bookIdint

Definition at line 305 of file BookForReviewDAO.inc.php.

References getBookForReview(), AppLocale\getSupportedLocales(), and DAO\update().

Referenced by deleteBooksForReviewByJournal(), and deleteObject().

BookForReviewDAO::deleteBooksForReviewByJournal (   $journalId)

Delete books for review by journal ID.

Parameters
$journalIdint

Definition at line 332 of file BookForReviewDAO.inc.php.

References deleteBookForReviewById(), and getBooksForReviewByJournalId().

BookForReviewDAO::deleteObject (   $book)

Delete a book for review.

Parameters
$bookBookForReview

Definition at line 297 of file BookForReviewDAO.inc.php.

References deleteBookForReviewById().

& BookForReviewDAO::getBookForReview (   $bookId)

Retrieve a book for review by book ID.

Parameters
$bookIdint
Returns
BookForReview

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

References _returnBookForReviewFromRow(), and DAO\retrieve().

Referenced by deleteBookForReviewById(), and removeCoverPage().

BookForReviewDAO::getBookForReviewJournalId (   $bookId)

Retrieve book for review journal ID by book ID.

Parameters
$bookIdint
Returns
int

Definition at line 93 of file BookForReviewDAO.inc.php.

References DAO\retrieve().

& BookForReviewDAO::getBooksForReviewAssignedByAuthor (   $journalId,
  $userId,
  $rangeInfo = null 
)

Retrieve all books assigned/mailed to an author for a particular journal.

Parameters
$journalIdint
$userIdint, author to match
$rangeInfoobject DBRangeInfo object describing range of results to return
Returns
object DAOResultFactory containing matching BooksForReview

Definition at line 375 of file BookForReviewDAO.inc.php.

References PluginRegistry\getPlugin(), and DAO\retrieveRange().

& BookForReviewDAO::getBooksForReviewByAuthor (   $journalId,
  $userId,
  $rangeInfo = null 
)

Retrieve all books by review author for a particular journal.

Parameters
$journalIdint
$userIdint, author to match
$rangeInfoobject DBRangeInfo object describing range of results to return
Returns
object DAOResultFactory containing matching BooksForReview

Definition at line 348 of file BookForReviewDAO.inc.php.

References PluginRegistry\getPlugin(), and DAO\retrieveRange().

& BookForReviewDAO::getBooksForReviewByDateDue (   $journalId,
  $dateDue,
  $rangeInfo = null 
)

Retrieve all books assigned/mailed by date due for a particular journal.

Parameters
$journalIdint
$dateDuestring 'YYYY-MM-DD'
$rangeInfoobject DBRangeInfo object describing range of results to return
Returns
object DAOResultFactory containing matching BooksForReview

Definition at line 405 of file BookForReviewDAO.inc.php.

References DAO\dateToDB(), PluginRegistry\getPlugin(), and DAO\retrieveRange().

& BookForReviewDAO::getBooksForReviewByJournalId (   $journalId,
  $searchType = null,
  $search = null,
  $searchMatch = null,
  $status = null,
  $userId = null,
  $editorId = null,
  $rangeInfo = null 
)

Retrieve all books for review matching a particular journal ID.

Parameters
$journalIdint
$searchTypeint optional, which field to search
$searchstring optional, string to match
$searchMatchstring optional, type of match ('is' vs. 'contains')
$statusint optional, status to match
$userIdint, optional user to match
$editorIdint, optional editor to match
$rangeInfoobject DBRangeInfo object describing range of results to return
Returns
object DAOResultFactory containing matching BooksForReview

Definition at line 441 of file BookForReviewDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteBooksForReviewByJournal().

BookForReviewDAO::getBooksForReviewStatusCount (   $journalId,
  $status = null,
  $userId = null 
)

Retrieve status counts for a particular journal (and optionally user).

Parameters
$journalIdint
$statusint, book for review status to match
$userIdint, book review user to match
Returns
int

Definition at line 567 of file BookForReviewDAO.inc.php.

References PluginRegistry\getPlugin(), and DAO\retrieve().

Referenced by getStatusCounts().

BookForReviewDAO::getInsertBookForReviewId ( )

Get the ID of the last inserted book for review.

Returns
int

Definition at line 648 of file BookForReviewDAO.inc.php.

References DAO\getInsertId().

Referenced by insertObject().

BookForReviewDAO::getLocaleFieldNames ( )

Get a list of field names for which data is localized.

Returns
array

Definition at line 48 of file BookForReviewDAO.inc.php.

& BookForReviewDAO::getStatusCounts (   $journalId,
  $userId = null 
)

Retrieve all status counts for a particular journal (and optionally user).

Parameters
$journalIdint
$userIdint, book review user to match
Returns
array, status as index

Definition at line 596 of file BookForReviewDAO.inc.php.

References getBooksForReviewStatusCount(), and PluginRegistry\getPlugin().

& BookForReviewDAO::getSubmittedBookForReviewByArticle (   $journalId,
  $articleId 
)

Retrieve a submitted book for review for a journal by article ID.

Parameters
$articleIdint
Returns
BookForReview

Definition at line 504 of file BookForReviewDAO.inc.php.

References _returnBookForReviewFromRow(), PluginRegistry\getPlugin(), and DAO\retrieve().

BookForReviewDAO::getSubmittedBookForReviewIdByArticle (   $journalId,
  $articleId 
)

Return a submitted book for review id for a given article and journal.

Parameters
$journalIdint
$articleIdint
Returns
int

Definition at line 535 of file BookForReviewDAO.inc.php.

References PluginRegistry\getPlugin(), and DAO\retrieve().

BookForReviewDAO::insertObject ( $book)

Insert a new BookForReview.

Parameters
$bookBookForReview
Returns
int

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

References DAO\datetimeToDB(), getInsertBookForReviewId(), DAO\update(), and updateLocaleFields().

BookForReviewDAO::removeCoverPage (   $bookId,
  $locale 
)

Remove the cover page image for the book for review

Parameters
$bookIdint

Definition at line 614 of file BookForReviewDAO.inc.php.

References getBookForReview(), and updateObject().

BookForReviewDAO::updateLocaleFields ( $book)

Update the settings for this object

Parameters
$articleobject

Definition at line 64 of file BookForReviewDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

BookForReviewDAO::updateObject ( $book)

Update an existing book for review.

Parameters
$bookBookForReview
Returns
boolean

Definition at line 218 of file BookForReviewDAO.inc.php.

References DAO\datetimeToDB(), DAO\update(), and updateLocaleFields().

Referenced by removeCoverPage().


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