Public Member Functions | |
| _fromRow ($row) | |
| deleteById ($reviewFormElementId) | |
| deleteByReviewFormId ($reviewFormId) | |
| deleteObject ($reviewFormElement) | |
| deleteSetting ($reviewFormElementId, $name, $locale=null) | |
| getById ($reviewFormElementId, $reviewFormId=null) | |
| getByReviewFormId ($reviewFormId, $rangeInfo=null, $included=null) | |
| getInsertId () | |
| getLocaleFieldNames () | |
| getRequiredReviewFormElementIds ($reviewFormId) | |
| insertObject ($reviewFormElement) | |
| newDataObject () | |
| resequenceReviewFormElements ($reviewFormId) | |
| reviewFormElementExists ($reviewFormElementId, $reviewFormId=null) | |
| updateLocaleFields ($reviewFormElement) | |
| updateObject ($reviewFormElement) | |
 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 ReviewFormElement objects.
- See also
- ReviewFormElement
Definition at line 20 of file ReviewFormElementDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| ReviewFormElementDAO::_fromRow | ( | $row | ) |
Internal function to return a ReviewFormElement object from a row.
- Parameters
-
$row array
- Returns
- ReviewFormElement
Definition at line 63 of file ReviewFormElementDAO.inc.php.
References HookRegistry\call(), DAO\getDataObjectSettings(), and newDataObject().
Referenced by getById().
◆ deleteById()
| ReviewFormElementDAO::deleteById | ( | $reviewFormElementId | ) |
Delete a review form element by ID.
- Parameters
-
$reviewFormElementId int
Definition at line 160 of file ReviewFormElementDAO.inc.php.
References DAORegistry\getDAO(), and DAO\update().
Referenced by deleteByReviewFormId(), and deleteObject().
◆ deleteByReviewFormId()
| ReviewFormElementDAO::deleteByReviewFormId | ( | $reviewFormId | ) |
Delete review form elements by review form ID to be called only when deleting a review form.
- Parameters
-
$reviewFormId int
Definition at line 173 of file ReviewFormElementDAO.inc.php.
References deleteById(), and getByReviewFormId().
◆ deleteObject()
| ReviewFormElementDAO::deleteObject | ( | $reviewFormElement | ) |
Delete a review form element.
- Parameters
-
$reviewFormElement reviewFormElement
Definition at line 152 of file ReviewFormElementDAO.inc.php.
References deleteById().
◆ deleteSetting()
| ReviewFormElementDAO::deleteSetting | ( | $reviewFormElementId, | |
| $name, | |||
$locale = null |
|||
| ) |
Delete a review form element setting
- Parameters
-
$reviewFormElementId int $settingName string $locale string
Definition at line 186 of file ReviewFormElementDAO.inc.php.
References DAO\update().
◆ getById()
| ReviewFormElementDAO::getById | ( | $reviewFormElementId, | |
$reviewFormId = null |
|||
| ) |
Retrieve a review form element by ID.
- Parameters
-
$reviewFormElementId int Review form element ID $reviewFormId int optional
- Returns
- ReviewFormElement
Definition at line 28 of file ReviewFormElementDAO.inc.php.
References _fromRow(), and DAO\retrieve().
◆ getByReviewFormId()
| ReviewFormElementDAO::getByReviewFormId | ( | $reviewFormId, | |
$rangeInfo = null, |
|||
$included = null |
|||
| ) |
Retrieve all elements for a review form.
- Parameters
-
$reviewFormId int $rangeInfo object RangeInfo object (optional) $included boolean True for only included comments; false for non-included; null for both
- Returns
- DAOResultFactory containing ReviewFormElements ordered by sequence
Definition at line 205 of file ReviewFormElementDAO.inc.php.
References DAO\retrieveRange().
Referenced by deleteByReviewFormId().
◆ getInsertId()
| ReviewFormElementDAO::getInsertId | ( | ) |
Get the ID of the last inserted review form element.
- Returns
- int
Definition at line 293 of file ReviewFormElementDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
◆ getLocaleFieldNames()
| ReviewFormElementDAO::getLocaleFieldNames | ( | ) |
Get the list of fields for which data can be localized.
- Returns
- array
Reimplemented from DAO.
Definition at line 83 of file ReviewFormElementDAO.inc.php.
◆ getRequiredReviewFormElementIds()
| ReviewFormElementDAO::getRequiredReviewFormElementIds | ( | $reviewFormId | ) |
Retrieve ids of all required elements for a review form.
- Parameters
-
$reviewFormId int return array
Definition at line 224 of file ReviewFormElementDAO.inc.php.
References DAO\retrieve().
◆ insertObject()
| ReviewFormElementDAO::insertObject | ( | $reviewFormElement | ) |
Insert a new review form element.
- Parameters
-
$reviewFormElement ReviewFormElement
- Returns
- int Review form element ID
Definition at line 102 of file ReviewFormElementDAO.inc.php.
References getInsertId(), DAO\update(), and updateLocaleFields().
◆ newDataObject()
| ReviewFormElementDAO::newDataObject | ( | ) |
Construct a new data object corresponding to this DAO.
- Returns
- ReviewFormElement
Definition at line 54 of file ReviewFormElementDAO.inc.php.
Referenced by _fromRow().
◆ resequenceReviewFormElements()
| ReviewFormElementDAO::resequenceReviewFormElements | ( | $reviewFormId | ) |
Sequentially renumber a review form elements in their sequence order.
- Parameters
-
$reviewFormId int
Definition at line 268 of file ReviewFormElementDAO.inc.php.
References DAO\retrieve(), and DAO\update().
◆ reviewFormElementExists()
| ReviewFormElementDAO::reviewFormElementExists | ( | $reviewFormElementId, | |
$reviewFormId = null |
|||
| ) |
Check if a review form element exists with the specified ID.
- Parameters
-
$reviewFormElementId int $reviewFormId int optional
- Returns
- boolean
Definition at line 246 of file ReviewFormElementDAO.inc.php.
References DAO\retrieve().
◆ updateLocaleFields()
| ReviewFormElementDAO::updateLocaleFields | ( | $reviewFormElement | ) |
Update the localized fields for this table
- Parameters
-
$reviewFormElement object
Definition at line 91 of file ReviewFormElementDAO.inc.php.
References DAO\updateDataObjectSettings().
Referenced by insertObject(), and updateObject().
◆ updateObject()
| ReviewFormElementDAO::updateObject | ( | $reviewFormElement | ) |
Update an existing review form element.
- Parameters
-
$reviewFormElement ReviewFormElement
Definition at line 126 of file ReviewFormElementDAO.inc.php.
References DAO\update(), and updateLocaleFields().
The documentation for this class was generated from the following file:
