Inheritance diagram for PKP\Services\PKPSubmissionService:

Public Member Functions
	add ($submission, $request)

	canCurrentUserDelete ($submission)

	canEditPublication ($submissionId, $userId)

	delete ($submission)

	edit ($submission, $params, $request)

	get ($submissionId)

	getBackendListProperties ($submission, $args=null)

	getByUrlPath ($urlPath, $contextId)

	getCount ($args=[])

	getFullProperties ($submission, $args=null)

	getIds ($args=[])

	getMany ($args=[])

	getMax ($args=[])

	getProperties ($submission, $props, $args=null)

	getPropertyReviewAssignments ($submission)

	getPropertyReviewRounds ($submission)

	getPropertyStages ($submission, $stageIds=null)

	getQueryBuilder ($args=[])

	getReviewAssignments ($submission)

	getReviewRounds ($submission)

	getSummaryProperties ($submission, $args=null)

	getWorkflowUrlByUserRoles ($submission, $userId=null)

	updateStatus ($submission)

	validate ($action, $props, $allowedLocales, $primaryLocale)

Detailed Description

Definition at line 32 of file PKPSubmissionService.inc.php.

Member Function Documentation

◆ add()

PKP\Services\PKPSubmissionService::add	(	$submission,
		$request
	)

Definition at line 741 of file PKPSubmissionService.inc.php.

References HookRegistry\call(), Core\getCurrentDate(), and DAORegistry\getDAO().

◆ canCurrentUserDelete()

PKP\Services\PKPSubmissionService::canCurrentUserDelete ( $submission )

Check if a user can delete a submission

Parameters

$submission Submission|int Submission object or submission ID

Returns: bool

Definition at line 634 of file PKPSubmissionService.inc.php.

References PKPApplication\get(), and DAORegistry\getDAO().

◆ canEditPublication()

PKP\Services\PKPSubmissionService::canEditPublication	(	$submissionId,
		$userId
	)

Check if a user can edit a publications metadata

Parameters

int	$submissionId
int	$userId

Returns: boolean

Definition at line 794 of file PKPSubmissionService.inc.php.

References PKPApplication\get(), and DAORegistry\getDAO().

◆ delete()

PKP\Services\PKPSubmissionService::delete ( $submission )

Definition at line 778 of file PKPSubmissionService.inc.php.

References HookRegistry\call(), and DAORegistry\getDAO().

◆ edit()

PKP\Services\PKPSubmissionService::edit	(	$submission,
		$params,
		$request
	)

Definition at line 759 of file PKPSubmissionService.inc.php.

References HookRegistry\call(), and DAORegistry\getDAO().

◆ get()

PKP\Services\PKPSubmissionService::get ( $submissionId )

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

References DAORegistry\getDAO().

◆ getBackendListProperties()

PKP\Services\PKPSubmissionService::getBackendListProperties	(	$submission,
		$args = `null`
	)

Returns properties for custom API endpoints used in the backend

Parameters

Submission	$submission
	array	extra arguments $args['request'] PKPRequest Required $args['slimRequest'] SlimRequest

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

References HookRegistry\call(), PKP\Services\PKPSubmissionService\getProperties(), and PluginRegistry\loadCategory().

◆ getByUrlPath()

PKP\Services\PKPSubmissionService::getByUrlPath	(	$urlPath,
		$contextId
	)

Get a submission by the urlPath of its publications

Parameters

string	$urlPath
int	$contextId

Returns: Submission|null

Definition at line 49 of file PKPSubmissionService.inc.php.

◆ getCount()

PKP\Services\PKPSubmissionService::getCount ( $args = [] )

Definition at line 63 of file PKPSubmissionService.inc.php.

References PKP\Services\PKPSubmissionService\getQueryBuilder().

◆ getFullProperties()

PKP\Services\PKPSubmissionService::getFullProperties	(	$submission,
		$args = `null`
	)

Definition at line 273 of file PKPSubmissionService.inc.php.

References PKPServices\get(), PKP\Services\PKPSubmissionService\getProperties(), and PKP\Services\SCHEMA_SUBMISSION.

◆ getIds()

PKP\Services\PKPSubmissionService::getIds ( $args = [] )

Definition at line 70 of file PKPSubmissionService.inc.php.

References PKP\Services\PKPSubmissionService\getQueryBuilder().

◆ getMany()

PKP\Services\PKPSubmissionService::getMany ( $args = [] )

Get a collection of Submission objects limited, filtered and sorted by $args

Parameters

array $args @option int contextId If not supplied, CONTEXT_ID_NONE will be used and no submissions will be returned. To retrieve submissions from all contexts, use CONTEXT_ID_ALL. @option string orderBy @option string orderDirection @option int assignedTo @option int|array status @option string searchPhrase @option int count @option int offset

Returns: \Iterator

Definition at line 91 of file PKPSubmissionService.inc.php.

References DAORegistry\getDAO(), and PKP\Services\PKPSubmissionService\getQueryBuilder().

Referenced by APP\Services\SubmissionService\getInSections().

◆ getMax()

PKP\Services\PKPSubmissionService::getMax ( $args = [] )

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

References PKP\Services\PKPSubmissionService\getQueryBuilder().

◆ getProperties()

PKP\Services\PKPSubmissionService::getProperties	(	$submission,
		$props,
		$args = `null`
	)

Definition at line 169 of file PKPSubmissionService.inc.php.

References HookRegistry\call(), PKPServices\get(), DAORegistry\getDAO(), PKP\Services\PKPSubmissionService\getPropertyReviewAssignments(), PKP\Services\PKPSubmissionService\getPropertyReviewRounds(), PKP\Services\PKPSubmissionService\getPropertyStages(), PKP\Services\PKPSubmissionService\getWorkflowUrlByUserRoles(), AppLocale\requireComponents(), and PKP\Services\SCHEMA_SUBMISSION.

Referenced by PKP\Services\PKPSubmissionService\getBackendListProperties(), PKP\Services\PKPSubmissionService\getFullProperties(), and PKP\Services\PKPSubmissionService\getSummaryProperties().

◆ getPropertyReviewAssignments()

PKP\Services\PKPSubmissionService::getPropertyReviewAssignments ( $submission )

Get details about the review assignments for a submission

Todo:: account for extra review stage in omp

Parameters

$submission Submission

Definition at line 306 of file PKPSubmissionService.inc.php.

References PKPApplication\get(), and PKP\Services\PKPSubmissionService\getReviewAssignments().

Referenced by PKP\Services\PKPSubmissionService\getProperties().

◆ getPropertyReviewRounds()

PKP\Services\PKPSubmissionService::getPropertyReviewRounds ( $submission )

Get details about the review rounds for a submission

Todo:: account for extra review stage in omp

Parameters

$submission Submission

Returns: array

Definition at line 347 of file PKPSubmissionService.inc.php.

References PKP\Services\PKPSubmissionService\getReviewRounds().

Referenced by PKP\Services\PKPSubmissionService\getProperties().

◆ getPropertyStages()

PKP\Services\PKPSubmissionService::getPropertyStages	(	$submission,
		$stageIds = `null`
	)

Get details about a submission's stage(s)

Parameters

$submission	Submission
$stageIds	array\|int\|null One or more stages to retrieve. Default: null. Will return data on all app stages.

Returns: array { id int stage id label string translated stage name queries array [{ id int query id assocType int assocId int stageId int seq int closed bool }] statusId int stage status. note: on review stage, this refers to the status of the latest round. status string translated stage status name files array { count int number of files attached to stage. note: this only counts revision files. }

Definition at line 390 of file PKPSubmissionService.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), and PKP\Services\STAGE_STATUS_SUBMISSION_UNASSIGNED.

Referenced by PKP\Services\PKPSubmissionService\getProperties().

◆ getQueryBuilder()

PKP\Services\PKPSubmissionService::getQueryBuilder ( $args = [] )

Returns: SubmissionQueryBuilder

Definition at line 123 of file PKPSubmissionService.inc.php.

References HookRegistry\call().

Referenced by PKP\Services\PKPSubmissionService\getCount(), PKP\Services\PKPSubmissionService\getIds(), PKP\Services\PKPSubmissionService\getMany(), and PKP\Services\PKPSubmissionService\getMax().

◆ getReviewAssignments()

PKP\Services\PKPSubmissionService::getReviewAssignments ( $submission )

Get review assignments for a submission

Parameters

$submission Submission

Returns: array

Definition at line 688 of file PKPSubmissionService.inc.php.

References DAORegistry\getDAO().

Referenced by PKP\Services\PKPSubmissionService\getPropertyReviewAssignments().

◆ getReviewRounds()

PKP\Services\PKPSubmissionService::getReviewRounds ( $submission )

Get review rounds for a submission

Parameters

$submission Submission

Returns: \Iterator

Definition at line 677 of file PKPSubmissionService.inc.php.

References DAORegistry\getDAO().

Referenced by PKP\Services\PKPSubmissionService\getPropertyReviewRounds().

◆ getSummaryProperties()

PKP\Services\PKPSubmissionService::getSummaryProperties	(	$submission,
		$args = `null`
	)

Definition at line 264 of file PKPSubmissionService.inc.php.

References PKPServices\get(), PKP\Services\PKPSubmissionService\getProperties(), and PKP\Services\SCHEMA_SUBMISSION.

◆ getWorkflowUrlByUserRoles()

PKP\Services\PKPSubmissionService::getWorkflowUrlByUserRoles	(	$submission,
		$userId = `null`
	)

Get the correct access URL for a submission's workflow based on a user's role.

The returned URL will point to the correct workflow page based on whether the user should be treated as an author, reviewer or editor/assistant for this submission.

Parameters