Open Journal Systems  3.3.0
StaticPagesDAO Class Reference
Inheritance diagram for StaticPagesDAO:
DAO

Public Member Functions

 _fromRow ($row)
 
 deleteById ($staticPageId)
 
 deleteObject ($staticPage)
 
 getByContextId ($contextId, $rangeInfo=null)
 
 getById ($staticPageId, $contextId=null)
 
 getByPath ($contextId, $path)
 
 getInsertId ()
 
 getLocaleFieldNames ()
 
 insertObject ($staticPage)
 
 newDataObject ()
 
 updateLocaleFields (&$staticPage)
 
 updateObject ($staticPage)
 
- 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 StaticPages objects.

Definition at line 18 of file StaticPagesDAO.inc.php.

Member Function Documentation

◆ _fromRow()

StaticPagesDAO::_fromRow (   $row)

Return a new static pages object from a given row.

Returns
StaticPage

Definition at line 153 of file StaticPagesDAO.inc.php.

References DAO\getDataObjectSettings(), and newDataObject().

Referenced by getById(), and getByPath().

◆ deleteById()

StaticPagesDAO::deleteById (   $staticPageId)

Delete a static page by ID.

Parameters
$staticPageIdint

Definition at line 122 of file StaticPagesDAO.inc.php.

References DAO\update().

Referenced by deleteObject().

◆ deleteObject()

StaticPagesDAO::deleteObject (   $staticPage)

Delete a static page object.

Parameters
$staticPageStaticPage

Definition at line 137 of file StaticPagesDAO.inc.php.

References deleteById().

◆ getByContextId()

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

Get a set of static pages by context ID

Parameters
$contextIdint
$rangeInfoObject optional
Returns
DAOResultFactory

Definition at line 49 of file StaticPagesDAO.inc.php.

References DAO\retrieveRange().

◆ getById()

StaticPagesDAO::getById (   $staticPageId,
  $contextId = null 
)

Get a static page by ID

Parameters
$staticPageIdint Static page ID
$contextIdint Optional context ID

Definition at line 25 of file StaticPagesDAO.inc.php.

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

◆ getByPath()

StaticPagesDAO::getByPath (   $contextId,
  $path 
)

Get a static page by path.

Parameters
$contextIdint Context ID
$pathstring Path
Returns
StaticPage

Definition at line 65 of file StaticPagesDAO.inc.php.

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

◆ getInsertId()

StaticPagesDAO::getInsertId ( )

Get the insert ID for the last inserted static page.

Returns
int

Definition at line 167 of file StaticPagesDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLocaleFieldNames()

StaticPagesDAO::getLocaleFieldNames ( )

Get field names for which data is localized.

Returns
array

Reimplemented from DAO.

Definition at line 175 of file StaticPagesDAO.inc.php.

◆ insertObject()

StaticPagesDAO::insertObject (   $staticPage)

Insert a static page.

Parameters
$staticPageStaticPage
Returns
int Inserted static page ID

Definition at line 84 of file StaticPagesDAO.inc.php.

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

◆ newDataObject()

StaticPagesDAO::newDataObject ( )

Generate a new static page object.

Returns
StaticPage

Definition at line 145 of file StaticPagesDAO.inc.php.

Referenced by _fromRow().

◆ updateLocaleFields()

StaticPagesDAO::updateLocaleFields ( $staticPage)

Update the localized data for this object

Parameters
$authorobject

Definition at line 183 of file StaticPagesDAO.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

StaticPagesDAO::updateObject (   $staticPage)

Update the database with a static page object

Parameters
$staticPageStaticPage

Definition at line 103 of file StaticPagesDAO.inc.php.

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


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