Open Journal Systems  3.3.0
PKPSectionDAO Class Reference
Inheritance diagram for PKPSectionDAO:
DAO SectionDAO

Public Member Functions

 _fromRow ($row)
 
 deleteByContextId ($contextId)
 
 deleteById ($sectionId, $contextId=null)
 
 deleteObject ($section)
 
 getByContextId ($contextId, $rangeInfo=null, $submittableOnly=false)
 
 getById ($sectionId, $contextId=null)
 
 getLocaleFieldNames ()
 
 getTitlesByContextId ($contextId, $submittableOnly=false)
 
 newDataObject ()
 
- 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 Section objects.

See also
PKPSection

Definition at line 17 of file PKPSectionDAO.inc.php.

Member Function Documentation

◆ _fromRow()

PKPSectionDAO::_fromRow (   $row)

Generate a new PKPSection object from row.

Parameters
$rowarray
Returns
PKPSection

Reimplemented in SectionDAO.

Definition at line 39 of file PKPSectionDAO.inc.php.

References newDataObject().

◆ deleteByContextId()

PKPSectionDAO::deleteByContextId (   $contextId)

Delete sections by context ID NOTE: This does not necessarily delete dependent entries.

Parameters
$contextIdint

Definition at line 77 of file PKPSectionDAO.inc.php.

References deleteObject(), and getByContextId().

Referenced by SectionDAO\deleteByJournalId().

◆ deleteById()

PKPSectionDAO::deleteById (   $sectionId,
  $contextId = null 
)
abstract

Delete a section by ID.

Parameters
$sectionIdint
$journalIdint optional

Reimplemented in SectionDAO.

Referenced by deleteObject().

◆ deleteObject()

PKPSectionDAO::deleteObject (   $section)

Delete a section.

Parameters
$sectionSection

Definition at line 61 of file PKPSectionDAO.inc.php.

References deleteById().

Referenced by deleteByContextId().

◆ getByContextId()

PKPSectionDAO::getByContextId (   $contextId,
  $rangeInfo = null,
  $submittableOnly = false 
)
abstract

Retrieve all sections for a context.

Parameters
$contextIdint context ID
$rangeInfoDBResultRange optional
$submittableOnlyboolean optional. Whether to return only sections that can be submitted to by anyone.
Returns
DAOResultFactory containing Sections ordered by sequence

Reimplemented in SectionDAO.

Referenced by deleteByContextId(), and getTitlesByContextId().

◆ getById()

PKPSectionDAO::getById (   $sectionId,
  $contextId = null 
)
abstract

Retrieve a section by ID.

Parameters
$sectionIdint
$journalIdint optional
$useCacheboolean optional
Returns
Section

◆ getLocaleFieldNames()

PKPSectionDAO::getLocaleFieldNames ( )

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

Returns
array

Reimplemented from DAO.

Reimplemented in SectionDAO.

Definition at line 53 of file PKPSectionDAO.inc.php.

◆ getTitlesByContextId()

PKPSectionDAO::getTitlesByContextId (   $contextId,
  $submittableOnly = false 
)

Retrieve the IDs and titles of the sections for a context in an associative array.

Parameters
$contextIdint context ID
$submittableOnlyboolean optional. Whether to return only sections that can be submitted to by anyone.
Returns
array

Definition at line 101 of file PKPSectionDAO.inc.php.

References getByContextId().

◆ newDataObject()

PKPSectionDAO::newDataObject ( )
abstract

Create a new data object.

Returns
PKPSection

Reimplemented in SectionDAO.

Referenced by _fromRow().


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