Open Journal Systems  3.3.0
JournalDAO Class Reference
Inheritance diagram for JournalDAO:
ContextDAO SchemaDAO DAO

Public Member Functions

 anyPubIdExists ($journalId, $pubIdType, $pubId, $assocType=ASSOC_TYPE_ANY, $assocId=0, $forSameType=false)
 
 deleteAllPubIds ($journalId, $pubIdType)
 
 getTitles ($enabledOnly=false)
 
 newDataObject ()
 
- Public Member Functions inherited from ContextDAO
 existsByPath ($path)
 
 getAll ($enabledOnly=false, $rangeInfo=null)
 
 getAvailable ($userId=null, $rangeInfo=null)
 
 getByPath ($path)
 
 getBySetting ($settingName, $settingValue, $contextId=null)
 
 getLocaleFieldNames ()
 
 getNames ($enabledOnly=false)
 
 resequence ()
 
- Public Member Functions inherited from SchemaDAO
 _fromRow ($primaryRow)
 
 deleteById ($objectId)
 
 deleteObject ($object)
 
 getById ($objectId)
 
 getInsertId ()
 
 insertObject ($object)
 
 updateObject ($object)
 
- 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)
 

Data Fields

 $primaryKeyColumn = 'journal_id'
 
 $primaryTableColumns
 
 $schemaName = 'context'
 
 $settingsTableName = 'journal_settings'
 
 $tableName = 'journals'
 
- Data Fields inherited from SchemaDAO
 $primaryKeyColumn
 
 $primaryTableColumns = array()
 
 $schemaName
 
 $settingsTableName
 
 $tableName
 
- Data Fields inherited from DAO
 $_dataSource
 

Additional Inherited Members

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

Detailed Description

Operations for retrieving and modifying Journal objects.

See also
Journal

Definition at line 24 of file JournalDAO.inc.php.

Member Function Documentation

◆ anyPubIdExists()

JournalDAO::anyPubIdExists (   $journalId,
  $pubIdType,
  $pubId,
  $assocType = ASSOC_TYPE_ANY,
  $assocId = 0,
  $forSameType = false 
)

Check whether the given public ID exists for any publishing object in a journal.

Parameters
$journalIdint
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubIdstring
$assocTypeint The object type of an object to be excluded from the search. Identified by one of the ASSOC_TYPE_* constants.
$assocIdint The id of an object to be excluded from the search.
$forSameTypeboolean Whether only the same objects should be considered.
Returns
boolean

Definition at line 104 of file JournalDAO.inc.php.

References DAORegistry\getDAO(), and Application\getRepresentationDAO().

◆ deleteAllPubIds()

JournalDAO::deleteAllPubIds (   $journalId,
  $pubIdType 
)

Delete the public IDs of all publishing objects in a journal.

Parameters
$journalIdint
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).

Definition at line 78 of file JournalDAO.inc.php.

References DAORegistry\getDAO().

◆ getTitles()

JournalDAO::getTitles (   $enabledOnly = false)

Retrieve the IDs and titles of all journals in an associative array.

Returns
array

Definition at line 62 of file JournalDAO.inc.php.

References ContextDAO\getAll().

◆ newDataObject()

JournalDAO::newDataObject ( )

Create a new DataObject of the appropriate class

Returns
DataObject

Reimplemented from SchemaDAO.

Definition at line 54 of file JournalDAO.inc.php.

Field Documentation

◆ $primaryKeyColumn

JournalDAO::$primaryKeyColumn = 'journal_id'

The column name for the object id in primary and settings tables

Definition at line 35 of file JournalDAO.inc.php.

◆ $primaryTableColumns

array JournalDAO::$primaryTableColumns
Initial value:
= [
'id' => 'journal_id',
'urlPath' => 'path',
'enabled' => 'enabled',
'seq' => 'seq',
'primaryLocale' => 'primary_locale',
]

Maps schema properties for the primary table to their column names

Definition at line 41 of file JournalDAO.inc.php.

◆ $schemaName

JournalDAO::$schemaName = 'context'

One of the SCHEMA_... constants

Definition at line 26 of file JournalDAO.inc.php.

◆ $settingsTableName

JournalDAO::$settingsTableName = 'journal_settings'

The name of the settings table for this object

Definition at line 32 of file JournalDAO.inc.php.

◆ $tableName

JournalDAO::$tableName = 'journals'

The name of the primary table for this object

Definition at line 29 of file JournalDAO.inc.php.


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