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

Public Member Functions

_returnReviewFormFromRow (&$row)
 
 deleteByAssocId ($assocType, $assocId)
 
 deleteById ($reviewFormId)
 
 deleteObject (&$reviewForm)
 
getActiveByAssocId ($assocType, $assocId, $rangeInfo=null)
 
getByAssocId ($assocType, $assocId, $rangeInfo=null)
 
 getInsertReviewFormId ()
 
 getLocaleFieldNames ()
 
getReviewForm ($reviewFormId, $assocType=null, $assocId=null)
 
getTitlesByAssocId ($assocType, $assocId, $used)
 
getUnusedByAssocId ($assocType, $assocId, $rangeInfo=null)
 
 getUseCounts ($assocType, $assocId, $completion=null)
 
getUsedByAssocId ($assocType, $assocId, $rangeInfo=null)
 
 insertObject (&$reviewForm)
 
 insertReviewForm (&$reviewForm)
 
 newDataObject ()
 
 resequenceReviewForms ($assocType, $assocId)
 
 ReviewFormDAO ()
 
 reviewFormExists ($reviewFormId, $assocType, $assocId)
 
 unusedReviewFormExists ($reviewFormId, $assocType=null, $assocId=null)
 
 updateLocaleFields (&$reviewForm)
 
 updateObject (&$reviewForm)
 
- 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 ReviewForm objects.

See Also
ReviewerForm

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

Member Function Documentation

& ReviewFormDAO::_returnReviewFormFromRow ( $row)

Internal function to return a ReviewForm object from a row.

Parameters
$rowarray
Returns
ReviewForm

Definition at line 112 of file ReviewFormDAO.inc.php.

References HookRegistry\call(), and newDataObject().

Referenced by getReviewForm().

ReviewFormDAO::deleteByAssocId (   $assocType,
  $assocId 
)

Delete all review forms by assoc Id.

Parameters
$assocTypeint
$assocIdint

Definition at line 241 of file ReviewFormDAO.inc.php.

References deleteById(), and getByAssocId().

ReviewFormDAO::deleteById (   $reviewFormId)

Delete a review form by Id.

Parameters
$reviewFormIdint

Definition at line 228 of file ReviewFormDAO.inc.php.

References DAORegistry\getDAO(), and DAO\update().

Referenced by deleteByAssocId(), and deleteObject().

ReviewFormDAO::deleteObject ( $reviewForm)

Delete a review form.

Parameters
$reviewFormReviewForm

Definition at line 220 of file ReviewFormDAO.inc.php.

References deleteById().

& ReviewFormDAO::getActiveByAssocId (   $assocType,
  $assocId,
  $rangeInfo = null 
)

Get active review forms for an associated object.

Parameters
$assocTypeint
$assocIdint
$rangeInfoobject RangeInfo object (optional)
Returns
DAOResultFactory containing matching ReviewForms

Definition at line 277 of file ReviewFormDAO.inc.php.

References DAO\retrieveRange().

& ReviewFormDAO::getByAssocId (   $assocType,
  $assocId,
  $rangeInfo = null 
)

Get all review forms by assoc id.

Parameters
$assocTypeint
$assocIdint
$rangeInfoRangeInfo (optional)
Returns
DAOResultFactory containing matching ReviewForms

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

References DAO\retrieveRange().

Referenced by deleteByAssocId().

ReviewFormDAO::getInsertReviewFormId ( )

Get the ID of the last inserted review form.

Returns
int

Definition at line 461 of file ReviewFormDAO.inc.php.

References DAO\getInsertId().

Referenced by insertObject().

ReviewFormDAO::getLocaleFieldNames ( )

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

Returns
array

Definition at line 151 of file ReviewFormDAO.inc.php.

& ReviewFormDAO::getReviewForm (   $reviewFormId,
  $assocType = null,
  $assocId = null 
)

Retrieve a review form by ID.

Parameters
$reviewFormIdint
$assocTypeint optional
$assocIdint optional
Returns
ReviewForm

Definition at line 36 of file ReviewFormDAO.inc.php.

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

& ReviewFormDAO::getTitlesByAssocId (   $assocType,
  $assocId,
  $used 
)

Retrieve the IDs and titles of all review forms in an associative array.

Parameters
$assocTypeint
$assocIdint
$usedint
Returns
array

Definition at line 369 of file ReviewFormDAO.inc.php.

References getUnusedByAssocId(), and getUsedByAssocId().

& ReviewFormDAO::getUnusedByAssocId (   $assocType,
  $assocId,
  $rangeInfo = null 
)

Get unused review forms for an associated object.

Parameters
$assocTypeint
$assocIdint
$rangeInfoobject RangeInfo object (optional)
Returns
DAOResultFactory containing matching ReviewForms

Definition at line 338 of file ReviewFormDAO.inc.php.

References DAO\retrieveRange().

Referenced by getTitlesByAssocId().

ReviewFormDAO::getUseCounts (   $assocType,
  $assocId,
  $completion = null 
)

Retrieve review form complete/incomplete counts by ID.

Parameters
$assocTypeint
$assocIdint
$completionmixed true for completed forms only, false for incomplete forms only, null for both
Returns
array

Definition at line 70 of file ReviewFormDAO.inc.php.

References DAO\retrieve().

& ReviewFormDAO::getUsedByAssocId (   $assocType,
  $assocId,
  $rangeInfo = null 
)

Get used review forms for an associated object.

Parameters
$assocTypeint
$assocIdint
$rangeInfoobject RangeInfo object (optional)
Returns
DAOResultFactory containing matching ReviewForms

Definition at line 307 of file ReviewFormDAO.inc.php.

References DAO\retrieveRange().

Referenced by getTitlesByAssocId().

ReviewFormDAO::insertObject ( $reviewForm)

Insert a new review form.

Parameters
$reviewFormReviewForm

Definition at line 169 of file ReviewFormDAO.inc.php.

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

Referenced by insertReviewForm().

ReviewFormDAO::insertReviewForm ( $reviewForm)

DEPRECATED

Definition at line 467 of file ReviewFormDAO.inc.php.

References Config\getVar(), and insertObject().

ReviewFormDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
ReviewForm

Definition at line 103 of file ReviewFormDAO.inc.php.

Referenced by _returnReviewFormFromRow().

ReviewFormDAO::resequenceReviewForms (   $assocType,
  $assocId 
)

Sequentially renumber review form in their sequence order.

Parameters
$assocTypeint
$assocIdint

Definition at line 434 of file ReviewFormDAO.inc.php.

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

ReviewFormDAO::ReviewFormDAO ( )

Constructor.

Definition at line 25 of file ReviewFormDAO.inc.php.

ReviewFormDAO::reviewFormExists (   $reviewFormId,
  $assocType,
  $assocId 
)

Check if a review form exists with the specified ID.

Parameters
$reviewFormIdint
$assocTypeint
$assocIdint
Returns
boolean

Definition at line 134 of file ReviewFormDAO.inc.php.

References DAO\retrieve().

ReviewFormDAO::unusedReviewFormExists (   $reviewFormId,
  $assocType = null,
  $assocId = null 
)

Check if a review form exists with the specified ID.

Parameters
$reviewFormIdint
$assocTypeint optional
$assocIdint optional
Returns
boolean

Definition at line 392 of file ReviewFormDAO.inc.php.

References DAO\retrieve().

ReviewFormDAO::updateLocaleFields ( $reviewForm)

Update the localized fields for this table

Parameters
$reviewFormobject

Definition at line 159 of file ReviewFormDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

ReviewFormDAO::updateObject ( $reviewForm)

Update an existing review form.

Parameters
$reviewFormReviewForm

Definition at line 193 of file ReviewFormDAO.inc.php.

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


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