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

Public Member Functions

 _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

Operations for retrieving and modifying Signoff objects.

See Also
Signoff

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

Member Function Documentation

SignoffDAO::_fromRow (   $row)

Internal function to return an Signoff object from a row.

Parameters
$rowarray
Returns
Signoff

Definition at line 131 of file SignoffDAO.inc.php.

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

Referenced by getById(), and getBySymbolic().

SignoffDAO::_getAllInternally (   $symbolic = null,
  $assocType = null,
  $assocId = null,
  $userId = null,
  $userGroupId = null 
)

Retrieve all signoffs matching the specified input parameters

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$userIdint
$stageIdint
$userGroupIdint
Returns
DAOResultFactory

Definition at line 446 of file SignoffDAO.inc.php.

References DAO\retrieve().

Referenced by getAllByAssocType(), and getAllBySymbolic().

SignoffDAO::build (   $symbolic,
  $assocType,
  $assocId,
  $userId = null,
  $userGroupId = null,
  $fileId = null,
  $fileRevision = null 
)

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

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$userIdint
$stageIdint
$userGroupIdint
$fileIdint
$fileRevisionint
Returns
Signoff

Definition at line 64 of file SignoffDAO.inc.php.

References getBySymbolic(), insertObject(), and newDataObject().

SignoffDAO::deleteObject (   $signoff)

Delete a signoff.

Parameters
$signoffSignoff
Returns
boolean

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

References deleteObjectById().

SignoffDAO::deleteObjectById (   $signoffId)

Delete a signoff by ID.

Parameters
$signoffIdint
Returns
boolean

Definition at line 236 of file SignoffDAO.inc.php.

References DAO\update().

Referenced by deleteObject().

SignoffDAO::getAllByAssocType (   $assocType,
  $assocId,
  $symbolic = null,
  $userId = null,
  $userGroupId = null 
)

Retrieve all signoffs matching the specified input parameters

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$userIdint
$stageIdint
$userGroupIdint
Returns
DAOResultFactory

Definition at line 313 of file SignoffDAO.inc.php.

References _getAllInternally().

SignoffDAO::getAllBySymbolic (   $symbolic,
  $assocType = null,
  $assocId = null,
  $userId = null,
  $userGroupId = null 
)

Retrieve all signoffs matching the specified input parameters

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$userIdint
$stageIdint
$userGroupIdint
Returns
DAOResultFactory

Definition at line 299 of file SignoffDAO.inc.php.

References _getAllInternally().

SignoffDAO::getAllSymbolics ( )

Get an array map with all signoff symbolics.

Returns
array

Definition at line 422 of file SignoffDAO.inc.php.

SignoffDAO::getByFileRevision (   $fileId,
  $revision = null 
)

Retrieve all signoffs for a given file.

Parameters
$fileIdinteger
$revisioninteger
Returns
DAOResultFactory

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

References DAO\retrieve().

SignoffDAO::getById (   $signoffId,
  $assocType = null,
  $assocId = null 
)

Retrieve a signoff by ID.

Parameters
$signoffIdint
Returns
Signoff

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

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

SignoffDAO::getBySymbolic (   $symbolic,
  $assocType,
  $assocId,
  $userId = null,
  $userGroupId = null,
  $fileId = null,
  $fileRevision = null 
)

Retrieve the first signoff matching the specified symbolic name and assoc info.

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$userIdint
$stageIdint
$userGroupIdint
$fileIdint
$fileRevisionint
Returns
Signoff

Definition at line 253 of file SignoffDAO.inc.php.

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

Referenced by build().

SignoffDAO::getByUserId (   $userId)

Retrieve an array of signoffs matching the specified user id

Parameters
$userIdint
Returns
DAOResultFactory

Definition at line 322 of file SignoffDAO.inc.php.

References DAO\retrieve().

SignoffDAO::getInsertId ( )

Get the ID of the last inserted signoff.

Returns
int

Definition at line 414 of file SignoffDAO.inc.php.

Referenced by insertObject().

SignoffDAO::getStageIdBySymbolic (   $symbolic)

Get the related stage id by symbolic.

Returns
int

Definition at line 380 of file SignoffDAO.inc.php.

SignoffDAO::getUsersBySymbolic (   $symbolic,
  $assocType,
  $assocId,
  $userGroupId = null,
  $unique = true 
)

Get all users assigned to a particular workflow stage

Parameters
$symbolicstring
$assocTypeint
$assocIdint
$stageIdint
$userGroupId
$uniqueboolean
Returns
object

Definition at line 358 of file SignoffDAO.inc.php.

References DAORegistry\getDAO(), and DAO\retrieve().

SignoffDAO::insertObject (   $signoff)

Insert a new Signoff.

Parameters
$signoffSignoff
Returns
int

Definition at line 155 of file SignoffDAO.inc.php.

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

Referenced by build().

SignoffDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
SignoffEntry

Definition at line 122 of file SignoffDAO.inc.php.

Referenced by _fromRow(), and build().

SignoffDAO::SignoffDAO ( )

Constructor

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

SignoffDAO::signoffExists (   $symbolic,
  $assocType,
  $assocId,
  $userId = null,
  $userGroupId = null 
)

Determine if a signoff exists

Parameters
string$symbolic
int$assocType
int$assocId
int$stageId
int$userGroupId
Returns
boolean

Definition at line 96 of file SignoffDAO.inc.php.

References DAO\retrieve().

SignoffDAO::transferSignoffs (   $oldUserId,
  $newUserId 
)

Transfer all existing signoffs to another user.

Parameters
$oldUserIdint
$newUserIdint

Definition at line 398 of file SignoffDAO.inc.php.

References DAO\update().

SignoffDAO::updateObject (   $signoff)

Update an existing signoff.

Parameters
$signoffSignoff
Returns
boolean

Definition at line 186 of file SignoffDAO.inc.php.

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


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