Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionFileSignoffDAO Class Reference
Inheritance diagram for SubmissionFileSignoffDAO:
SignoffDAO DAO

Public Member Functions

 build ($symbolic, $submissionFileId, $userId=null, $userGroupId=null, $fileId=null, $fileRevision=null)
 
 getAllBySubmission ($submissionId, $symbolic=null, $userId=null, $userGroupId=null, $notCompletedOnly=false)
 
 getAllBySymbolic ($symbolic, $submissionFileId=null, $userId=null, $userGroupId=null)
 
 getById ($signoffId)
 
 getBySymbolic ($symbolic, $submissionFileId, $userId=null, $userGroupId=null, $fileId=null, $fileRevision=null)
 
 newDataObject ()
 
 signoffExists ($symbolic, $submissionFileId, $userId=null, $userGroupId=null)
 
 SubmissionFileSignoffDAO ()
 
- Public Member Functions inherited from SignoffDAO
 _fromRow ($row)
 
 _getAllInternally ($symbolic=null, $assocType=null, $assocId=null, $userId=null, $userGroupId=null)
 
 build ($symbolic, $assocType, $assocId, $userId=null, $userGroupId=null, $fileId=null, $fileRevision=null)
 
 deleteObject ($signoff)
 
 deleteObjectById ($signoffId)
 
 getAllByAssocType ($assocType, $assocId, $symbolic=null, $userId=null, $userGroupId=null)
 
 getAllBySymbolic ($symbolic, $assocType=null, $assocId=null, $userId=null, $userGroupId=null)
 
 getAllSymbolics ()
 
 getByFileRevision ($fileId, $revision=null)
 
 getById ($signoffId, $assocType=null, $assocId=null)
 
 getBySymbolic ($symbolic, $assocType, $assocId, $userId=null, $userGroupId=null, $fileId=null, $fileRevision=null)
 
 getByUserId ($userId)
 
 getInsertId ()
 
 getStageIdBySymbolic ($symbolic)
 
 getUsersBySymbolic ($symbolic, $assocType, $assocId, $userGroupId=null, $unique=true)
 
 insertObject ($signoff)
 
 newDataObject ()
 
 SignoffDAO ()
 
 signoffExists ($symbolic, $assocType, $assocId, $userId=null, $userGroupId=null)
 
 transferSignoffs ($oldUserId, $newUserId)
 
 updateObject ($signoff)
 
- 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

Extension of SignoffDAO to work with signoffs relating to submission files.

See Also
SignoffDAO

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

Member Function Documentation

SubmissionFileSignoffDAO::build (   $symbolic,
  $submissionFileId,
  $userId = null,
  $userGroupId = null,
  $fileId = null,
  $fileRevision = null 
)

Fetch a signoff by symbolic info, building it if needed.

Parameters
$symbolicstring
$submissionFileIdint
$userIdint
$stageIdint
$userGroupIdint
$fileIdint
$fileRevisionint
Returns
Signoff

Definition at line 50 of file SubmissionFileSignoffDAO.inc.php.

SubmissionFileSignoffDAO::getAllBySubmission (   $submissionId,
  $symbolic = null,
  $userId = null,
  $userGroupId = null,
  $notCompletedOnly = false 
)

Retrieve all signoffs matching the specified input parameters

Parameters
$submissionIdint
$symbolicstring (optional)
$userIdint
$userGroupIdint
$onlyCompletedboolean
Returns
DAOResultFactory

Definition at line 125 of file SubmissionFileSignoffDAO.inc.php.

References DAO\retrieve().

SubmissionFileSignoffDAO::getAllBySymbolic (   $symbolic,
  $submissionFileId = null,
  $userId = null,
  $userGroupId = null 
)

Retrieve all signoffs matching the specified input parameters

Parameters
$symbolicstring
$submissionFileIdint
$userIdint
$stageIdint
$userGroupIdint
Returns
DAOResultFactory

Definition at line 112 of file SubmissionFileSignoffDAO.inc.php.

SubmissionFileSignoffDAO::getById (   $signoffId)
See Also
SignoffDAO::getById

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

SubmissionFileSignoffDAO::getBySymbolic (   $symbolic,
  $submissionFileId,
  $userId = null,
  $userGroupId = null,
  $fileId = null,
  $fileRevision = null 
)

Retrieve the first signoff matching the specified symbolic name and submission file info.

Parameters
$symbolicstring
$submissionFileIdint
$userIdint
$stageIdint
$userGroupIdint
$fileIdint
$fileRevisionint
Returns
Signoff

Definition at line 93 of file SubmissionFileSignoffDAO.inc.php.

SubmissionFileSignoffDAO::newDataObject ( )
See Also
SignoffDAO::newDataObject

Definition at line 75 of file SubmissionFileSignoffDAO.inc.php.

SubmissionFileSignoffDAO::signoffExists (   $symbolic,
  $submissionFileId,
  $userId = null,
  $userGroupId = null 
)

Determine if a signoff exists

Parameters
string$symbolic
int$submissionFileId
int$stageId
int$userGroupId
Returns
boolean

Definition at line 68 of file SubmissionFileSignoffDAO.inc.php.

SubmissionFileSignoffDAO::SubmissionFileSignoffDAO ( )

Constructor.

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


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