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

Public Member Functions

_fromRow (&$row)
 
 deleteObject (&$filterGroup)
 
 deleteObjectById ($filterGroupId)
 
 deleteObjectBySymbolic ($filterGroupSymbolic)
 
 FilterGroupDAO ()
 
 getInsertId ()
 
getObject (&$filterGroup)
 
getObjectById ($filterGroupId)
 
getObjectBySymbolic ($filterGroupSymbolic)
 
 insertObject (&$filterGroup)
 
 newDataObject ()
 
 updateObject (&$filterGroup)
 
- 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 FilterGroup objects.

See Also
FilterGroup

Definition at line 19 of file FilterGroupDAO.inc.php.

Member Function Documentation

& FilterGroupDAO::_fromRow ( $row)

Internal function to return a filter group object from a row.

Parameters
$rowarray
Returns
FilterGroup

Definition at line 201 of file FilterGroupDAO.inc.php.

References newDataObject().

Referenced by getObjectById(), and getObjectBySymbolic().

FilterGroupDAO::deleteObject ( $filterGroup)

Delete a filter group (only works if there are not more filters in this group).

Parameters
$filterGroupFilterGroup
Returns
boolean

Definition at line 130 of file FilterGroupDAO.inc.php.

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

Referenced by deleteObjectById(), and deleteObjectBySymbolic().

FilterGroupDAO::deleteObjectById (   $filterGroupId)

Delete a filter group by id.

Parameters
$filterGroupIdint
Returns
boolean

Definition at line 152 of file FilterGroupDAO.inc.php.

References deleteObject(), and getObjectById().

FilterGroupDAO::deleteObjectBySymbolic (   $filterGroupSymbolic)

Delete a filter group by symbolic name.

Parameters
$filterGroupSymbolicstring
Returns
boolean

Definition at line 164 of file FilterGroupDAO.inc.php.

References deleteObject(), and getObjectBySymbolic().

FilterGroupDAO::FilterGroupDAO ( )

Constructor

Definition at line 23 of file FilterGroupDAO.inc.php.

FilterGroupDAO::getInsertId ( )

Get the ID of the last inserted filter group.

Returns
int

Definition at line 178 of file FilterGroupDAO.inc.php.

Referenced by insertObject().

& FilterGroupDAO::getObject ( $filterGroup)

Retrieve a filter group

Parameters
$filterGroupFilterGroup
Returns
FilterGroup

Definition at line 55 of file FilterGroupDAO.inc.php.

References getObjectById().

& FilterGroupDAO::getObjectById (   $filterGroupId)

Retrieve a configured filter group by id.

Parameters
$filterGroupIdinteger
Returns
FilterGroup

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

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

Referenced by deleteObjectById(), and getObject().

& FilterGroupDAO::getObjectBySymbolic (   $filterGroupSymbolic)

Retrieve a configured filter group by its symbolic representation.

Parameters
$filterGroupSymbolicstring
Returns
FilterGroup

Definition at line 85 of file FilterGroupDAO.inc.php.

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

Referenced by deleteObjectBySymbolic().

FilterGroupDAO::insertObject ( $filterGroup)

Insert a new filter group.

Parameters
$filterGroupFilterGroup
Returns
integer the new filter group id

Definition at line 33 of file FilterGroupDAO.inc.php.

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

FilterGroupDAO::newDataObject ( )

Construct and return a new data object

Returns
DataObject

Definition at line 186 of file FilterGroupDAO.inc.php.

Referenced by _fromRow().

FilterGroupDAO::updateObject ( $filterGroup)

Update an existing filter group.

Parameters
$filterGroupFilterGroup

Definition at line 105 of file FilterGroupDAO.inc.php.

References DAO\update().


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