Open Journal Systems  3.3.0
SubmissionFileDAODelegate Class Reference
Inheritance diagram for SubmissionFileDAODelegate:
DAO SubmissionArtworkFileDAODelegate SupplementaryFileDAODelegate

Public Member Functions

 _deleteDependentObjects ($submissionFile)
 
 _updateDependentObjects ($submissionFile, $previousFile)
 
 changePubId ($pubObjectId, $pubIdType, $pubId)
 
 deleteAllPubIds ($contextId, $pubIdType)
 
 deleteObject ($submissionFile)
 
 deletePubId ($pubObjectId, $pubIdType)
 
 fromRow ($row)
 
 getAdditionalFieldNames ()
 
 getLocaleFieldNames ()
 
 insertObject ($submissionFile, $sourceFile, $isUpload=false)
 
 newDataObject ()
 
 pubIdExists ($pubIdType, $pubId, $excludePubObjectId, $contextId)
 
 updateLocaleFields ($submissionFile)
 
 updateObject ($submissionFile, $previousFile)
 
- 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)
 
 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

Abstract class to support DAO delegates that provide operations to retrieve and modify SubmissionFile objects.

See also
SubmissionFile

Definition at line 21 of file SubmissionFileDAODelegate.inc.php.

Member Function Documentation

◆ _deleteDependentObjects()

SubmissionFileDAODelegate::_deleteDependentObjects (   $submissionFile)

Delete all objects that depend on the given file.

Parameters
$submissionFileSubmissionFile

Definition at line 438 of file SubmissionFileDAODelegate.inc.php.

References DAORegistry\getDAO().

Referenced by deleteObject().

◆ _updateDependentObjects()

SubmissionFileDAODelegate::_updateDependentObjects (   $submissionFile,
  $previousFile 
)

Update all objects that depend on the given file.

Parameters
$submissionFileSubmissionFile
$previousFileSubmissionFile

Definition at line 418 of file SubmissionFileDAODelegate.inc.php.

References DAORegistry\getDAO().

Referenced by updateObject().

◆ changePubId()

SubmissionFileDAODelegate::changePubId (   $pubObjectId,
  $pubIdType,
  $pubId 
)

Change the public ID of a submission.

Parameters
$pubObjectIdint ID of the pub object
$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

Definition at line 356 of file SubmissionFileDAODelegate.inc.php.

References DAO\flushCache(), and DAO\replace().

◆ deleteAllPubIds()

SubmissionFileDAODelegate::deleteAllPubIds (   $contextId,
  $pubIdType 
)

Delete the public IDs of all submissions in this context.

Parameters
$contextIdint
$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 389 of file SubmissionFileDAODelegate.inc.php.

References DAO\flushCache(), DAORegistry\getDAO(), and DAO\update().

◆ deleteObject()

SubmissionFileDAODelegate::deleteObject (   $submissionFile)

Delete a submission file from the database.

Parameters
$submissionFileSubmissionFile
Returns
boolean

Reimplemented in SubmissionArtworkFileDAODelegate, and SupplementaryFileDAODelegate.

Definition at line 210 of file SubmissionFileDAODelegate.inc.php.

References _deleteDependentObjects(), DAO\retrieve(), and DAO\update().

Referenced by insertObject().

◆ deletePubId()

SubmissionFileDAODelegate::deletePubId (   $pubObjectId,
  $pubIdType 
)

Delete the public ID of a submission.

Parameters
$pubObjectIdint ID of the pub object
$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 374 of file SubmissionFileDAODelegate.inc.php.

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

◆ fromRow()

SubmissionFileDAODelegate::fromRow (   $row)

Function to return a SubmissionFile object from a row.

Parameters
$rowarray
Returns
SubmissionFile

Reimplemented in SubmissionArtworkFileDAODelegate.

Definition at line 251 of file SubmissionFileDAODelegate.inc.php.

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

◆ getAdditionalFieldNames()

SubmissionFileDAODelegate::getAdditionalFieldNames ( )

Get a list of additional fields that do not have dedicated accessors.

Returns
array

Reimplemented from DAO.

Reimplemented in SupplementaryFileDAODelegate.

Definition at line 305 of file SubmissionFileDAODelegate.inc.php.

◆ getLocaleFieldNames()

SubmissionFileDAODelegate::getLocaleFieldNames ( )

Get the list of fields for which data is localized.

Returns
array

Reimplemented from DAO.

Reimplemented in SupplementaryFileDAODelegate.

Definition at line 294 of file SubmissionFileDAODelegate.inc.php.

◆ insertObject()

SubmissionFileDAODelegate::insertObject (   $submissionFile,
  $sourceFile,
  $isUpload = false 
)

Insert a new submission file.

Parameters
$submissionFileSubmissionFile
$sourceFilestring The place where the physical file resides right now or the file name in the case of an upload. The file will be copied to its canonical target location.
$isUploadboolean set to true if the file has just been uploaded.
Returns
SubmissionFile the inserted file

Reimplemented in SupplementaryFileDAODelegate, and SubmissionArtworkFileDAODelegate.

Definition at line 36 of file SubmissionFileDAODelegate.inc.php.

References DAO\_getInsertId(), DAO\datetimeToDB(), deleteObject(), DAO\update(), and updateLocaleFields().

◆ newDataObject()

SubmissionFileDAODelegate::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
SubmissionFile

Reimplemented in SubmissionArtworkFileDAODelegate, and SupplementaryFileDAODelegate.

Definition at line 282 of file SubmissionFileDAODelegate.inc.php.

Referenced by fromRow().

◆ pubIdExists()

SubmissionFileDAODelegate::pubIdExists (   $pubIdType,
  $pubId,
  $excludePubObjectId,
  $contextId 
)

Checks if public identifier exists (other than for the specified submission file ID, which is treated as an exception).

Parameters
$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
$fileIdint An ID to be excluded from the search.
$contextIdint
Returns
boolean

Definition at line 334 of file SubmissionFileDAODelegate.inc.php.

References DAO\retrieve().

◆ updateLocaleFields()

SubmissionFileDAODelegate::updateLocaleFields (   $submissionFile)

Update the localized fields for this submission file.

Parameters
$submissionFileSubmissionFile

Definition at line 316 of file SubmissionFileDAODelegate.inc.php.

References DAO\updateDataObjectSettings().

Referenced by insertObject(), and updateObject().

◆ updateObject()

SubmissionFileDAODelegate::updateObject (   $submissionFile,
  $previousFile 
)

Update a submission file.

Parameters
$submissionFileSubmissionFile The target state of the updated file.
$previousFileSubmissionFile The current state of the updated file.
Returns
boolean

Reimplemented in SupplementaryFileDAODelegate, and SubmissionArtworkFileDAODelegate.

Definition at line 136 of file SubmissionFileDAODelegate.inc.php.

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


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