Merge pull request #2710 from NateWr/i2708_js_constants

#2708 Pass constants with JS handler configuration
pkp · Aug 28, 2017 · 38e5135 · 38e5135
2 parents 8e15ed1 + b4bd85b
commit 38e5135
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 22 deletions.
diff --git a/classes/services/PKPSubmissionService.inc.php b/classes/services/PKPSubmissionService.inc.php
@@ -22,6 +22,8 @@
 
 import('lib.pkp.classes.db.DBResultRange');
 
+define('STAGE_STATUS_SUBMISSION_UNASSIGNED', 1);
+
 abstract class PKPSubmissionService {
 
 	/**
@@ -497,7 +499,7 @@ public function toArrayStageDetails($submission, $stageIds = null) {
 					$stageAssignmentDao = DAORegistry::getDAO('StageAssignmentDAO');
 					$assignedEditors = $stageAssignmentDao->editorAssignedToStage($submission->getId(), $stageId);
 					if (!$assignedEditors) {
-						$stage['statusId'] = 1; // @todo this should be abstracted to a documented constant
+						$stage['statusId'] = STAGE_STATUS_SUBMISSION_UNASSIGNED;
 						$stage['status'] = __('submissions.queuedUnassigned');
 					}
 

diff --git a/controllers/list/submissions/PKPSubmissionsListHandler.inc.php b/controllers/list/submissions/PKPSubmissionsListHandler.inc.php
@@ -154,6 +154,31 @@ public function getConfig() {
 		// Attach a CSRF token for post requests
 		$config['csrfToken'] = $request->getSession()->getCSRFToken();
 
+		// Provide required constants
+		import('lib.pkp.classes.submission.reviewRound.ReviewRound');
+		import('lib.pkp.classes.submission.reviewAssignment.ReviewAssignment');
+		$config['_constants'] = array(
+			'WORKFLOW_STAGE_ID_SUBMISSION' => WORKFLOW_STAGE_ID_SUBMISSION,
+			'WORKFLOW_STAGE_ID_INTERNAL_REVIEW' => WORKFLOW_STAGE_ID_INTERNAL_REVIEW,
+			'WORKFLOW_STAGE_ID_EXTERNAL_REVIEW' => WORKFLOW_STAGE_ID_EXTERNAL_REVIEW,
+			'WORKFLOW_STAGE_ID_EDITING' => WORKFLOW_STAGE_ID_EDITING,
+			'WORKFLOW_STAGE_ID_PRODUCTION' => WORKFLOW_STAGE_ID_PRODUCTION,
+			'STAGE_STATUS_SUBMISSION_UNASSIGNED' => STAGE_STATUS_SUBMISSION_UNASSIGNED,
+			'REVIEW_ROUND_STATUS_PENDING_REVIEWERS' => REVIEW_ROUND_STATUS_PENDING_REVIEWERS,
+			'REVIEW_ROUND_STATUS_REVIEWS_READY' => REVIEW_ROUND_STATUS_REVIEWS_READY,
+			'REVIEW_ROUND_STATUS_REVIEWS_COMPLETED' => REVIEW_ROUND_STATUS_REVIEWS_COMPLETED,
+			'REVIEW_ROUND_STATUS_REVIEWS_OVERDUE' => REVIEW_ROUND_STATUS_REVIEWS_OVERDUE,
+			'REVIEW_ROUND_STATUS_REVISIONS_SUBMITTED' => REVIEW_ROUND_STATUS_REVISIONS_SUBMITTED,
+			'REVIEW_ROUND_STATUS_REVISIONS_REQUESTED' => REVIEW_ROUND_STATUS_REVISIONS_REQUESTED,
+			'REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE' => REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE,
+			'REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE' => REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE,
+			'REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE' => REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE,
+			'REVIEW_ASSIGNMENT_STATUS_ACCEPTED' => REVIEW_ASSIGNMENT_STATUS_ACCEPTED,
+			'REVIEW_ASSIGNMENT_STATUS_RECEIVED' => REVIEW_ASSIGNMENT_STATUS_RECEIVED,
+			'REVIEW_ASSIGNMENT_STATUS_COMPLETE' => REVIEW_ASSIGNMENT_STATUS_COMPLETE,
+			'REVIEW_ASSIGNMENT_STATUS_THANKED' => REVIEW_ASSIGNMENT_STATUS_THANKED,
+		);
+
 		return $config;
 	}
 

diff --git a/js/classes/VueRegistry.js b/js/classes/VueRegistry.js
@@ -31,11 +31,16 @@ var VueRegistry = {
 	 */
 	init: function(id, type, data) {
 
-		if (typeof pkp.controllers[type] === 'undefined' ) {
+		if (pkp.controllers[type] === undefined ) {
 			console.log('No Vue of the type ' + type + ' could be found.');
 			return;
 		}
 
+		if (data._constants !== undefined) {
+			Object.assign(pkp.const, data._constants);
+			delete data._constants;
+		}
+
 		var args = _.extend({}, pkp.controllers[type],
 			{
 				el: '#' + id,

diff --git a/js/controllers/list/submissions/SubmissionsListItem.vue b/js/controllers/list/submissions/SubmissionsListItem.vue
@@ -188,9 +188,9 @@ export default {
 
 			// Notices for journal managers
 			if (pkp.userHasRole('manager')) {
-				if (this.activeStage.id === 1) {
+				if (this.activeStage.id === pkp.const.WORKFLOW_STAGE_ID_SUBMISSION) {
 					switch (this.activeStage.statusId) {
-						case 1: // @todo this should be a global
+						case pkp.const.STAGE_STATUS_SUBMISSION_UNASSIGNED:
 							// Only display unassigned notice for completed submissions
 							if (this.item.submissionProgress === 0) {
 								notice = this.activeStage.status;
@@ -204,11 +204,11 @@ export default {
 			if (pkp.userHasRole(['manager', 'subeditor'])) {
 				if (this.isReviewStage) {
 					switch (this.activeStage.statusId) {
-						case 6: // REVIEW_ROUND_STATUS_PENDING_REVIEWERS
-						case 8: // REVIEW_ROUND_STATUS_REVIEWS_READY
-						case 9: // REVIEW_ROUND_STATUS_REVIEWS_COMPLETED
-						case 10: // REVIEW_ROUND_STATUS_REVIEWS_OVERDUE
-						case 11: // REVIEW_ROUND_STATUS_REVISIONS_SUBMITTED
+						case pkp.const.REVIEW_ROUND_STATUS_PENDING_REVIEWERS:
+						case pkp.const.REVIEW_ROUND_STATUS_REVIEWS_READY:
+						case pkp.const.REVIEW_ROUND_STATUS_REVIEWS_COMPLETED:
+						case pkp.const.REVIEW_ROUND_STATUS_REVIEWS_OVERDUE:
+						case pkp.const.REVIEW_ROUND_STATUS_REVISIONS_SUBMITTED:
 							notice = this.activeStage.status;
 							break;
 					}
@@ -219,7 +219,7 @@ export default {
 			if (pkp.userHasRole(['author'])) {
 				if (this.isReviewStage) {
 					switch (this.activeStage.statusId) {
-						case 1: // REVIEW_ROUND_STATUS_REVISIONS_REQUESTED
+						case pkp.const.REVIEW_ROUND_STATUS_REVISIONS_REQUESTED:
 							notice = this.activeStage.status;
 							break;
 					}
@@ -229,9 +229,9 @@ export default {
 			// Notices for reviewers
 			if (this.currentUserIsReviewer) {
 				switch (this.currentUserLatestReviewAssignment.statusId) {
-					case 0: // REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE
-					case 4: // REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE
-					case 6: // REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE
+					case pkp.const.REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE:
+					case pkp.const.REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE:
+					case pkp.const.REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE:
 					notice = this.currentUserLatestReviewAssignment.status;
 					break;
 				}
@@ -260,7 +260,7 @@ export default {
 		 * @return bool
 		 */
 		isReviewStage: function() {
-			return this.activeStage.id === 2 || this.activeStage.id === 3;
+			return this.activeStage.id === pkp.const.WORKFLOW_STAGE_ID_INTERNAL_REVIEW || this.activeStage.id === pkp.const.WORKFLOW_STAGE_ID_EXTERNAL_REVIEW;
 		},
 
 		/**
@@ -303,20 +303,20 @@ export default {
 
 			switch (latest.statusId) {
 
-				case 0: // REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE
-				case 4: // REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_AWAITING_RESPONSE:
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_RESPONSE_OVERDUE:
 					latest.responsePending = true;
 					latest.reviewPending = true;
 					break;
 
-				case 5: // REVIEW_ASSIGNMENT_STATUS_ACCEPTED
-				case 6: // REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_ACCEPTED:
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_REVIEW_OVERDUE:
 					latest.reviewPending = true;
 					break;
 
-				case 7: // REVIEW_ASSIGNMENT_STATUS_RECEIVED
-				case 8: // REVIEW_ASSIGNMENT_STATUS_COMPLETE
-				case 9: // REVIEW_ASSIGNMENT_STATUS_THANKED
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_RECEIVED:
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_COMPLETE:
+				case pkp.const.REVIEW_ASSIGNMENT_STATUS_THANKED:
 					latest.reviewComplete = true;
 					break;
 			}
@@ -334,7 +334,7 @@ export default {
 				return 0;
 			}
 			return _.filter(this.currentReviewAssignments, function(review) {
-				return review.statusId >= 7; // REVIEW_ASSIGNMENT_STATUS_RECEIVED and above
+				return review.statusId >= pkp.const.REVIEW_ASSIGNMENT_STATUS_RECEIVED;
 			}).length;
 		},