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

Public Member Functions

 _fromRow ($row)
 
 categoryExistsByPath ($path, $contextId=null)
 
 deleteByContextId ($contextId)
 
 deleteById ($categoryId, $contextId=null)
 
 deleteObject ($category)
 
 FooterCategoryDAO ()
 
 getByContextId ($contextId, $rangeInfo=null)
 
 getById ($categoryId, $contextId=null)
 
 getByPath ($path, $contextId)
 
 getCountByContextId ($contextId)
 
 getInsertId ()
 
 getLocaleFieldNames ()
 
 getNotEmptyByContextId ($contextId, $rangeInfo=null)
 
 insertObject ($category)
 
 newDataObject ()
 
 updateLocaleFields ($category)
 
 updateObject ($category)
 
- 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 FooterCategory objects.

See Also
FooterCategory

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

Member Function Documentation

FooterCategoryDAO::_fromRow (   $row)

Internal function to return a FooterCategory object from a row.

Parameters
$rowarray
Returns
FooterCategory

Definition at line 109 of file FooterCategoryDAO.inc.php.

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

Referenced by getById(), and getByPath().

FooterCategoryDAO::categoryExistsByPath (   $path,
  $contextId = null 
)

Check if a category exists with a specified path.

Parameters
$pathstring the path for the category
$contextIdint the context (optional)
Returns
boolean

Definition at line 81 of file FooterCategoryDAO.inc.php.

References DAO\retrieve().

FooterCategoryDAO::deleteByContextId (   $contextId)

Delete category 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 231 of file FooterCategoryDAO.inc.php.

References deleteObject(), and getByContextId().

FooterCategoryDAO::deleteById (   $categoryId,
  $contextId = null 
)

Delete a category by ID.

Parameters
$categoryIdint
$contextIdint optional

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

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

Referenced by deleteObject().

FooterCategoryDAO::deleteObject (   $category)

Delete a category.

Parameters
$categoryFooterCategory

Definition at line 190 of file FooterCategoryDAO.inc.php.

References deleteById().

Referenced by deleteByContextId().

FooterCategoryDAO::FooterCategoryDAO ( )

Constructor

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

FooterCategoryDAO::getByContextId (   $contextId,
  $rangeInfo = null 
)

Retrieve all categories for a context.

Parameters
$contextIdint Context ID
$rangeInfoObject Optional range info for results paging
Returns
DAOResultFactory containing FooterCategory ordered by sequence

Definition at line 244 of file FooterCategoryDAO.inc.php.

References DAO\retrieveRange().

Referenced by deleteByContextId().

FooterCategoryDAO::getById (   $categoryId,
  $contextId = null 
)

Retrieve a category by ID.

Parameters
$categoryIdint
$contextIdint optional
Returns
FooterCategory

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

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

FooterCategoryDAO::getByPath (   $path,
  $contextId 
)

Retrieve a category by path.

Parameters
$pathstring
$contextIdint
Returns
FooterCategory

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

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

FooterCategoryDAO::getCountByContextId (   $contextId)

Retrieve the number of categories for a context.

Returns
int

Definition at line 274 of file FooterCategoryDAO.inc.php.

References DAO\retrieve().

FooterCategoryDAO::getInsertId ( )

Get the ID of the last inserted category.

Returns
int

Definition at line 292 of file FooterCategoryDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

FooterCategoryDAO::getLocaleFieldNames ( )

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

Returns
array

Definition at line 127 of file FooterCategoryDAO.inc.php.

FooterCategoryDAO::getNotEmptyByContextId (   $contextId,
  $rangeInfo = null 
)

Retrieve all categories for a context that have links.

Returns
DAOResultFactory containing FooterCategory ordered by sequence

Definition at line 259 of file FooterCategoryDAO.inc.php.

References DAO\retrieveRange().

FooterCategoryDAO::insertObject (   $category)

Insert a new category.

Parameters
$categoryFooterCategory
Returns
int ID of the inserted category.

Definition at line 149 of file FooterCategoryDAO.inc.php.

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

FooterCategoryDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
FooterCategory

Definition at line 100 of file FooterCategoryDAO.inc.php.

Referenced by _fromRow().

FooterCategoryDAO::updateLocaleFields (   $category)

Update the localized fields for this table

Parameters
$categoryobject

Definition at line 135 of file FooterCategoryDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

FooterCategoryDAO::updateObject (   $category)

Update an existing category.

Parameters
$categoryFooterCategory

Definition at line 170 of file FooterCategoryDAO.inc.php.

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


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