ocs  2.3.6
About: OCS (Open Conference System) is a Web publishing tool that will create a complete Web presence for your scholarly conference.
  Fossies Dox: ocs-2.3.6.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

PaperFileDAO Class Reference

Operations for retrieving and modifying PaperFile objects. More...

Inheritance diagram for PaperFileDAO:
Collaboration diagram for PaperFileDAO:

Public Member Functions

getPaperFile ($fileId, $revision=null, $paperId=null)
 
getPaperFileRevisions ($fileId, $stage=null)
 
getPaperFileRevisionsInRange ($fileId, $start=1, $end=null)
 
getRevisionNumber ($fileId)
 
getPaperFilesByPaper ($paperId)
 
_returnPaperFileFromRow (&$row)
 
 insertPaperFile (&$paperFile)
 
 updatePaperFile (&$paperFile)
 
 deletePaperFile (&$paperFile)
 
 deletePaperFileById ($fileId, $revision=null)
 
 deletePaperFiles ($paperId)
 
 getInsertPaperFileId ()
 
 isInlineable (&$paperFile)
 
- Public Member Functions inherited from DAO
 DAO ($dataSource=null, $callHooks=true)
 
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)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 replace ($table, $arrFields, $keyCols)
 
 getInsertId ($table='', $id='', $callHooks=true)
 
 setCacheDir ()
 
 flushCache ()
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 datetimeFromDB ($dt)
 
 dateFromDB ($d)
 
 convertFromDB ($value, $type)
 
 getType ($value)
 
 convertToDB ($value, &$type)
 
 nullOrInt ($value)
 
 getAdditionalFieldNames ()
 
 getLocaleFieldNames ()
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, &$dataObject)
 
 getDriver ()
 
 getDirectionMapping ($direction)
 

Public Attributes

 $inlineableTypes
 
- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying PaperFile objects.

See also
PaperFile

Definition at line 20 of file PaperFileDAO.inc.php.

Member Function Documentation

◆ _returnPaperFileFromRow()

& PaperFileDAO::_returnPaperFileFromRow ( $row)

Internal function to return an PaperFile object from a row.

Parameters
$rowarray
Returns
PaperFile

Definition at line 203 of file PaperFileDAO.inc.php.

References HookRegistry\call(), and DAO\datetimeFromDB().

Referenced by getPaperFile(), getPaperFileRevisions(), getPaperFileRevisionsInRange(), and getPaperFilesByPaper().

◆ deletePaperFile()

PaperFileDAO::deletePaperFile ( $paperFile)

Delete a paper file.

Parameters
$paperPaperFile

Definition at line 302 of file PaperFileDAO.inc.php.

References deletePaperFileById().

◆ deletePaperFileById()

PaperFileDAO::deletePaperFileById (   $fileId,
  $revision = null 
)

Delete a paper file by ID.

Parameters
$paperIdint
$revisionint

Definition at line 311 of file PaperFileDAO.inc.php.

References DAO\update().

Referenced by deletePaperFile().

◆ deletePaperFiles()

PaperFileDAO::deletePaperFiles (   $paperId)

Delete all paper files for a paper.

Parameters
$paperIdint

Definition at line 327 of file PaperFileDAO.inc.php.

References DAO\update().

◆ getInsertPaperFileId()

PaperFileDAO::getInsertPaperFileId ( )

Get the ID of the last inserted paper file.

Returns
int

Definition at line 337 of file PaperFileDAO.inc.php.

References DAO\getInsertId().

Referenced by insertPaperFile().

◆ getPaperFile()

& PaperFileDAO::getPaperFile (   $fileId,
  $revision = null,
  $paperId = null 
)

Retrieve a paper by ID.

Parameters
$fileIdint
$revisionint optional, if omitted latest revision is used
$paperIdint optional
Returns
PaperFile

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

References _returnPaperFileFromRow(), DAO\retrieve(), and DAO\retrieveLimit().

◆ getPaperFileRevisions()

& PaperFileDAO::getPaperFileRevisions (   $fileId,
  $stage = null 
)

Retrieve all revisions of a paper file.

Parameters
$paperIdint
Returns
PaperFile

Definition at line 83 of file PaperFileDAO.inc.php.

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

◆ getPaperFileRevisionsInRange()

& PaperFileDAO::getPaperFileRevisionsInRange (   $fileId,
  $start = 1,
  $end = null 
)

Retrieve revisions of a paper file in a range.

Parameters
$paperIdint
Returns
PaperFile

Definition at line 116 of file PaperFileDAO.inc.php.

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

◆ getPaperFilesByPaper()

& PaperFileDAO::getPaperFilesByPaper (   $paperId)

Retrieve all paper files for a paper.

Parameters
$paperIdint
Returns
array PaperFiles

Definition at line 179 of file PaperFileDAO.inc.php.

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

◆ getRevisionNumber()

& PaperFileDAO::getRevisionNumber (   $fileId)

Retrieve the current revision number for a file.

Parameters
$fileIdint
Returns
int

Definition at line 151 of file PaperFileDAO.inc.php.

References DAO\retrieve().

◆ insertPaperFile()

PaperFileDAO::insertPaperFile ( $paperFile)

Insert a new PaperFile.

Parameters
$paperFilePaperFile
Returns
int

Definition at line 226 of file PaperFileDAO.inc.php.

References DAO\datetimeToDB(), getInsertPaperFileId(), and DAO\update().

◆ isInlineable()

PaperFileDAO::isInlineable ( $paperFile)

Check whether a file may be displayed inline.

Parameters
$paperFileobject
Returns
boolean

Definition at line 346 of file PaperFileDAO.inc.php.

References $inlineableTypes, and Config\getVar().

◆ updatePaperFile()

PaperFileDAO::updatePaperFile ( $paperFile)

Update an existing paper file.

Parameters
$paperPaperFile

Definition at line 264 of file PaperFileDAO.inc.php.

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

Member Data Documentation

◆ $inlineableTypes

PaperFileDAO::$inlineableTypes

Array of MIME types that can be displayed inline in a browser

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

Referenced by isInlineable().


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