Public Member Functions | |
| _fromRow ($row) | |
| deleteObject (&$filterGroup) | |
| deleteObjectById ($filterGroupId) | |
| deleteObjectBySymbolic ($filterGroupSymbolic) | |
| getInsertId () | |
| & | getObject (&$filterGroup) |
| & | getObjectById ($filterGroupId) |
| & | getObjectBySymbolic ($filterGroupSymbolic) |
| insertObject (&$filterGroup) | |
| newDataObject () | |
| updateObject (&$filterGroup) | |
 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 () | |
| getLocaleFieldNames () | |
| 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 FilterGroup objects.
- See also
- FilterGroup
Definition at line 19 of file FilterGroupDAO.inc.php.
Member Function Documentation
◆ _fromRow()
| FilterGroupDAO::_fromRow | ( | $row | ) |
Internal function to return a filter group object from a row.
- Parameters
-
$row array
- Returns
- FilterGroup
Definition at line 191 of file FilterGroupDAO.inc.php.
References newDataObject().
Referenced by getObjectById(), and getObjectBySymbolic().
◆ deleteObject()
| FilterGroupDAO::deleteObject | ( | & | $filterGroup | ) |
Delete a filter group (only works if there are not more filters in this group).
- Parameters
-
$filterGroup FilterGroup
- Returns
- boolean
Definition at line 120 of file FilterGroupDAO.inc.php.
References DAORegistry\getDAO(), and DAO\update().
Referenced by deleteObjectById(), and deleteObjectBySymbolic().
◆ deleteObjectById()
| FilterGroupDAO::deleteObjectById | ( | $filterGroupId | ) |
Delete a filter group by id.
- Parameters
-
$filterGroupId int
- Returns
- boolean
Definition at line 142 of file FilterGroupDAO.inc.php.
References deleteObject(), and getObjectById().
◆ deleteObjectBySymbolic()
| FilterGroupDAO::deleteObjectBySymbolic | ( | $filterGroupSymbolic | ) |
Delete a filter group by symbolic name.
- Parameters
-
$filterGroupSymbolic string
- Returns
- boolean
Definition at line 154 of file FilterGroupDAO.inc.php.
References deleteObject(), and getObjectBySymbolic().
◆ getInsertId()
| FilterGroupDAO::getInsertId | ( | ) |
Get the ID of the last inserted filter group.
- Returns
- int
Definition at line 168 of file FilterGroupDAO.inc.php.
Referenced by insertObject().
◆ getObject()
| & FilterGroupDAO::getObject | ( | & | $filterGroup | ) |
Retrieve a filter group
- Parameters
-
$filterGroup FilterGroup
- Returns
- FilterGroup
Definition at line 49 of file FilterGroupDAO.inc.php.
References getObjectById().
◆ getObjectById()
| & FilterGroupDAO::getObjectById | ( | $filterGroupId | ) |
Retrieve a configured filter group by id.
- Parameters
-
$filterGroupId integer
- Returns
- FilterGroup
Definition at line 58 of file FilterGroupDAO.inc.php.
References _fromRow(), and DAO\retrieve().
Referenced by deleteObjectById(), and getObject().
◆ getObjectBySymbolic()
| & FilterGroupDAO::getObjectBySymbolic | ( | $filterGroupSymbolic | ) |
Retrieve a configured filter group by its symbolic representation.
- Parameters
-
$filterGroupSymbolic string
- Returns
- FilterGroup
Definition at line 77 of file FilterGroupDAO.inc.php.
References _fromRow(), and DAO\retrieve().
Referenced by deleteObjectBySymbolic().
◆ insertObject()
| FilterGroupDAO::insertObject | ( | & | $filterGroup | ) |
Insert a new filter group.
- Parameters
-
$filterGroup FilterGroup
- Returns
- integer the new filter group id
Definition at line 27 of file FilterGroupDAO.inc.php.
References getInsertId(), and DAO\update().
◆ newDataObject()
| FilterGroupDAO::newDataObject | ( | ) |
Construct and return a new data object
- Returns
- DataObject
Definition at line 176 of file FilterGroupDAO.inc.php.
Referenced by _fromRow().
◆ updateObject()
| FilterGroupDAO::updateObject | ( | & | $filterGroup | ) |
Update an existing filter group.
- Parameters
-
$filterGroup FilterGroup
Definition at line 95 of file FilterGroupDAO.inc.php.
References DAO\update().
The documentation for this class was generated from the following file:
