Handler Class Reference
[Core]
Base request handler class.
More...
Public Member Functions | |
| getLoginExemptions () | |
| & | getRangeInfo ($rangeName, $contextData=null) |
| hashPageContext ($contextData=array()) | |
| index () | |
| validate ($requiresJournal=false) | |
Detailed Description
Base request handler class.Definition at line 18 of file Handler.inc.php.
Member Function Documentation
| Handler.getLoginExemptions | ( | ) |
Get a list of pages that don't require login, even if the journal does.
- Returns:
- array
Definition at line 60 of file Handler.inc.php.
Referenced by validate().
| & Handler.getRangeInfo | ( | $ | rangeName, | |
| $ | contextData = null | |||
| ) |
Return the DBResultRange structure and misc. variables describing the current page of a set of pages.
- Parameters:
-
$rangeName string Symbolic name of range of pages; must match the Smarty {page_list ...} name. $contextData array 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:
- array ($pageNum, $dbResultRange)
Definition at line 88 of file Handler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), Request.getSession(), Request.getUserVar(), Config.getVar(), and hashPageContext().
Referenced by SearchHandler.advancedResults(), AnnouncementHandler.announcements(), AnnouncementHandler.announcementTypes(), IssueHandler.archive(), EditorHandler.assignEditor(), SearchHandler.authors(), IssueManagementHandler.backIssues(), SampleImportExportPlugin.display(), PubMedExportPlugin.display(), NativeImportExportPlugin.display(), EruditExportPlugin.display(), CrossRefExportPlugin.display(), EmailHandler.emails(), SubmissionEditHandler.enrollSearch(), PeopleHandler.enrollSearch(), METSGatewayPlugin.fetch(), LayoutEditorHandler.futureIssues(), IssueManagementHandler.futureIssues(), GroupHandler.groupMembership(), GroupHandler.groups(), TranslatorHandler.index(), ThesisHandler.index(), CustomLocaleHandler.index(), SectionEditorHandler.index(), ReviewerHandler.index(), ProofreaderHandler.index(), EditorHandler.index(), CopyeditorHandler.index(), AuthorHandler.index(), AnnouncementHandler.index(), AdminJournalHandler.journals(), ThesisPlugin.manage(), PeopleHandler.mergeUsers(), AdminPeopleHandler.mergeUsers(), PeopleHandler.people(), SearchHandler.results(), ReviewFormHandler.reviewFormElements(), ReviewFormHandler.reviewForms(), SectionHandler.sections(), SubmissionEditHandler.selectReviewForm(), SubscriptionManagerHandler.selectSubscriber(), SubscriptionHandler.selectSubscriber(), SubmissionEditHandler.submissionEmailLog(), SubmissionEditHandler.submissionEmailLogType(), SubmissionEditHandler.submissionEventLog(), SubmissionEditHandler.submissionEventLogType(), SubmissionEditHandler.submissionHistory(), SubmissionEditHandler.submissionNotes(), LayoutEditorHandler.submissions(), EditorHandler.submissions(), SubscriptionManagerHandler.subscriptions(), SubscriptionHandler.subscriptions(), SubscriptionManagerHandler.subscriptionTypes(), SubscriptionHandler.subscriptionTypes(), SearchHandler.titles(), and ManagerPaymentHandler.viewPayments().
| Handler.hashPageContext | ( | $ | contextData = array() |
) |
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:
-
$contextData array A set of information identifying the page
- Returns:
- string hash
Definition at line 71 of file Handler.inc.php.
References Request.getRequestedJournalPath(), Request.getRequestedOp(), and Request.getRequestedPage().
Referenced by getRangeInfo().
| Handler.index | ( | ) |
Fallback method in case request handler does not implement index method.
Reimplemented in AboutHandler, AdminHandler, AnnouncementHandler, GatewayHandler, HelpHandler, InstallHandler, LayoutEditorHandler, LoginHandler, AnnouncementHandler, ManagerHandler, OAIHandler, RTAdminHandler, SearchHandler, SubscriptionManagerHandler, UserHandler, CounterHandler, CustomLocaleHandler, ThesisHandler, and TranslatorHandler.
Definition at line 23 of file Handler.inc.php.
| Handler.validate | ( | $ | requiresJournal = false |
) |
Perform request access validation based on security settings.
- Parameters:
-
$requiresJournal boolean
Reimplemented in AuthorHandler, SubmissionCommentsHandler, TrackSubmissionHandler, CommentHandler, SubmissionCommentsHandler, SubmissionCopyeditHandler, SubmissionCommentsHandler, SubmissionCommentsHandler, SubmissionProofreadHandler, SubmissionReviewHandler, SubmissionCommentsHandler, UserHandler, and CounterHandler.
Definition at line 32 of file Handler.inc.php.
References Request.getJournal(), getLoginExemptions(), Request.getProtocol(), Request.getRequestedPage(), Config.getVar(), Validation.isLoggedIn(), Request.redirect(), and Request.redirectSSL().
Referenced by ThesisHandler.save(), LoginHandler.savePassword(), and PeopleHandler.signOutAsUser().
The documentation for this class was generated from the following file:
- classes/core/Handler.inc.php
