Open Journal Systems  3.3.0
PKPHandler Class Reference
Inheritance diagram for PKPHandler:
APIHandler CriticalTimesIssueTocHandler GridHandler Handler UserApiHandler IssueHandler PKPAnnouncementHandler PKPBackendPaymentsSettingsHandler PKPBackendSubmissionsHandler PKPContextHandler PKPEmailTemplateHandler PKPSiteHandler PKPStatsEditorialHandler PKPStatsPublicationHandler PKPStatsUserHandler PKPSubmissionHandler PKPTemporaryFilesHandler PKPUploadPublicFileHandler PKPUserHandler PKPVocabHandler AnnouncementTypeGridHandler ArticleGalleyGridHandler AuthorGridHandler CategoryGridHandler ContextGridHandler CustomBlockGridHandler ExportableUsersGridHandler ExportPublishedSubmissionsListGridHandler IssueGalleyGridHandler IssueGridHandler LanguageGridHandler ListbuilderHandler NavigationMenuItemsGridHandler NavigationMenusGridHandler NotificationsGridHandler PaymentsGridHandler PKPReviewerGridHandler PLNStatusGridHandler PluginGalleryGridHandler PubIdExportIssuesListGridHandler PubIdExportRepresentationsListGridHandler QueriesGridHandler QueryNotesGridHandler ReviewFormElementsGridHandler ReviewFormGridHandler SetupGridHandler StaticPageGridHandler SubmissionEventLogGridHandler SubmissionFilesGridHandler SubscriberSelectGridHandler SubscriptionsGridHandler SubscriptionTypesGridHandler SwordDepositPointsGridHandler UserGridHandler UserGroupGridHandler UserSelectGridHandler AboutContextHandler AboutSiteHandler AdminHandler AnnouncementHandler ArticleHandler AssignToIssueHandler AuthorDashboardTabHandler BrowseBySectionHandler CitationStyleLanguageHandler DashboardHandler DocumentLibraryHandler FileApiHandler GatewayHandler HelpHandler InformationCenterHandler InformationHandler InstallHandler LibraryFileHandler LoginHandler ManageIssuesHandler ManagementHandler MarkupBatchConversionHandler MarkupHandler MarkupSettingsTabHandler NavigationMenuItemHandler NotificationHandler OAIHandler OrcidHandler PageHandler PaymentHandler PaymentsHandler PKPAuthorDashboardHandler PKPCatalogHandler PKPEditorDecisionHandler PKPFileUploadWizardHandler PKPIndexHandler PKPManageFileApiHandler PKPReviewerHandler PKPReviewRoundTabHandler PKPSitemapHandler PKPStatsHandler PKPWorkflowHandler PKPWorkflowTabHandler PLNHandler ProfileTabHandler PublishHandler ReportGeneratorHandler SearchHandler StaticPagesHandler SwordHandler SwordSettingsTabHandler TextureHandler UsageStatsHandler

Public Member Functions

 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Static Public Member Functions

static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 

Data Fields

 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Protected Attributes

 $_apiToken = null
 

Detailed Description

Base request handler abstract class.

Definition at line 17 of file PKPHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPHandler::__construct ( )

Constructor

Reimplemented in PKPFileUploadWizardHandler, PKPReviewerGridHandler, APIHandler, SubmissionEventLogGridHandler, UserGroupGridHandler, AuthorGridHandler, QueriesGridHandler, StaticPageGridHandler, AssignToIssueHandler, FileInformationCenterHandler, PublishHandler, ArticleGalleyGridHandler, QueryNotesGridHandler, SwordDepositPointsGridHandler, CategoryCategoryGridHandler, FileApiHandler, ManageReviewFilesGridHandler, ReviewFormElementsGridHandler, AuthorReviewerGridHandler, StageParticipantGridHandler, InformationCenterHandler, DashboardHandler, PubIdExportIssuesListGridHandler, PubIdExportRepresentationsListGridHandler, SubscriberSelectGridHandler, ReviewFormGridHandler, UserGridHandler, UserSelectGridHandler, PKPToolsHandler, CustomBlockGridHandler, MarkupSettingsTabHandler, IssueGridHandler, ExportPublishedSubmissionsListGridHandler, PluginGalleryGridHandler, SetupListbuilderHandler, PKPWorkflowTabHandler, PKPAuthorDashboardHandler, ManageIssuesHandler, MarkupBatchConversionHandler, MarkupHandler, PLNStatusGridHandler, TextureHandler, SubscriptionTypesGridHandler, PKPContextHandler, PKPSiteHandler, PKPStatsPublicationHandler, ExportableUsersGridHandler, DocumentLibraryHandler, PKPStatsHandler, SubscriptionsGridHandler, TocGridHandler, ReviewRoundTabHandler, PKPBackendSubmissionsHandler, AdminLanguageGridHandler, AdminHandler, PaymentsHandler, SwordSettingsTabHandler, IssueHandler, ManageFileApiHandler, PaymentsGridHandler, EditorDecisionHandler, PKPAnnouncementHandler, PKPStatsEditorialHandler, PKPStatsUserHandler, PKPSubmissionHandler, PKPUserHandler, PKPVocabHandler, PKPManageFileApiHandler, NavigationMenuItemsGridHandler, AuthorDashboardReviewRoundTabHandler, AuthorDashboardTabHandler, WorkflowHandler, SwordHandler, CriticalTimesIssueTocHandler, BackendSubmissionsHandler, PKPBackendPaymentsSettingsHandler, DependentFilesGridHandler, SelectableLibraryFileGridHandler, LanguageGridHandler, GenreGridHandler, LibraryFileAdminGridHandler, SubmissionChecklistGridHandler, ReportGeneratorHandler, SubmissionHandler, IssueGalleyGridHandler, SectionGridHandler, ContextGridHandler, AnnouncementTypeGridHandler, AuthorOpenReviewAttachmentsGridHandler, AuthorReviewAttachmentsGridHandler, CopyeditFilesGridHandler, FinalDraftFilesGridHandler, QueryNoteFilesGridHandler, EditorReviewFilesGridHandler, LimitReviewFilesGridHandler, SelectableReviewRevisionsGridHandler, AuthorSubmissionDetailsFilesGridHandler, SubmissionWizardFilesGridHandler, SubmissionDocumentsFilesGridHandler, NavigationMenusGridHandler, SettingsHandler, BackIssueGridHandler, SettingsPluginGridHandler, AdminPluginGridHandler, EditorReviewAttachmentsGridHandler, ManageCopyeditFilesGridHandler, SelectableCopyeditFilesGridHandler, ManageFinalDraftFilesGridHandler, SelectableFinalDraftFilesGridHandler, ProductionReadyFilesGridHandler, ManageProofFilesGridHandler, ManageQueryNoteFilesGridHandler, AuthorReviewRevisionsGridHandler, ReviewerReviewFilesGridHandler, WorkflowReviewRevisionsGridHandler, EditorSubmissionDetailsFilesGridHandler, SelectableSubmissionDetailsFilesGridHandler, ManageLanguageGridHandler, SetupGridHandler, AboutContextHandler, AboutSiteHandler, HelpHandler, ReviewerHandler, StatsHandler, PKPEmailTemplateHandler, EditorSelectableReviewAttachmentsGridHandler, ReviewerReviewAttachmentsGridHandler, PKPUploadPublicFileHandler, and PKPTemporaryFilesHandler.

Definition at line 85 of file PKPHandler.inc.php.

Member Function Documentation

◆ addPolicy()

PKPHandler::addPolicy (   $authorizationPolicy,
  $addToTop = false 
)

Add an authorization policy for this handler which will be applied in the authorize() method.

Policies must be added in the class constructor or in the subclasses' authorize() method before the parent::authorize() call so that PKPHandler::authorize() will be able to enforce them.

Parameters
$authorizationPolicyAuthorizationPolicy
$addToTopboolean whether to insert the new policy to the top of the list.

Definition at line 157 of file PKPHandler.inc.php.

Referenced by GatewayHandler\__construct(), BrowseBySectionHandler\authorize(), LoginHandler\authorize(), InformationHandler\authorize(), SearchHandler\authorize(), OrcidHandler\authorize(), AnnouncementHandler\authorize(), PageHandler\authorize(), PLNHandler\authorize(), PKPReviewRoundTabHandler\authorize(), FileUploadWizardHandler\authorize(), PKPCatalogHandler\authorize(), PKPEditorDecisionHandler\authorize(), AboutContextHandler\authorize(), ProfileHandler\authorize(), ProfileTabHandler\authorize(), UserApiHandler\authorize(), ReportGeneratorHandler\authorize(), PKPWorkflowHandler\authorize(), ReviewerHandler\authorize(), ManageLanguageGridHandler\authorize(), AuthorDashboardTabHandler\authorize(), AuthorDashboardReviewRoundTabHandler\authorize(), PKPManageFileApiHandler\authorize(), ContextGridHandler\authorize(), CriticalTimesIssueTocHandler\authorize(), DashboardHandler\authorize(), PKPWorkflowTabHandler\authorize(), PaymentsGridHandler\authorize(), SwordSettingsTabHandler\authorize(), IssueGalleyGridHandler\authorize(), ManageIssuesHandler\authorize(), ReviewRoundTabHandler\authorize(), FileApiHandler\authorize(), PKPStatsHandler\authorize(), PKPStatsUserHandler\authorize(), PKPVocabHandler\authorize(), TocGridHandler\authorize(), ExportableUsersGridHandler\authorize(), SubscriptionsGridHandler\authorize(), ExportPublishedSubmissionsListGridHandler\authorize(), SwordHandler\authorize(), TextureHandler\authorize(), AnnouncementTypeGridHandler\authorize(), PubIdExportIssuesListGridHandler\authorize(), PubIdExportRepresentationsListGridHandler\authorize(), MarkupBatchConversionHandler\authorize(), NavigationMenusGridHandler\authorize(), SetupGridHandler\authorize(), SubscriberSelectGridHandler\authorize(), SubscriptionTypesGridHandler\authorize(), UserSelectGridHandler\authorize(), LimitReviewFilesGridHandler\authorize(), SwordDepositPointsGridHandler\authorize(), PKPBackendPaymentsSettingsHandler\authorize(), AdminLanguageGridHandler\authorize(), ManageProofFilesGridHandler\authorize(), NavigationMenuItemsGridHandler\authorize(), ReviewFormElementsGridHandler\authorize(), EditorDecisionHandler\authorize(), CustomBlockGridHandler\authorize(), PKPTemporaryFilesHandler\authorize(), PKPUploadPublicFileHandler\authorize(), DependentFilesGridHandler\authorize(), QueryNoteFilesGridHandler\authorize(), MarkupHandler\authorize(), UserGridHandler\authorize(), PKPAuthorDashboardHandler\authorize(), ArticleHandler\authorize(), ManagementHandler\authorize(), AdminPluginGridHandler\authorize(), PKPStatsEditorialHandler\authorize(), InformationCenterHandler\authorize(), AdminHandler\authorize(), SubmissionFileEventLogGridHandler\authorize(), DocumentLibraryHandler\authorize(), FileInformationCenterHandler\authorize(), IssueGridHandler\authorize(), PaymentsHandler\authorize(), StaticPageGridHandler\authorize(), PKPUserHandler\authorize(), IssueHandler\authorize(), SetupListbuilderHandler\authorize(), CategoryCategoryGridHandler\authorize(), PublishHandler\authorize(), PKPBackendSubmissionsHandler\authorize(), AssignToIssueHandler\authorize(), PKPSiteHandler\authorize(), UserGroupGridHandler\authorize(), PKPAnnouncementHandler\authorize(), PKPStatsPublicationHandler\authorize(), PKPEmailTemplateHandler\authorize(), SettingsPluginGridHandler\authorize(), StageParticipantGridHandler\authorize(), QueryNotesGridHandler\authorize(), PKPReviewerGridHandler\authorize(), PKPContextHandler\authorize(), SubmissionEventLogGridHandler\authorize(), ArticleGalleyGridHandler\authorize(), PLNStatusGridHandler\authorize(), AuthorGridHandler\authorize(), PluginGalleryGridHandler\authorize(), AuthorReviewerGridHandler\authorize(), QueriesGridHandler\authorize(), PKPSubmissionHandler\authorize(), ReviewFormGridHandler\authorize(), authorize(), and GridHandler\authorize().

◆ addRoleAssignment()

PKPHandler::addRoleAssignment (   $roleIds,
  $operations 
)

Add role - operation assignments to the handler.

Parameters
$roleIdsinteger|array one or more of the ROLE_ID_* constants
$operationsstring|array a single method name or an array of method names to be assigned.

Definition at line 213 of file PKPHandler.inc.php.

Referenced by EditorSelectableReviewAttachmentsGridHandler\__construct(), ReviewerReviewAttachmentsGridHandler\__construct(), BackIssueGridHandler\__construct(), ProductionReadyFilesGridHandler\__construct(), ReviewerHandler\__construct(), ReviewerReviewFilesGridHandler\__construct(), ManageCopyeditFilesGridHandler\__construct(), SelectableCopyeditFilesGridHandler\__construct(), SelectableFinalDraftFilesGridHandler\__construct(), SelectableSubmissionDetailsFilesGridHandler\__construct(), ManageFinalDraftFilesGridHandler\__construct(), SettingsPluginGridHandler\__construct(), SetupGridHandler\__construct(), ManageLanguageGridHandler\__construct(), AdminPluginGridHandler\__construct(), EditorReviewAttachmentsGridHandler\__construct(), ManageProofFilesGridHandler\__construct(), ManageQueryNoteFilesGridHandler\__construct(), WorkflowReviewRevisionsGridHandler\__construct(), AuthorReviewRevisionsGridHandler\__construct(), EditorSubmissionDetailsFilesGridHandler\__construct(), AnnouncementTypeGridHandler\__construct(), FinalDraftFilesGridHandler\__construct(), IssueGalleyGridHandler\__construct(), QueryNoteFilesGridHandler\__construct(), ContextGridHandler\__construct(), CopyeditFilesGridHandler\__construct(), AuthorOpenReviewAttachmentsGridHandler\__construct(), SectionGridHandler\__construct(), LimitReviewFilesGridHandler\__construct(), SelectableReviewRevisionsGridHandler\__construct(), SettingsHandler\__construct(), SubmissionDocumentsFilesGridHandler\__construct(), SubmissionWizardFilesGridHandler\__construct(), EditorReviewFilesGridHandler\__construct(), NavigationMenusGridHandler\__construct(), AuthorReviewAttachmentsGridHandler\__construct(), AuthorSubmissionDetailsFilesGridHandler\__construct(), LibraryFileAdminGridHandler\__construct(), GenreGridHandler\__construct(), ReportGeneratorHandler\__construct(), LanguageGridHandler\__construct(), DependentFilesGridHandler\__construct(), SubmissionChecklistGridHandler\__construct(), SubmissionHandler\__construct(), PluginGridHandler\__construct(), AuthorDashboardReviewRoundTabHandler\__construct(), AuthorDashboardTabHandler\__construct(), WorkflowHandler\__construct(), EditorDecisionHandler\__construct(), CriticalTimesIssueTocHandler\__construct(), ManageFileApiHandler\__construct(), SwordHandler\__construct(), NavigationMenuItemsGridHandler\__construct(), PaymentsGridHandler\__construct(), PKPManageFileApiHandler\__construct(), AdminLanguageGridHandler\__construct(), ReviewRoundTabHandler\__construct(), SubscriptionsGridHandler\__construct(), AdminHandler\__construct(), SwordSettingsTabHandler\__construct(), TocGridHandler\__construct(), PaymentsHandler\__construct(), DocumentLibraryHandler\__construct(), SubscriptionTypesGridHandler\__construct(), ExportableUsersGridHandler\__construct(), PKPStatsHandler\__construct(), IssueGridHandler\__construct(), PKPWorkflowTabHandler\__construct(), PLNStatusGridHandler\__construct(), PluginGalleryGridHandler\__construct(), SetupListbuilderHandler\__construct(), TextureHandler\__construct(), ExportPublishedSubmissionsListGridHandler\__construct(), ManageIssuesHandler\__construct(), MarkupBatchConversionHandler\__construct(), MarkupHandler\__construct(), PKPAuthorDashboardHandler\__construct(), PKPToolsHandler\__construct(), PubIdExportIssuesListGridHandler\__construct(), SubscriberSelectGridHandler\__construct(), UserSelectGridHandler\__construct(), MarkupSettingsTabHandler\__construct(), ReviewFormGridHandler\__construct(), CustomBlockGridHandler\__construct(), PubIdExportRepresentationsListGridHandler\__construct(), UserGridHandler\__construct(), AuthorReviewerGridHandler\__construct(), InformationCenterHandler\__construct(), StageParticipantGridHandler\__construct(), FileApiHandler\__construct(), ReviewFormElementsGridHandler\__construct(), ManageReviewFilesGridHandler\__construct(), DashboardHandler\__construct(), CategoryCategoryGridHandler\__construct(), QueryNotesGridHandler\__construct(), ArticleGalleyGridHandler\__construct(), SwordDepositPointsGridHandler\__construct(), LibraryFileGridHandler\__construct(), PublishHandler\__construct(), FileInformationCenterHandler\__construct(), AssignToIssueHandler\__construct(), StaticPageGridHandler\__construct(), QueriesGridHandler\__construct(), AuthorGridHandler\__construct(), UserGroupGridHandler\__construct(), SubmissionEventLogGridHandler\__construct(), PKPReviewerGridHandler\__construct(), PKPFileUploadWizardHandler\__construct(), and APIHandler\setupEndpoints().

◆ authorize()

PKPHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented in GridHandler, SelectableSubmissionFileListCategoryGridHandler, ReviewFormGridHandler, PKPSubmissionHandler, QueriesGridHandler, AuthorReviewerGridHandler, SubmissionFilesGridHandler, PluginGalleryGridHandler, AuthorGridHandler, PLNStatusGridHandler, ArticleGalleyGridHandler, PKPContextHandler, SubmissionEventLogGridHandler, PKPReviewerGridHandler, QueryNotesGridHandler, StageParticipantGridHandler, SettingsPluginGridHandler, PKPEmailTemplateHandler, PKPStatsPublicationHandler, PKPAnnouncementHandler, UserGroupGridHandler, AssignToIssueHandler, PKPSiteHandler, PKPBackendSubmissionsHandler, PublishHandler, CategoryCategoryGridHandler, SetupListbuilderHandler, IssueHandler, PKPUserHandler, StaticPageGridHandler, IssueGridHandler, PaymentsHandler, FileInformationCenterHandler, DocumentLibraryHandler, SubmissionFileEventLogGridHandler, AdminHandler, InformationCenterHandler, PKPStatsEditorialHandler, AdminPluginGridHandler, ManagementHandler, ArticleHandler, PKPUploadPublicFileHandler, PKPTemporaryFilesHandler, UserGridHandler, PKPAuthorDashboardHandler, MarkupHandler, EditorDecisionHandler, AdminLanguageGridHandler, ManageProofFilesGridHandler, NavigationMenuItemsGridHandler, ReviewFormElementsGridHandler, CustomBlockGridHandler, PKPBackendPaymentsSettingsHandler, LimitReviewFilesGridHandler, SwordDepositPointsGridHandler, PubIdExportIssuesListGridHandler, PubIdExportRepresentationsListGridHandler, SubscriptionTypesGridHandler, SubscriberSelectGridHandler, NavigationMenusGridHandler, UserSelectGridHandler, MarkupBatchConversionHandler, ExportPublishedSubmissionsListGridHandler, SubscriptionsGridHandler, TocGridHandler, PKPStatsUserHandler, PKPVocabHandler, AnnouncementTypeGridHandler, ExportableUsersGridHandler, SwordHandler, TextureHandler, IssueGalleyGridHandler, ReviewRoundTabHandler, FileApiHandler, PKPStatsHandler, ManageIssuesHandler, PaymentsGridHandler, PKPWorkflowTabHandler, DashboardHandler, SwordSettingsTabHandler, CriticalTimesIssueTocHandler, ContextGridHandler, PKPManageFileApiHandler, ManageLanguageGridHandler, AuthorDashboardReviewRoundTabHandler, AuthorDashboardTabHandler, PKPWorkflowHandler, ReviewerHandler, ReportGeneratorHandler, UserApiHandler, ProfileTabHandler, NavigationMenuItemHandler, SubmissionInformationCenterHandler, AboutContextHandler, ProfileHandler, IssueHandler, FileUploadWizardHandler, PKPEditorDecisionHandler, PKPCatalogHandler, PKPReviewRoundTabHandler, PLNHandler, PageHandler, PKPSubmissionHandler, AnnouncementHandler, OrcidHandler, SearchHandler, LoginHandler, InformationHandler, and BrowseBySectionHandler.

Definition at line 288 of file PKPHandler.inc.php.

References addPolicy(), and requireSSL().

◆ getApiToken()

PKPHandler::getApiToken ( )

Return API token string

Returns
string|null

Definition at line 560 of file PKPHandler.inc.php.

References $_apiToken.

◆ getAuthorizedContext()

& PKPHandler::getAuthorizedContext ( )

Get the authorized context.

NB: You should avoid accessing the authorized context directly to avoid accidentally overwriting an object in the context. Try to use getAuthorizedContextObject() instead where possible.

Returns
array

Definition at line 189 of file PKPHandler.inc.php.

Referenced by GridHandler\authorize(), and QueriesGridHandler\getAccessHelper().

◆ getAuthorizedContextObject()

& PKPHandler::getAuthorizedContextObject (   $assocType)

Retrieve authorized context objects from the decision manager.

Parameters
$assocTypeinteger any of the ASSOC_TYPE_* constants
Returns
mixed

Definition at line 174 of file PKPHandler.inc.php.

Referenced by StageParticipantGridHandler\_canAdminister(), AdminLanguageGridHandler\_canManage(), MarkupHandler\_conversion(), PKPReviewerGridHandler\_fetchReviewerForm(), QueriesGridHandler\_getCurrentUserCanLeave(), SubmissionDocumentsFilesGridHandler\_getEditFileForm(), PKPEditorDecisionHandler\_getEditorDecisionForm(), PKPFileUploadWizardHandler\_getMetadataForm(), SubmissionDocumentsFilesGridHandler\_getNewFileForm(), LoginHandler\_redirectAfterLogin(), PKPWorkflowHandler\_redirectToIndex(), PKPReviewerHandler\_retrieveStep(), PKPReviewRoundTabHandler\_reviewRound(), PKPEditorDecisionHandler\_saveEditorDecision(), EditorDecisionHandler\_saveGeneralPromote(), PKPWorkflowHandler\access(), IssueGridHandler\access(), PKPSubmissionHandler\addPublication(), PKPSubmissionHandler\authorize(), PKPEditorDecisionHandler\authorize(), SubmissionInformationCenterHandler\authorize(), QueryNoteFilesGridHandler\authorize(), PKPReviewerGridHandler\authorize(), SubmissionEventLogGridHandler\authorize(), AuthorGridHandler\canAdminister(), ArticleGalleyGridHandler\canEdit(), IssueGridHandler\clearIssueObjectsPubIds(), ManageFileApiHandler\clearPubId(), IssueGridHandler\clearPubId(), IssueGalleyGridHandler\delete(), PKPSubmissionHandler\delete(), PKPContextHandler\delete(), PKPManageFileApiHandler\deleteFile(), IssueGridHandler\deleteIssue(), PluginGridHandler\deletePlugin(), PKPSubmissionHandler\deletePublication(), PluginGridHandler\disable(), DocumentLibraryHandler\documentLibrary(), IssueHandler\download(), IssueGalleyGridHandler\download(), FileApiHandler\downloadAllFiles(), FileApiHandler\downloadFile(), IssueGalleyGridHandler\edit(), PKPEmailTemplateHandler\edit(), PKPContextHandler\edit(), PKPSubmissionHandler\edit(), IssueGridHandler\editIssue(), IssueGridHandler\editIssueData(), PKPManageFileApiHandler\editMetadata(), PKPManageFileApiHandler\editMetadataTab(), PKPWorkflowHandler\editorDecisionActions(), PKPSubmissionHandler\editPublication(), PKPReviewerGridHandler\editReminder(), PKPReviewerGridHandler\editReview(), PKPReviewerGridHandler\editThankReviewer(), PKPContextHandler\editTheme(), PluginGridHandler\enable(), AuthorDashboardReviewRoundTabHandler\fetchReviewRoundInfo(), WorkflowTabHandler\fetchTab(), AuthorDashboardTabHandler\fetchTab(), PKPWorkflowTabHandler\fetchTab(), StageParticipantGridHandler\fetchTemplateBody(), StageParticipantGridHandler\fetchUserList(), MarkupBatchConversionHandler\filesToConvert(), PKPContextHandler\get(), IssueHandler\get(), PKPSubmissionHandler\get(), PKPStatsPublicationHandler\get(), PKPStatsPublicationHandler\getAbstract(), SubmissionDocumentsFilesGridHandler\getActionArgs(), QueryNotesGridHandler\getCanManage(), TocGridHandler\getDataElementSequence(), SubmissionFileEventLogGridHandler\getFilterForm(), ArticleGalleyGridHandler\getGalley(), PKPStatsPublicationHandler\getGalley(), TextureHandler\getGalley(), PubIdExportSubmissionsListGridHandler\getGridCellProvider(), ExportPublishedSubmissionsListGridHandler\getGridCellProvider(), PKPBackendSubmissionsHandler\getMany(), PKPContextHandler\getMany(), PKPSubmissionHandler\getMany(), PKPSubmissionHandler\getParticipants(), ArticleGalleyGridHandler\getPublication(), AuthorGridHandler\getPublication(), PKPSubmissionHandler\getPublication(), PKPSubmissionHandler\getPublications(), QueryNotesGridHandler\getQuery(), QueriesGridHandler\getQuery(), DependentFilesGridHandler\getRequestArgs(), ManageProofFilesGridHandler\getRequestArgs(), IssueGalleyGridHandler\getRequestArgs(), ManageReviewFilesGridHandler\getRequestArgs(), TocGridHandler\getRequestArgs(), UserSelectGridHandler\getRequestArgs(), PKPReviewerGridHandler\getReviewRound(), PKPFileUploadWizardHandler\getReviewRound(), AdminPluginGridHandler\getRowInstance(), SettingsPluginGridHandler\getRowInstance(), SubmissionDocumentsFilesGridHandler\getRowInstance(), TocGridHandler\getRowInstance(), IssueGalleyGridHandler\getRowInstance(), StageParticipantGridHandler\getStageId(), QueryNotesGridHandler\getStageId(), PKPFileUploadWizardHandler\getStageId(), QueryNotesGridHandler\getSubmission(), ArticleGalleyGridHandler\getSubmission(), StageParticipantGridHandler\getSubmission(), AuthorGridHandler\getSubmission(), QueriesGridHandler\getSubmission(), SelectableSubmissionFileListCategoryGridHandler\getSubmission(), SubmissionFilesGridHandler\getSubmission(), PKPFileUploadWizardHandler\getSubmission(), PKPReviewerGridHandler\getSubmission(), TextureHandler\getSubmission(), PKPContextHandler\getTheme(), PKPReviewerGridHandler\gossip(), ManageFileApiHandler\identifiers(), IssueGridHandler\identifiers(), PKPEditorDecisionHandler\importPeerReviews(), DashboardHandler\index(), PKPWorkflowHandler\index(), DocumentLibraryHandler\initialize(), PluginGridHandler\initialize(), IssueHandler\initialize(), PublishHandler\initialize(), AssignToIssueHandler\initialize(), SubscriberSelectGridHandler\initialize(), TocGridHandler\initialize(), UserSelectGridHandler\initialize(), PubIdExportIssuesListGridHandler\initialize(), PubIdExportRepresentationsListGridHandler\initialize(), SubmissionFileEventLogGridHandler\initialize(), InformationCenterHandler\initialize(), CopyeditFilesGridHandler\initialize(), FileInformationCenterHandler\initialize(), SubmissionEventLogGridHandler\initialize(), ManageQueryNoteFilesGridHandler\isDataElementInCategorySelected(), SelectableSubmissionFileListCategoryGridHandler\isDataElementInCategorySelected(), LimitReviewFilesGridHandler\isDataElementSelected(), IssueGridHandler\issueGalleys(), IssueGridHandler\issueToc(), TextureHandler\json(), SettingsPluginGridHandler\loadCategoryData(), UserSelectGridHandler\loadData(), TocGridHandler\loadData(), IssueGalleyGridHandler\loadData(), PluginGridHandler\manage(), MarkupHandler\media(), TextureHandler\media(), PKPWorkflowHandler\notificationOptionsByStage(), NavigationMenuItemHandler\preview(), IssueGridHandler\publishIssue(), PKPSubmissionHandler\publishPublication(), AuthorReviewerGridHandler\readReview(), PKPReviewerGridHandler\readReview(), PKPAuthorDashboardHandler\readSubmissionEmail(), FileApiHandler\recordDownload(), PKPReviewerGridHandler\reinstateReviewer(), TocGridHandler\removeArticle(), UserSelectGridHandler\renderFilter(), PKPReviewerGridHandler\reviewHistory(), ReviewerGridHandler\reviewRead(), PKPReviewerGridHandler\reviewRead(), PKPReviewerHandler\saveDeclineReview(), PKPEditorDecisionHandler\saveExternalReview(), PKPManageFileApiHandler\saveMetadata(), EditorDecisionHandler\saveNewReviewRound(), PKPEditorDecisionHandler\saveRecommendation(), PKPReviewerHandler\saveStep(), PKPSubmissionHandler\saveStep(), CriticalTimesIssueTocHandler\saveToc(), QueryNoteFilesGridHandler\selectFiles(), PKPReviewerGridHandler\sendEmail(), StageParticipantGridHandler\sendNotification(), PKPEditorDecisionHandler\sendRecommendation(), PKPReviewerGridHandler\sendReminder(), TocGridHandler\setAccessStatus(), IssueGridHandler\setCurrentIssue(), TocGridHandler\setDataElementSequence(), WorkflowHandler\setupIndex(), PKPAuthorDashboardHandler\setupTemplate(), PKPWorkflowTabHandler\setupTemplate(), setupTemplate(), PKPReviewerHandler\showDeclineReview(), PKPReviewerHandler\step(), PKPSubmissionHandler\step(), PKPReviewerHandler\submission(), PKPWorkflowHandler\submissionProgressBar(), AboutContextHandler\submissions(), PKPReviewerGridHandler\thankReviewer(), MarkupHandler\triggerConversion(), PKPReviewerGridHandler\unassignReviewer(), PKPReviewerGridHandler\unconsiderReview(), IssueGridHandler\unpublishIssue(), PKPSubmissionHandler\unpublishPublication(), IssueGalleyGridHandler\update(), IssueGridHandler\updateAccess(), ManageFileApiHandler\updateIdentifiers(), IssueGridHandler\updateIdentifiers(), IssueGridHandler\updateIssue(), ManageProofFilesGridHandler\updateProofFiles(), ManageQueryNoteFilesGridHandler\updateQueryNoteFiles(), PKPReviewerGridHandler\updateReinstateReviewer(), PKPReviewerGridHandler\updateReview(), PKPReviewerGridHandler\updateUnassignReviewer(), PKPUploadPublicFileHandler\uploadFile(), IssueHandler\userCanViewGalley(), PKPSubmissionHandler\versionPublication(), StaticPagesHandler\view(), IssueHandler\view(), SubmissionDocumentsFilesGridHandler\viewLibrary(), StageParticipantGridHandler\viewNotify(), and PKPSubmissionHandler\wizard().

◆ getDispatcher()

& PKPHandler::getDispatcher ( )

Get the dispatcher

NB: The dispatcher will only be set after handler instantiation. Calling getDispatcher() in the constructor will fail.

Returns
Dispatcher

Definition at line 120 of file PKPHandler.inc.php.

References $_dispatcher.

Referenced by PKPEditorDecisionHandler\_saveEditorDecision(), PKPCatalogHandler\category(), PKPCatalogHandler\fullSize(), index(), AboutSiteHandler\privacy(), and PKPCatalogHandler\thumbnail().

◆ getFirstUserContext()

PKPHandler::getFirstUserContext (   $user,
  $contexts 
)

Return the first context that user is enrolled with.

Parameters
$userUser
$contextsArray
Returns
mixed Either Context or null

Definition at line 534 of file PKPHandler.inc.php.

References DAORegistry\getDAO().

◆ getId()

PKPHandler::getId ( )

Get the controller id

Returns
string

Definition at line 107 of file PKPHandler.inc.php.

References $_id.

Referenced by PKPStatsPublicationHandler\_processAllowedParams(), PKPStatsPublicationHandler\_processSearchPhrase(), ArticleGalleyGridHandler\deleteGalley(), ArticleGalleyGridHandler\editGalley(), PKPWorkflowHandler\editorDecisionActions(), StageParticipantGridHandler\fetchTemplateBody(), PKPStatsPublicationHandler\getMany(), QueryNotesGridHandler\getRequestArgs(), ArticleGalleyGridHandler\getRequestArgs(), QueriesGridHandler\getRequestArgs(), FutureIssueGridHandler\initialize(), SubmissionChecklistGridHandler\initialize(), SectionGridHandler\initialize(), GenreGridHandler\initialize(), IssueGalleyGridHandler\initialize(), QueryNotesGridHandler\insertNote(), PLNStatusGridHandler\loadData(), PaymentsGridHandler\loadData(), UserSelectGridHandler\loadData(), IndividualSubscriptionsGridHandler\loadData(), InstitutionalSubscriptionsGridHandler\loadData(), SubscriptionTypesGridHandler\loadData(), UserGroupGridHandler\loadData(), UserGridHandler\loadData(), ExportableUsersGridHandler\loadData(), ArticleGalleyGridHandler\loadData(), StageParticipantGridHandler\loadData(), AuthorGridHandler\loadData(), UserSelectGridHandler\renderFilter(), PubIdExportIssuesListGridHandler\renderFilter(), ExportPublishedSubmissionsListGridHandler\renderFilter(), SubmissionFilesGridHandler\renderFilter(), PubIdExportRepresentationsListGridHandler\renderFilter(), FinalDraftFilesGridHandler\selectFiles(), CopyeditFilesGridHandler\selectFiles(), StageParticipantGridHandler\sendNotification(), PKPFileUploadWizardHandler\startWizard(), AuthorGridHandler\updateAuthor(), ArticleGalleyGridHandler\updateGalley(), StaticPagesHandler\view(), and StageParticipantGridHandler\viewNotify().

◆ getLastAuthorizationMessage()

PKPHandler::getLastAuthorizationMessage ( )

Retrieve the last authorization message from the decision manager.

Returns
string

Definition at line 199 of file PKPHandler.inc.php.

◆ getPageParamName()

static PKPHandler::getPageParamName (   $rangeName)
static

Get the range info page parameter name.

Parameters
$rangeNamestring
Returns
string

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

Referenced by GeneralPagingFeature\getRequestArgs(), and GeneralPagingFeature\setOptions().

◆ getRangeInfo()

static PKPHandler::getRangeInfo (   $request,
  $rangeName,
  $contextData = null 
)
static

Return the DBResultRange structure and misc. variables describing the current page of a set of pages.

Parameters
$requestPKPRequest
$rangeNamestring Symbolic name of range of pages; must match the Smarty {page_list ...} name.
$contextDataarray If set, this should contain a set of data that are required to define the context of this request (for maintaining page numbers across requests). To disable persistent page contexts, set this variable to null.
Returns
DBResultRange

Definition at line 417 of file PKPHandler.inc.php.

References Config\getVar(), and hashPageContext().

Referenced by SearchHandler\authors(), RecommendBySimilarityPlugin\callbackTemplateArticlePageFooter(), RecommendByAuthorPlugin\callbackTemplateArticlePageFooter(), PLNStatusForm\fetch(), SearchHandler\search(), and GeneralPagingFeature\setOptions().

◆ getRoleAssignment()

PKPHandler::getRoleAssignment (   $roleId)

This method returns an assignment of operation names for the given role.

Parameters
$roleIdint
Returns
array assignment for the given role.

Definition at line 246 of file PKPHandler.inc.php.

◆ getRoleAssignments()

PKPHandler::getRoleAssignments ( )

This method returns an assignment of roles to operation names.

Returns
array assignments for all roles.

Definition at line 261 of file PKPHandler.inc.php.

References $_roleAssignments.

◆ getSiteRedirectContext()

PKPHandler::getSiteRedirectContext (   $request)

Return the context that is configured in site redirect setting.

Parameters
$requestRequest
Returns
mixed Either Context or null

Definition at line 519 of file PKPHandler.inc.php.

References Application\getContextDAO().

Referenced by getTargetContext().

◆ getTargetContext()

PKPHandler::getTargetContext (   $request,
$contextsCount = null 
)

Returns a "best-guess" context, based in the request data, if a request needs to have one in its context but may be in a site-level context as specified in the URL.

Parameters
$requestRequest
$contextsCountint Optional reference to receive context count
Returns
mixed Either a Context or null if none could be determined.

Definition at line 580 of file PKPHandler.inc.php.

References Application\getContextDAO(), and getSiteRedirectContext().

Referenced by LoginHandler\_redirectAfterLogin(), and IndexHandler\index().

◆ hashPageContext()

static PKPHandler::hashPageContext (   $request,
  $contextData = array() 
)
static

Generate a unique-ish hash of the page's identity, including all context that differentiates it from other similar pages (e.g. all articles vs. all articles starting with "l").

Parameters
$requestPKPRequest
$contextDataarray A set of information identifying the page
Returns
string hash

Definition at line 505 of file PKPHandler.inc.php.

Referenced by getRangeInfo().

◆ index()

◆ initialize()

PKPHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters
$requestPKPRequest

Reimplemented in PKPFileUploadWizardHandler, AdminHandler, FileInformationCenterHandler, InformationCenterHandler, PKPEditorDecisionHandler, AssignToIssueHandler, PublishHandler, DocumentLibraryHandler, ManagementHandler, and RegistrationHandler.

Definition at line 387 of file PKPHandler.inc.php.

References setId(), PKPString\strtolower(), and PKPString\substr().

◆ markRoleAssignmentsChecked()

PKPHandler::markRoleAssignmentsChecked ( )

Flag role assignment checking as completed.

Definition at line 268 of file PKPHandler.inc.php.

Referenced by PKPSubmissionHandler\authorize(), and PKPWorkflowHandler\authorize().

◆ requireSSL()

PKPHandler::requireSSL ( )

Assume SSL is required for all handlers, unless overridden in subclasses.

Returns
boolean

Reimplemented in OAIHandler.

Definition at line 551 of file PKPHandler.inc.php.

Referenced by authorize().

◆ setApiToken()

PKPHandler::setApiToken (   $apiToken)

Set API token string

Definition at line 568 of file PKPHandler.inc.php.

Referenced by ArticleHandler\authorize(), and OAIHandler\validate().

◆ setDispatcher()

PKPHandler::setDispatcher (   $dispatcher)

Set the dispatcher

Parameters
$dispatcherPKPDispatcher

Definition at line 129 of file PKPHandler.inc.php.

◆ setEnforceRestrictedSite()

PKPHandler::setEnforceRestrictedSite (   $enforceRestrictedSite)

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

Referenced by OrcidHandler\authorize(), and PageHandler\authorize().

◆ setId()

PKPHandler::setId (   $id)

Set the controller id

Parameters
$idstring

Definition at line 99 of file PKPHandler.inc.php.

Referenced by SubmissionChecklistGridHandler\initialize(), and initialize().

◆ setupTemplate()

PKPHandler::setupTemplate (   $request)

Set up the basic template.

Parameters
$requestPKPRequest

Reimplemented in DashboardHandler, UserHandler, PKPWorkflowHandler, ArticleHandler, LoginHandler, SearchHandler, IssueHandler, FileInformationCenterHandler, PKPSubmissionHandler, PKPReviewerHandler, InformationCenterHandler, PKPWorkflowTabHandler, ReportGeneratorHandler, PKPCatalogHandler, InstallHandler, NotificationHandler, PKPAuthorDashboardHandler, InformationHandler, SubmissionHandler, PKPReviewRoundTabHandler, and PKPToolsHandler.

Definition at line 466 of file PKPHandler.inc.php.

References Registry\get(), getAuthorizedContextObject(), PKPTemplateManager\getManager(), Config\getVar(), and AppLocale\requireComponents().

Referenced by ManagementHandler\access(), ManagementHandler\announcements(), ProfileTabHandler\apiProfile(), PKPUserHandler\authorizationDenied(), ProfileTabHandler\changePassword(), GatewayHandler\clockss(), ProfileTabHandler\contact(), AboutContextHandler\contact(), ManagementHandler\context(), AdminHandler\contexts(), PKPManageFileApiHandler\deleteFile(), ManagementHandler\distribution(), CustomBlockGridHandler\editCustomBlock(), SwordDepositPointsGridHandler\editDepositPoint(), GenreGridHandler\editGenre(), PKPStatsHandler\editorial(), AboutContextHandler\editorialTeam(), SectionGridHandler\editSection(), StaticPageGridHandler\editStaticPage(), AuthorDashboardTabHandler\fetchTab(), ProfileTabHandler\identity(), IndexHandler\index(), PaymentsHandler\index(), AnnouncementHandler\index(), AboutContextHandler\index(), ManageIssuesHandler\index(), AdminHandler\index(), DocumentLibraryHandler\initialize(), PublishHandler\initialize(), AssignToIssueHandler\initialize(), GatewayHandler\lockss(), ProfileTabHandler\notificationSettings(), PaymentsHandler\paymentTypes(), NavigationMenuItemHandler\preview(), AboutSiteHandler\privacy(), UsageStatsHandler\privacyInformation(), PKPStatsHandler\publications(), ProfileTabHandler\publicProfile(), ProfileTabHandler\roles(), ProfileTabHandler\saveAPIProfile(), ProfileTabHandler\saveContact(), ProfileTabHandler\saveIdentity(), ProfileTabHandler\saveNotificationSettings(), ProfileTabHandler\savePassword(), PaymentsHandler\savePaymentTypes(), ProfileTabHandler\savePublicProfile(), ProfileTabHandler\saveRoles(), PaymentsHandler\saveSubscriptionPolicies(), StageParticipantGridHandler\sendNotification(), AdminHandler\settings(), AboutContextHandler\submissions(), PaymentsHandler\subscriptionPolicies(), AboutHandler\subscriptions(), AdminHandler\systemInfo(), PageHandler\tasks(), CustomBlockGridHandler\updateCustomBlock(), SwordDepositPointsGridHandler\updateDepositPoint(), ManageReviewFilesGridHandler\updateReviewFiles(), StaticPageGridHandler\updateStaticPage(), PKPStatsHandler\users(), StaticPagesHandler\view(), AnnouncementHandler\view(), NavigationMenuItemHandler\view(), StageParticipantGridHandler\viewNotify(), ManagementHandler\website(), AdminHandler\wizard(), and ManagementHandler\workflow().

◆ validate()

PKPHandler::validate (   $requiredContexts = null,
  $request = null 
)

Field Documentation

◆ $_apiToken

string null PKPHandler::$_apiToken = null
protected

API token

Definition at line 22 of file PKPHandler.inc.php.

Referenced by getApiToken().

◆ $_authorizationDecisionManager

AuthorizationDecisionManager PKPHandler::$_authorizationDecisionManager

authorization decision manager for this handler

Definition at line 62 of file PKPHandler.inc.php.

◆ $_checks

array PKPHandler::$_checks = array()

validation checks for this page - deprecated!

Definition at line 43 of file PKPHandler.inc.php.

◆ $_dispatcher

Dispatcher PKPHandler::$_dispatcher

mainly needed for cross-router url construction

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

Referenced by getDispatcher().

◆ $_enforceRestrictedSite

boolean PKPHandler::$_enforceRestrictedSite = true

Whether to enforce site access restrictions.

Definition at line 68 of file PKPHandler.inc.php.

◆ $_id

string PKPHandler::$_id

identifier of the controller instance - must be unique among all instances of a given controller type.

Definition at line 31 of file PKPHandler.inc.php.

Referenced by getId().

◆ $_isBackendPage

boolean PKPHandler::$_isBackendPage = false

Whether this is a handler for a page in the backend editorial UI

Definition at line 80 of file PKPHandler.inc.php.

◆ $_roleAssignments

array PKPHandler::$_roleAssignments = array()

The value of this variable should look like this: array( ROLE_ID_... => array(...allowed handler operations...), ... )

Definition at line 56 of file PKPHandler.inc.php.

Referenced by getRoleAssignments().

◆ $_roleAssignmentsChecked

boolean PKPHandler::$_roleAssignmentsChecked = false

Whether role assignments have been checked.

Definition at line 74 of file PKPHandler.inc.php.


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