Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FooterLinkDAO Class Reference
Inheritance diagram for FooterLinkDAO:
DAO

Public Member Functions

 _fromRow ($row)
 
 deleteByContextId ($contextId)
 
 deleteById ($footerLinkId, $contextId=null)
 
 deleteObject ($footerLink)
 
 FooterLinkDAO ()
 
 getByCategoryId ($categoryId, $contextId=null, $rangeInfo=null)
 
 getById ($footerLinkId, $contextId=null)
 
 getInsertId ()
 
 getLargestCategoryTotalByContextId ($contextId)
 
 getLocaleFieldNames ()
 
 insertObject ($footerLink)
 
 newDataObject ()
 
 updateLocaleFields ($footerLink)
 
 updateObject ($footerLink)
 
- 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 ()
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 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

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

Detailed Description

Operations for retrieving and modifying FooterLink objects.

See Also
FooterLink

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

Member Function Documentation

FooterLinkDAO::_fromRow (   $row)

Internal function to return an FooterLink object from a row.

Parameters
$rowarray
Returns
FooterLink

Definition at line 67 of file FooterLinkDAO.inc.php.

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

Referenced by getById().

FooterLinkDAO::deleteByContextId (   $contextId)

Delete footer link by context ID. NOTE: This does not delete dependent entries. It is intended to be called only when deleting a context.

Parameters
$contextIdint

Definition at line 191 of file FooterLinkDAO.inc.php.

References deleteObject().

FooterLinkDAO::deleteById (   $footerLinkId,
  $contextId = null 
)

Delete a footer link by ID.

Parameters
$footerLinkIdint
$contextIdint optional

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

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

Referenced by deleteObject().

FooterLinkDAO::deleteObject (   $footerLink)

Delete a link.

Parameters
$footerLinkFooterLink

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

References deleteById().

Referenced by deleteByContextId().

FooterLinkDAO::FooterLinkDAO ( )

Constructor

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

FooterLinkDAO::getByCategoryId (   $categoryId,
  $contextId = null,
  $rangeInfo = null 
)

Retrieve all footerlinks for a footer category.

Returns
DAOResultFactory containing FooterLink objects

Definition at line 202 of file FooterLinkDAO.inc.php.

References DAO\retrieveRange().

FooterLinkDAO::getById (   $footerLinkId,
  $contextId = null 
)

Retrieve a footer link by ID.

Parameters
$footerLinkIdint
$contextIdint optional
Returns
FooterLink

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

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

FooterLinkDAO::getInsertId ( )

Get the ID of the last inserted link.

Returns
int

Definition at line 222 of file FooterLinkDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

FooterLinkDAO::getLargestCategoryTotalByContextId (   $contextId)

Retrieve the maximum number of links in any category, by context ID.

Parameters
int$contextId
Returns
int

Definition at line 231 of file FooterLinkDAO.inc.php.

References DAO\retrieve().

FooterLinkDAO::getLocaleFieldNames ( )

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

Returns
array

Definition at line 86 of file FooterLinkDAO.inc.php.

FooterLinkDAO::insertObject (   $footerLink)

Insert a new footer link.

Parameters
$footerLinkFooterLink
Returns
int ID of the inserted link.

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

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

FooterLinkDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
FooterLink

Definition at line 58 of file FooterLinkDAO.inc.php.

Referenced by _fromRow().

FooterLinkDAO::updateLocaleFields (   $footerLink)

Update the localized fields for this table

Parameters
$footerLinkobject

Definition at line 94 of file FooterLinkDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

FooterLinkDAO::updateObject (   $footerLink)

Update an existing link.

Parameters
$footerLinkFooterLink

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

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


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