Open Journal Systems  3.3.0
ReviewFormDAO Class Reference
Inheritance diagram for ReviewFormDAO:
DAO

Public Member Functions

 _fromRow ($row)
 
 deleteByAssoc ($assocType, $assocId)
 
 deleteById ($reviewFormId)
 
 deleteObject ($reviewForm)
 
 getActiveByAssocId ($assocType, $assocId, $rangeInfo=null)
 
 getByAssocId ($assocType, $assocId, $rangeInfo=null)
 
 getById ($reviewFormId, $assocType=null, $assocId=null)
 
 getInsertId ()
 
 getLocaleFieldNames ()
 
 insertObject ($reviewForm)
 
 newDataObject ()
 
 resequenceReviewForms ($assocType, $assocId)
 
 reviewFormExists ($reviewFormId, $assocType, $assocId)
 
 unusedReviewFormExists ($reviewFormId, $assocType=null, $assocId=null)
 
 updateLocaleFields (&$reviewForm)
 
 updateObject ($reviewForm)
 
- Public Member Functions inherited from DAO
 __construct ($dataSource=null, $callHooks=true)
 
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAdditionalFieldNames ()
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getType ($value)
 
 handleError ($dataSource, $sql)
 
 nullOrInt ($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

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
 
- Data Fields inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

Operations for retrieving and modifying ReviewForm objects.

See also
ReviewerForm

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

Member Function Documentation

◆ _fromRow()

ReviewFormDAO::_fromRow (   $row)

Internal function to return a ReviewForm object from a row.

Parameters
$rowarray
Returns
ReviewForm

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

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

Referenced by getById().

◆ deleteByAssoc()

ReviewFormDAO::deleteByAssoc (   $assocType,
  $assocId 
)

Delete all review forms by assoc Id.

Parameters
$assocTypeint
$assocIdint

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

References deleteById(), and getByAssocId().

◆ deleteById()

ReviewFormDAO::deleteById (   $reviewFormId)

Delete a review form by Id.

Parameters
$reviewFormIdint

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

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

Referenced by deleteByAssoc(), and deleteObject().

◆ deleteObject()

ReviewFormDAO::deleteObject (   $reviewForm)

Delete a review form.

Parameters
$reviewFormReviewForm

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

References deleteById().

◆ getActiveByAssocId()

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 236 of file ReviewFormDAO.inc.php.

References DAO\retrieveRange().

◆ getByAssocId()

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 213 of file ReviewFormDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteByAssoc().

◆ getById()

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

Retrieve a review form by ID.

Parameters
$reviewFormIdint
$assocTypeint optional
$assocIdint optional
Returns
ReviewForm

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

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

Referenced by unusedReviewFormExists().

◆ getInsertId()

ReviewFormDAO::getInsertId ( )

Get the ID of the last inserted review form.

Returns
int

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

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

ReviewFormDAO::getLocaleFieldNames ( )

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

Returns
array

Reimplemented from DAO.

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

◆ insertObject()

ReviewFormDAO::insertObject (   $reviewForm)

Insert a new review form.

Parameters
$reviewFormReviewForm

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

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

◆ newDataObject()

ReviewFormDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
ReviewForm

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

Referenced by _fromRow().

◆ resequenceReviewForms()

ReviewFormDAO::resequenceReviewForms (   $assocType,
  $assocId 
)

Sequentially renumber review form in their sequence order.

Parameters
$assocTypeint
$assocIdint

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

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

◆ reviewFormExists()

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

Check if a review form exists with the specified ID.

Parameters
$reviewFormIdint
$assocTypeint
$assocIdint
Returns
boolean

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

References DAO\retrieve().

◆ unusedReviewFormExists()

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 259 of file ReviewFormDAO.inc.php.

References getById().

◆ updateLocaleFields()

ReviewFormDAO::updateLocaleFields ( $reviewForm)

Update the localized fields for this table

Parameters
$reviewFormobject

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

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

ReviewFormDAO::updateObject (   $reviewForm)

Update an existing review form.

Parameters
$reviewFormReviewForm

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

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


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