EditorHandler Class Reference
[Pages_editor]

Handle requests for editor functions. More...

Inheritance diagram for EditorHandler:

List of all members.

Public Member Functions
	assignEditor ($args)
	deleteEditAssignment ($args)
	deleteSubmission ($args)
	getDateFieldOptions ()
	getSearchFieldOptions ()
	getSearchFormDuplicateParameters ()
	index ($args)
	setEditorFlags ($args)
	setupTemplate ($level=EDITOR_SECTION_HOME, $articleId=0, $parentPage=null)
	submissions ($args)
	validate ()

---

Detailed Description

Handle requests for editor functions.

Definition at line 30 of file EditorHandler.inc.php.

---

Member Function Documentation

EditorHandler.assignEditor

(

$

args

)

Assigns the selected editor to the submission.

Definition at line 342 of file EditorHandler.inc.php.

References EditorAction.assignEditor(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), RoleDAO.getRoleIdFromPath(), Request.getUserVar(), Request.redirect(), setupTemplate(), String.strtoupper(), Locale.translate(), and validate().

EditorHandler.deleteEditAssignment

(

$

args

)

Delete the specified edit assignment.

Definition at line 317 of file EditorHandler.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), Request.redirect(), and validate().

EditorHandler.deleteSubmission

(

$

args

)

Delete a submission.

Definition at line 429 of file EditorHandler.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), Request.redirect(), and validate().

EditorHandler.getDateFieldOptions

(

)

Get the list of date fields that can be searched.

Returns:

array

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

Referenced by index(), and submissions().

EditorHandler.getSearchFieldOptions

(

)

Get the list of fields that can be searched by contents.

Returns:

array

Definition at line 257 of file EditorHandler.inc.php.

Referenced by index(), and submissions().

EditorHandler.getSearchFormDuplicateParameters

(

)

Get the list of parameter names that should be duplicated when displaying the search form (i.e. made available to the template based on supplied user data).

Returns:

array

Definition at line 244 of file EditorHandler.inc.php.

Referenced by index(), and submissions().

EditorHandler.index

(

$

args

)

Displays the editor role selection page.

Reimplemented from SectionEditorHandler.

Definition at line 36 of file EditorHandler.inc.php.

References DAORegistry.getDAO(), getDateFieldOptions(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), getSearchFieldOptions(), getSearchFormDuplicateParameters(), Request.getUser(), Request.getUserDateVar(), Request.getUserVar(), setupTemplate(), and validate().

EditorHandler.setEditorFlags

(

$

args

)

Set the canEdit / canReview flags for this submission's edit assignments.

Definition at line 285 of file EditorHandler.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), Request.getUserVar(), Request.redirect(), and validate().

EditorHandler.setupTemplate	(	$	level = EDITOR_SECTION_HOME,
		$	articleId = 0,
		$	parentPage = null
	)

Setup common template variables.

Parameters:

$level

int set to 0 if caller is at the same level as this handler in the hierarchy; otherwise the number of levels below this handler

Definition at line 469 of file EditorHandler.inc.php.

References Request.getJournal(), TemplateManager.getManager(), Request.getRequestedPage(), SectionEditorAction.submissionBreadcrumb(), and Request.url().

Referenced by assignEditor(), index(), SectionEditorHandler.setupTemplate(), IssueManagementHandler.setupTemplate(), and submissions().

EditorHandler.submissions

(

$

args

)

Display editor submission queue pages.

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

References DAORegistry.getDAO(), getDateFieldOptions(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), getSearchFieldOptions(), getSearchFormDuplicateParameters(), Request.getUser(), Request.getUserDateVar(), Request.getUserVar(), setupTemplate(), and validate().

EditorHandler.validate

(

)

Validate that user is an editor in the selected journal. Redirects to user index page if not properly authenticated.

Reimplemented from SectionEditorHandler.

Definition at line 458 of file EditorHandler.inc.php.

References Request.getJournal(), Validation.isEditor(), and Validation.redirectLogin().

Referenced by assignEditor(), IssueManagementHandler.backIssues(), IssueManagementHandler.createIssue(), deleteEditAssignment(), deleteSubmission(), IssueManagementHandler.editIssue(), IssueManagementHandler.futureIssues(), index(), IssueManagementHandler.issueData(), IssueManagementHandler.issueToc(), IssueManagementHandler.moveArticleToc(), IssueManagementHandler.moveIssue(), IssueManagementHandler.moveSectionToc(), IssueManagementHandler.notifyUsers(), IssueManagementHandler.publishIssue(), IssueManagementHandler.removeCoverPage(), IssueManagementHandler.removeIssue(), IssueManagementHandler.removeStyleFile(), IssueManagementHandler.resetIssueOrder(), IssueManagementHandler.resetSectionOrder(), IssueManagementHandler.saveIssue(), IssueManagementHandler.setCurrentIssue(), setEditorFlags(), submissions(), and IssueManagementHandler.updateIssueToc().

---

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

• pages/editor/EditorHandler.inc.php