Open Journal Systems  3.3.0
APP\Services\SubmissionService Class Reference
Inheritance diagram for APP\Services\SubmissionService:
PKP\Services\PKPSubmissionService

Public Member Functions

 __construct ()
 
 getInSections ($issueId, $contextId)
 
 modifyAPISubmissionsParams ($hookName, $args)
 
 modifyPropertyValues ($hookName, $args)
 
 modifySubmissionListQueryObject ($hookName, $args)
 
 modifySubmissionQueryBuilder ($hookName, $args)
 
- Public Member Functions inherited from PKP\Services\PKPSubmissionService
 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 19 of file SubmissionService.inc.php.

Constructor & Destructor Documentation

◆ __construct()

APP\Services\SubmissionService::__construct ( )

Initialize hooks for extending PKPSubmissionService

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

References HookRegistry\register().

Member Function Documentation

◆ getInSections()

APP\Services\SubmissionService::getInSections (   $issueId,
  $contextId 
)

Get submissions ordered by section id

This method replaces PublishedSubmissionDAO::getPublishedSubmissionsInSections() which was removed with v3.2.

Parameters
int$issueId
int$contextId
Returns
array submissions keyed to a section with some section details

Definition at line 151 of file SubmissionService.inc.php.

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

◆ modifyAPISubmissionsParams()

APP\Services\SubmissionService::modifyAPISubmissionsParams (   $hookName,
  $args 
)

Collect and sanitize request params for submissions API endpoint

Parameters
$hookNamestring
$argsarray [ @option array $returnParams @option SlimRequest $slimRequest ]
Returns
array

Definition at line 42 of file SubmissionService.inc.php.

◆ modifyPropertyValues()

APP\Services\SubmissionService::modifyPropertyValues (   $hookName,
  $args 
)

Add app-specific property values to a submission

Parameters
$hookNamestring Submission::getProperties::values
$argsarray [ @option $values array Key/value store of property values @option $submission Submission The associated submission @option $props array Requested properties @option $args array Request args ]
Returns
array

Definition at line 117 of file SubmissionService.inc.php.

◆ modifySubmissionListQueryObject()

APP\Services\SubmissionService::modifySubmissionListQueryObject (   $hookName,
  $args 
)

Add app-specific query statements to the list get query

Parameters
$hookNamestring
$argsarray [ @option object $queryObject @option \APP\Services\QueryBuilders\SubmissionQueryBuilder $queryBuilder ]
Returns
object

Definition at line 97 of file SubmissionService.inc.php.

◆ modifySubmissionQueryBuilder()

APP\Services\SubmissionService::modifySubmissionQueryBuilder (   $hookName,
  $args 
)

Run app-specific query builder methods for getMany

Parameters
$hookNamestring
$argsarray [ @option \APP\Services\QueryBuilders\SubmissionQueryBuilder @option int Context ID @option array Request args ]
Returns
\APP\Services\QueryBuilders\SubmissionQueryBuilder

Definition at line 73 of file SubmissionService.inc.php.


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