Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionFileDAODelegate Class Reference
Inheritance diagram for SubmissionFileDAODelegate:
DAO MonographFileDAODelegate SubmissionArtworkFileDAODelegate ArtworkFileDAODelegate

Public Member Functions

 _deleteDependentObjects ($submissionFile)
 
 _updateDependentObjects ($submissionFile, $previousFile)
 
 deleteObject ($submissionFile)
 
 fromRow ($row)
 
 getLocaleFieldNames ()
 
 getSubmissionEntityName ()
 
 insertObject (&$submissionFile, $sourceFile, $isUpload=false)
 
 newDataObject ()
 
 SubmissionFileDAODelegate ()
 
 updateLocaleFields (&$submissionFile)
 
 updateObject ($submissionFile, $previousFile)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getType ($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)
 
- Public Attributes 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 20 of file SubmissionFileDAODelegate.inc.php.

Member Function Documentation

SubmissionFileDAODelegate::_deleteDependentObjects (   $submissionFile)

Delete all objects that depend on the given file.

Parameters
$submissionFileSubmissionFile

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

References DAORegistry\getDAO().

Referenced by deleteObject().

SubmissionFileDAODelegate::_updateDependentObjects (   $submissionFile,
  $previousFile 
)

Update all objects that depend on the given file.

Parameters
$submissionFileSubmissionFile
$previousFileSubmissionFile

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

References DAORegistry\getDAO().

Referenced by updateObject().

SubmissionFileDAODelegate::deleteObject (   $submissionFile)

Delete a submission file from the database.

Parameters
$submissionFileSubmissionFile
Returns
boolean

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

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

Referenced by insertObject().

SubmissionFileDAODelegate::fromRow (   $row)

Function to return a SubmissionFile object from a row.

Parameters
$rowarray
Returns
SubmissionFile

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

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

SubmissionFileDAODelegate::getLocaleFieldNames ( )

Get the list of fields for which data is localized.

Returns
array

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

SubmissionFileDAODelegate::getSubmissionEntityName ( )

Return the name of the base submission entity (i.e. 'monograph', 'paper', 'article', etc.)

Returns
string

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

Referenced by updateLocaleFields().

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

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

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

SubmissionFileDAODelegate::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
SubmissionFile

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

Referenced by fromRow().

SubmissionFileDAODelegate::SubmissionFileDAODelegate ( )

Constructor

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

SubmissionFileDAODelegate::updateLocaleFields ( $submissionFile)

Update the localized fields for this submission file.

Parameters
$submissionFileSubmissionFile

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

References getSubmissionEntityName(), and DAO\updateDataObjectSettings().

Referenced by insertObject(), and 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

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

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


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