Property | Type | Description | |
---|---|---|---|
$authorDao | |||
$cache |
Method | Description | |
---|---|---|
__construct ( ) | Constructor. | |
_cacheMiss ( $cache, $id ) : Monograph | Callback for a cache miss. | |
_fromRow ( $row ) : Submission | Internal function to return a Submission object from a row. | |
_getCache ( ) : Cache | Get the submission cache. | |
changePubId ( $submissionId, $pubIdType, $pubId ) | ||
deleteAllPubIds ( $contextId, $pubIdType ) | ||
deleteByContextId ( $contextId ) | Delete all submissions by context ID. | |
deleteById ( $submissionId ) | Delete a submission by ID. | |
deleteObject ( $submission ) | Delete a submission. | |
deletePermissions ( $contextId ) | Delete the attached licenses of all submissions in a context. | |
deletePubId ( $submissionId, $pubIdType ) | ||
flushCache ( ) | Flush the submission cache. | |
getActiveSubmissions ( $contextId = null, $title = null, $author = null, $editor = null, $stageId = null, $rangeInfo = null, $orphaned = false ) : DAOResultFactory | Get all active submissions for a context. | |
getAdditionalFieldNames ( ) : array | Get a list of additional fields that do not have dedicated accessors. | |
getAssignedById ( integer $submissionId, integer $userId, integer $contextId = null, boolean $useCache = false ) : Submission | Retrieve a submission by ID only if the submission is not published, has been submitted, and does not belong to the user in question and is not STATUS_DECLINED. | |
getAssignedToOthers ( $userId, $contextId = null, $title = null, $author = null, $editor = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | Get all submissions that are assigned to users other than the passed one. | |
getAssignedToUser ( $userId, $contextId = null, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | Get all submissions that are considered assigned to the passed user, excluding author participation. | |
getByContextId ( $contextId ) : DAOResultFactory | Get all submissions for a context. | |
getById ( $submissionId, $contextId = null, $useCache = false ) : Submission | Retrieve a submission by ID. | |
getByStatus ( $status, $userId = null, $contextId = null, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | Get all submissions for a status. | |
getBySubEditorId ( $contextId, $subEditorId = null, $includeDeclined = true, $includePublished = true, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | Get all unassigned submissions for a context or all contexts | |
getByUserId ( $userId, $contextId = null ) : array | Get all submissions for a user. | |
getInsertId ( ) : integer | Get the ID of the last inserted submission. | |
getLocaleFieldNames ( ) : array | Get a list of fields for which localized data is supported | |
getReviewerArchived ( $reviewerId, $contextId = null, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | Get all submissions that a reviewer denied a review request. | |
getUnpublishedByUserId ( $userId, $contextId = null, $title = null, $stageId = null, $rangeInfo = null ) : array | Get all unpublished submissions for a user. | |
newDataObject ( ) : Submission | Instantiate a new data object. | |
pubIdExists ( $pubIdType, $pubId, $submissionId, $contextId ) | ||
updateLocaleFields ( $submission ) | Update the settings for this object |
Method | Description | |
---|---|---|
_arrayWalkIntCast ( string $value ) : integer | Sanity test to cast values to int for database queries. | |
getCompletionConditions ( $completed ) : string | Get conditions required to establish whether the submission is "completed". | |
getCompletionJoins ( ) : string | Get additional joins required to establish whether the submission is "completed". | |
getFetchColumns ( ) : string | Return a SQL snippet of extra columns to fetch during submission fetch queries. | |
getFetchJoins ( ) : string | Return a SQL snippet of extra joins to include during fetch queries. | |
getFetchParameters ( ) : array | Return a list of extra parameters to bind to the submission fetch queries. | |
getGroupByColumns ( ) : string | Return a SQL snippet of columns to group by the submission fetch queries. | |
getSubEditorJoin ( ) : string | Return a SQL snippet of extra sub editor related join to include during fetch queries. |
Method | Description | |
---|---|---|
_getEditorSearchQuery ( ) : string | Get the editor search query for submissions. |
protected _arrayWalkIntCast ( string $value ) : integer | ||
$value | string | |
return | integer |
public _cacheMiss ( $cache, $id ) : Monograph | ||
$cache | Cache | |
$id | string | |
return | Monograph |
public _fromRow ( $row ) : Submission | ||
$row | array | |
return | Submission |
public deleteByContextId ( $contextId ) | ||
$contextId | int |
public deleteById ( $submissionId ) | ||
$submissionId | int |
public deleteObject ( $submission ) | ||
$submission | Submission |
public deletePermissions ( $contextId ) |
public getActiveSubmissions ( $contextId = null, $title = null, $author = null, $editor = null, $stageId = null, $rangeInfo = null, $orphaned = false ) : DAOResultFactory | ||
$contextId | int optional | |
$title | string|null optional Filter by title. | |
$author | string|null optional Filter by author. | |
$editor | int|null optional Filter by editor name. | |
$stageId | int|null optional Filter by stage id. | |
$rangeInfo | DBResultRange optional | |
$orphaned | boolean Whether the incomplete submissions that have no author assigned should be considered too | |
return | DAOResultFactory |
public getAdditionalFieldNames ( ) : array | ||
return | array |
public getAssignedToOthers ( $userId, $contextId = null, $title = null, $author = null, $editor = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | ||
$userId | int | |
$contextId | int optional | |
$title | string|null optional Filter by title. | |
$author | string|null optional Filter by author. | |
$editor | int|null optional Filter by editor name. | |
$stageId | int|null optional Filter by stage id. | |
$rangeInfo | DBResultRange optional | |
return | DAOResultFactory |
public getAssignedToUser ( $userId, $contextId = null, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | ||
$userId | int | |
$contextId | int optional | |
$title | string|null optional Filter by title. | |
$author | string|null optional Filter by author. | |
$stageId | int|null optional Filter by stage id. | |
$rangeInfo | DBResultRange optional | |
return | DAOResultFactory |
public getByContextId ( $contextId ) : DAOResultFactory | ||
$contextId | int | |
return | DAOResultFactory | containing matching Submissions |
public getById ( $submissionId, $contextId = null, $useCache = false ) : Submission | ||
$submissionId | int | |
$contextId | int optional | |
$useCache | boolean optional | |
return | Submission |
public getByStatus ( $status, $userId = null, $contextId = null, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | ||
$status | int Status to get submissions for | |
$userId | int optional User to require an assignment for | |
$contextId | mixed optional Context(s) to fetch submissions for | |
$title | string optional | |
$author | string optional | |
$stageId | int optional | |
$rangeInfo | DBResultRange optional | |
return | DAOResultFactory |
public getBySubEditorId ( $contextId, $subEditorId = null, $includeDeclined = true, $includePublished = true, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | ||
$contextId | int optional the ID of the context to query. | |
$subEditorId | int optional the ID of the sub editor whose section will be included in the results (excluding others). | |
$includeDeclined | boolean optional include submissions which have STATUS_DECLINED | |
$includePublished | boolean optional include submissions which are published | |
$title | string|null optional Filter by title. | |
$author | string|null optional Filter by author. | |
$stageId | int|null optional Filter by stage id. | |
$rangeInfo | DBRangeInfo | |
return | DAOResultFactory | containing matching Submissions |
public getByUserId ( $userId, $contextId = null ) : array | ||
$userId | int | |
$contextId | int optional | |
return | array | Submissions |
abstract protected getCompletionConditions ( $completed ) : string | ||
$completed | boolean True for completed submissions; false for incomplete | |
return | string |
protected getCompletionJoins ( ) : string | ||
return | string |
abstract protected getFetchColumns ( ) : string | ||
return | string |
abstract protected getFetchJoins ( ) : string | ||
return | string |
abstract protected getFetchParameters ( ) : array | ||
return | array |
abstract protected getGroupByColumns ( ) : string | ||
return | string |
public getInsertId ( ) : integer | ||
return | integer |
public getLocaleFieldNames ( ) : array | ||
return | array |
public getReviewerArchived ( $reviewerId, $contextId = null, $title = null, $author = null, $stageId = null, $rangeInfo = null ) : DAOResultFactory | ||
$reviewerId | int | |
$contextId | int optional | |
$title | string optional | |
$author | string optional | |
$stageId | int optional | |
$rangeInfo | DBResultRange optional | |
return | DAOResultFactory |
abstract protected getSubEditorJoin ( ) : string | ||
return | string |
public getUnpublishedByUserId ( $userId, $contextId = null, $title = null, $stageId = null, $rangeInfo = null ) : array | ||
$userId | int | |
$contextId | int optional | |
$rangeInfo | DBResultRange optional | |
return | array | Submissions |
public newDataObject ( ) : Submission | ||
return | Submission |
public updateLocaleFields ( $submission ) | ||
$submission | object |