Open Journal Systems  3.3.0
WorkflowStageDAO Class Reference
Inheritance diagram for WorkflowStageDAO:
DAO

Static Public Member Functions

static getIdFromPath ($stagePath)
 
static getPathFromId ($stageId)
 
static getStageStatusesBySubmission ($submission, $stagesWithDecisions, $stageNotifications)
 
static getTranslationKeyFromId ($stageId)
 
static getWorkflowStageKeysAndPaths ()
 
static getWorkflowStageTranslationKeys ()
 
- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
 

Additional Inherited Members

- 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)
 
 getAdditionalFieldNames ()
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getLocaleFieldNames ()
 
 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)
 
- Data Fields inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

class for operations involving the workflow stages.

Definition at line 17 of file WorkflowStageDAO.inc.php.

Member Function Documentation

◆ getIdFromPath()

static WorkflowStageDAO::getIdFromPath (   $stagePath)
static

Convert a stage path into a stage id

Parameters
$stagePathstring
Returns
integer|null

Definition at line 43 of file WorkflowStageDAO.inc.php.

Referenced by PKPWorkflowHandler\_redirectToIndex(), EditorDecisionHandler\_saveGeneralPromote(), NativeXmlSubmissionFilter\handleElement(), and PKPWorkflowHandler\identifyStageId().

◆ getPathFromId()

static WorkflowStageDAO::getPathFromId (   $stageId)
static

Convert a stage id into a stage path

Parameters
$stageIdinteger
Returns
string|null

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

Referenced by SubmissionNativeXmlFilter\createSubmissionNode(), and PKPWorkflowHandler\identifyStageId().

◆ getStageStatusesBySubmission()

static WorkflowStageDAO::getStageStatusesBySubmission (   $submission,
  $stagesWithDecisions,
  $stageNotifications 
)
static

Returns an array containing data for rendering the stage workflow tabs for a submission.

Parameters
$submissionSubmission
$stagesWithDecisionsarray
$stageNotificationsarray
Returns
array

Definition at line 114 of file WorkflowStageDAO.inc.php.

References getWorkflowStageKeysAndPaths().

◆ getTranslationKeyFromId()

static WorkflowStageDAO::getTranslationKeyFromId (   $stageId)
static

Convert a stage id into a stage translation key

Parameters
$stageIdinteger
Returns
string|null

Definition at line 62 of file WorkflowStageDAO.inc.php.

References getWorkflowStageTranslationKeys().

Referenced by ReviewReportPlugin\display(), UserGroupDAO\getAssignedStagesByUserGroupId(), and SelectableSubmissionFileListCategoryGridRow\getCategoryLabel().

◆ getWorkflowStageKeysAndPaths()

static WorkflowStageDAO::getWorkflowStageKeysAndPaths ( )
static

Return a mapping of workflow stages, its translation keys and paths.

Returns
array

Definition at line 92 of file WorkflowStageDAO.inc.php.

References getWorkflowStageTranslationKeys().

Referenced by getStageStatusesBySubmission(), PKPWorkflowHandler\index(), PKPAuthorDashboardHandler\setupTemplate(), and PKPWorkflowHandler\submissionProgressBar().

◆ getWorkflowStageTranslationKeys()

static WorkflowStageDAO::getWorkflowStageTranslationKeys ( )
static

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