Request Class Reference
[Core]

Class providing operations associated with HTTP requests. Requests are assumed to be in the format http://host.tld/index.php/<journal_id>/<page_name>/<operation_name>/<arguments...> <journal_id> is assumed to be "index" for top-level site requests. More...

List of all members.

Public Member Functions

 cleanUserVar (&$var, $stripHtml=false)
 getBasePath ()
 getBaseUrl ()
 getCompleteUrl ()
 getCookieVar ($key)
 getIndexUrl ()
getJournal ()
 getProtocol ()
 getQueryString ()
 getRemoteAddr ()
 getRemoteDomain ()
 getRequestedArgs ()
 getRequestedJournalPath ()
 getRequestedOp ()
 getRequestedPage ()
 getRequestMethod ()
 getRequestPath ()
 getRequestUrl ()
 getServerHost ($default= 'localhost')
getSession ()
getSite ()
getUser ()
 getUserAgent ()
 getUserDateVar ($prefix, $defaultDay=null, $defaultMonth=null, $defaultYear=null, $defaultHour=0, $defaultMinute=0, $defaultSecond=0)
 getUserVar ($key)
 isBot ()
 isGet ()
 isPathInfoEnabled ()
 isPost ()
 redirect ($journalPath=null, $page=null, $op=null, $path=null, $params=null, $anchor=null)
 redirectNonSSL ()
 redirectSSL ()
 redirectUrl ($url)
 setCookieVar ($key, $value)
 url ($journalPath=null, $page=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)


Detailed Description

Class providing operations associated with HTTP requests. Requests are assumed to be in the format http://host.tld/index.php/<journal_id>/<page_name>/<operation_name>/<arguments...> <journal_id> is assumed to be "index" for top-level site requests.

Definition at line 23 of file Request.inc.php.


Member Function Documentation

Request.cleanUserVar ( &$  var,
stripHtml = false 
)

Sanitize a user-submitted variable (i.e., GET/POST/Cookie variable). Strips slashes if necessary, then sanitizes variable as per Core.cleanVar().

Parameters:
$var mixed

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

References Core.cleanVar().

Referenced by getCookieVar(), and getUserVar().

Request.getBasePath (  ) 

Get the base path of the request (excluding trailing slash).

Returns:
string

Definition at line 98 of file Request.inc.php.

References HookRegistry.call().

Referenced by SiteSettingsForm.display(), getBaseUrl(), LoginHandler.implicitAuthLogin(), SessionManager.SessionManager(), and setCookieVar().

Request.getBaseUrl (  ) 

Request.getCompleteUrl (  ) 

Get the complete URL to this page, including parameters.

Returns:
string

Definition at line 131 of file Request.inc.php.

References HookRegistry.call(), getQueryString(), and getRequestUrl().

Referenced by ThesisFeedGatewayPlugin.fetch(), AnnouncementFeedGatewayPlugin.fetch(), and TemplateManager.TemplateManager().

Request.getCookieVar ( key  ) 

Get the value of a cookie variable.

Returns:
mixed

Definition at line 585 of file Request.inc.php.

References cleanUserVar().

Referenced by Locale.getLocale().

Request.getIndexUrl (  ) 

Get the URL to the index script.

Returns:
string

Definition at line 116 of file Request.inc.php.

References HookRegistry.call(), and getBaseUrl().

Referenced by JournalSiteSettingsForm.execute(), ImportOJS1.ImportOJS1(), and url().

& Request.getJournal (  ) 

Get the journal associated with the current request.

Returns:
Journal

Definition at line 415 of file Request.inc.php.

References DAORegistry.getDAO(), and getRequestedJournalPath().

Referenced by ArticleXMLGalley._xsltCacheMiss(), ReviewFormHandler.activateReviewForm(), RegistrationHandler.activateUser(), SectionEditorAction.addReviewer(), SearchHandler.advanced(), SearchHandler.advancedResults(), AnnouncementForm.AnnouncementForm(), AnnouncementHandler.announcements(), AnnouncementHandler.announcementTypes(), ArticleXMLGalleyDAO.appendXMLGalleys(), IssueHandler.archive(), ArticleGalleyForm.ArticleGalleyForm(), EditorHandler.assignEditor(), EditorAction.assignEditor(), AuthorSubmitForm.assignEditors(), ArticleMailTemplate.assignParams(), SearchHandler.authors(), AuthorSubmitStep1Form.AuthorSubmitStep1Form(), AuthorSubmitStep2Form.AuthorSubmitStep2Form(), IssueManagementHandler.backIssues(), UserHandler.become(), SectionEditorAction.blindCcReviewsToReviewers(), SectionEditorAction.cancelReview(), AuthorAction.completeAuthorCopyedit(), SectionEditorAction.completeCopyedit(), CopyeditorAction.completeCopyedit(), SectionEditorAction.completeFinalCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), ReviewerAction.confirmReview(), AboutHandler.contact(), ReviewFormHandler.copyReviewForm(), ReviewFormHandler.copyReviewFormElement(), CreateReviewerForm.CreateReviewerForm(), SubscriptionManagerHandler.createUser(), IssueHandler.current(), ReviewFormHandler.deactivateReviewForm(), AnnouncementHandler.deleteAnnouncement(), AnnouncementHandler.deleteAnnouncementType(), EmailHandler.deleteCustomEmail(), EditorHandler.deleteEditAssignment(), JournalSetupStep5Form.deleteImage(), ReviewFormHandler.deleteReviewForm(), ReviewFormHandler.deleteReviewFormElement(), SectionHandler.deleteSection(), EditorHandler.deleteSubmission(), SubscriptionManagerHandler.deleteSubscription(), SubscriptionHandler.deleteSubscription(), SubscriptionManagerHandler.deleteSubscriptionType(), SubscriptionHandler.deleteSubscriptionType(), EmailHandler.disableEmail(), PeopleHandler.disableUser(), ArticleReportPlugin.display(), UserImportExportPlugin.display(), SampleImportExportPlugin.display(), PubMedExportPlugin.display(), NativeImportExportPlugin.display(), EruditExportPlugin.display(), DOAJPlugin.display(), CrossRefExportPlugin.display(), RegistrationForm.display(), ProfileForm.display(), SubscriptionForm.display(), SuppFileForm.display(), ReviewFormResponseForm.display(), MetadataForm.display(), ArticleGalleyForm.display(), VersionForm.display(), SearchForm.display(), ContextForm.display(), JournalSetupStep5Form.display(), SectionForm.display(), EmailTemplateForm.display(), AnnouncementForm.display(), IssueForm.display(), CommentForm.display(), AuthorSubmitStep5Form.display(), AuthorSubmitStep1Form.display(), AuthorSubmitForm.display(), AboutHandler.displayMembership(), PayPalPlugin.displayPaymentForm(), ReviewerAction.downloadReviewerFile(), AnnouncementHandler.editAnnouncement(), AnnouncementHandler.editAnnouncementType(), IssueManagementHandler.editIssue(), AboutHandler.editorialPolicies(), AboutHandler.editorialTeam(), AboutHandler.editorialTeamBio(), ReviewFormHandler.editReviewForm(), ReviewFormHandler.editReviewFormElement(), SubscriptionManagerHandler.editSubscription(), SubscriptionHandler.editSubscription(), SubscriptionManagerHandler.editSubscriptionType(), SubscriptionHandler.editSubscriptionType(), PeopleHandler.editUser(), ManagerHandler.email(), EmailHandler.email(), ProofreadCommentForm.email(), LayoutCommentForm.email(), EditorDecisionCommentForm.email(), EditCommentForm.email(), CopyeditCommentForm.email(), CommentForm.email(), SectionEditorAction.emailEditorDecisionComment(), AuthorAction.emailEditorDecisionComment(), EditCommentForm.emailHelper(), EmailHandler.emails(), EmailHandler.enableEmail(), PeopleHandler.enrollSync(), PeopleHandler.enrollSyncSelect(), ThesisForm.execute(), StudentThesisForm.execute(), RegistrationForm.execute(), ProfileForm.execute(), SubscriptionTypeForm.execute(), SubscriptionPolicyForm.execute(), SubscriptionForm.execute(), MetadataForm.execute(), ArticleGalleyForm.execute(), CreateReviewerForm.execute(), UserManagementForm.execute(), JournalSetupStep5Form.execute(), JournalSetupForm.execute(), SectionForm.execute(), ReviewFormForm.execute(), PayMethodSettingsForm.execute(), LanguageSettingsForm.execute(), GroupForm.execute(), EmailTemplateForm.execute(), AnnouncementTypeForm.execute(), AnnouncementForm.execute(), IssueForm.execute(), CommentForm.execute(), AuthorSubmitStep5Form.execute(), AuthorSubmitStep1Form.execute(), WebFeedGatewayPlugin.fetch(), ThesisFeedGatewayPlugin.fetch(), AnnouncementFeedGatewayPlugin.fetch(), ResolverPlugin.fetch(), METSGatewayPlugin.fetch(), LayoutEditorHandler.futureIssues(), IssueManagementHandler.futureIssues(), BlockPlugin.getBlockContext(), RoleBlockPlugin.getBlockTemplateFilename(), WebFeedBlockPlugin.getContents(), ThesisFeedBlockPlugin.getContents(), OpenAdsBlockPlugin.getContents(), CmsBlockPlugin.getContents(), AnnouncementFeedBlockPlugin.getContents(), SubscriptionBlockPlugin.getContents(), LanguageToggleBlockPlugin.getContents(), InformationBlockPlugin.getContents(), DonationBlockPlugin.getContents(), PublishedArticle.getDOI(), XMLGalleyPlugin.getEnabled(), WebFeedPlugin.getEnabled(), TinyMCEPlugin.getEnabled(), ThesisFeedPlugin.getEnabled(), ThesisPlugin.getEnabled(), RoundedCornersPlugin.getEnabled(), PhpMyVisitesPlugin.getEnabled(), OpenAdsPlugin.getEnabled(), GoogleAnalyticsPlugin.getEnabled(), CoinsPlugin.getEnabled(), CmsRssPlugin.getEnabled(), CmsPlugin.getEnabled(), AnnouncementFeedPlugin.getEnabled(), GatewayPlugin.getEnabled(), BlockPlugin.getEnabled(), SectionEditorSubmission.getHighlightClass(), ArticleXMLGalley.getHTMLContents(), ArticleHTMLGalley.getHTMLContents(), IssueAction.getIssueOptions(), Locale.getLocale(), Locale.getLocalePrecedence(), OJSPaymentManager.getPaymentPlugin(), Locale.getPrimaryLocale(), Handler.getRangeInfo(), BlockPlugin.getSeq(), Locale.getSupportedLocales(), GroupForm.GroupForm(), PayPalPlugin.handle(), ThesisHandler.index(), CustomLocaleHandler.index(), UserHandler.index(), SectionEditorHandler.index(), RTAdminHandler.index(), ReviewerHandler.index(), ProofreaderHandler.index(), ManagerHandler.index(), InformationHandler.index(), IndexHandler.index(), EditorHandler.index(), CopyeditorHandler.index(), AnnouncementHandler.index(), AboutHandler.index(), SubscriptionPolicyForm.initData(), JournalSetupForm.initData(), SectionForm.initData(), ReviewFormForm.initData(), ReviewFormElementForm.initData(), PayMethodSettingsForm.initData(), PaymentSettingsForm.initData(), LanguageSettingsForm.initData(), EmailTemplateForm.initData(), IssueForm.initData(), PhpMyVisitesPlugin.insertFooter(), GoogleAnalyticsPlugin.insertFooter(), ArticleXMLGalleyDAO.insertXMLGalleys(), Action.instructions(), Validation.isAuthorized(), PayPalPlugin.isConfigured(), OJSPaymentManager.isConfigured(), IssueManagementHandler.issueToc(), JournalOAI.JournalOAI(), AboutHandler.journalSponsorship(), CounterPlugin.logRequest(), MailTemplate.MailTemplate(), XMLGalleyPlugin.manage(), WebFeedPlugin.manage(), TinyMCEPlugin.manage(), ThesisFeedPlugin.manage(), ThesisPlugin.manage(), SehlPlugin.manage(), PhpMyVisitesPlugin.manage(), OpenAdsPlugin.manage(), GoogleAnalyticsPlugin.manage(), CmsRssPlugin.manage(), CmsPlugin.manage(), AnnouncementFeedPlugin.manage(), METSGatewayPlugin.manage(), AboutHandler.memberships(), PeopleHandler.mergeUsers(), IssueManagementHandler.moveArticleToc(), IssueManagementHandler.moveIssue(), ReviewFormHandler.moveReviewForm(), ReviewFormHandler.moveReviewFormElement(), SectionHandler.moveSection(), IssueManagementHandler.moveSectionToc(), SubscriptionManagerHandler.moveSubscriptionType(), SubscriptionHandler.moveSubscriptionType(), SectionEditorAction.notifyAuthorCopyedit(), SectionEditorAction.notifyCopyeditor(), SectionEditorAction.notifyFinalCopyedit(), SectionEditorAction.notifyLayoutEditor(), SectionEditorAction.notifyReviewer(), IssueManagementHandler.notifyUsers(), ManagerPaymentHandler.payments(), ManagerPaymentHandler.payMethodSettings(), PeopleHandler.people(), SubmissionEditHandler.previewReviewForm(), ReviewFormHandler.previewReviewForm(), ProofreaderAction.proofreadEmail(), IssueManagementHandler.publishIssue(), ReviewerAction.recordRecommendation(), SehlPlugin.register(), CustomLocalePlugin.register(), RegistrationHandler.register(), SectionEditorAction.remindReviewer(), IssueManagementHandler.removeCoverPage(), IssueManagementHandler.removeIssue(), IssueManagementHandler.removeStyleFile(), PeopleHandler.removeUser(), EmailHandler.resetAllEmails(), EmailHandler.resetEmail(), IssueManagementHandler.resetIssueOrder(), SearchHandler.results(), ReviewFormHandler.reviewFormElements(), ReviewFormHandler.reviewForms(), OpenAdsPlugin.rtOutputFilter(), ThesisHandler.save(), CmsSettingsForm.save(), PaymentSettingsForm.save(), ManagerPaymentHandler.savePaymentSettings(), ManagerPaymentHandler.savePayMethodSettings(), SetupHandler.saveSetup(), SubmitHandler.saveSubmit(), SectionForm.SectionForm(), SectionHandler.sections(), SubmissionEditHandler.selectReviewForm(), BlockPlugin.setBlockContext(), IssueManagementHandler.setCurrentIssue(), EditorHandler.setEditorFlags(), XMLGalleyPlugin.setEnabled(), ThesisPlugin.setEnabled(), RoundedCornersPlugin.setEnabled(), PhpMyVisitesPlugin.setEnabled(), OpenAdsPlugin.setEnabled(), GoogleAnalyticsPlugin.setEnabled(), CoinsPlugin.setEnabled(), CmsRssPlugin.setEnabled(), CmsPlugin.setEnabled(), GatewayPlugin.setEnabled(), BlockPlugin.setEnabled(), UserHandler.setLocale(), BlockPlugin.setSeq(), IssueHandler.setupIssueTemplate(), SearchHandler.setupTemplate(), InformationHandler.setupTemplate(), EditorHandler.setupTemplate(), AnnouncementHandler.setupTemplate(), AboutHandler.setupTemplate(), PeopleHandler.signInAsUser(), StatisticsHandler.statistics(), AboutHandler.statistics(), StudentThesisForm.StudentThesisForm(), SubmissionReviewHandler.submission(), TrackSubmissionHandler.submission(), TrackSubmissionHandler.submissionEditing(), LayoutEditorHandler.submissions(), EditorHandler.submissions(), AboutHandler.submissions(), ThesisHandler.submit(), SubscriptionForm.SubscriptionForm(), IssueAction.subscriptionRequired(), SubscriptionManagerHandler.subscriptions(), SubscriptionHandler.subscriptions(), AboutHandler.subscriptions(), SubscriptionTypeForm.SubscriptionTypeForm(), SubscriptionManagerHandler.subscriptionTypes(), SubscriptionHandler.subscriptionTypes(), TemplateManager.TemplateManager(), SectionEditorAction.thankAuthorCopyedit(), SectionEditorAction.thankCopyeditor(), SectionEditorAction.thankFinalCopyedit(), SectionEditorAction.thankLayoutEditor(), SectionEditorAction.thankReviewer(), ThesisForm.ThesisForm(), SearchHandler.titles(), SectionEditorAction.unsuitableSubmission(), AnnouncementHandler.updateAnnouncement(), AnnouncementHandler.updateAnnouncementType(), IssueManagementHandler.updateIssueToc(), ReviewFormHandler.updateReviewForm(), ReviewFormHandler.updateReviewFormElement(), SubscriptionManagerHandler.updateSubscription(), SubscriptionHandler.updateSubscription(), SubscriptionManagerHandler.updateSubscriptionType(), SubscriptionHandler.updateSubscriptionType(), SubscriptionManagerHandler.updateUser(), PeopleHandler.updateUser(), JournalSetupStep5Form.uploadImage(), JournalSetupStep5Form.uploadStyleSheet(), url(), SubmissionEditHandler.userProfile(), PeopleHandler.userProfile(), CounterHandler.validate(), RegistrationHandler.validate(), SubscriptionManagerHandler.validate(), SubmissionEditHandler.validate(), SectionEditorHandler.validate(), SubmissionReviewHandler.validate(), ReviewerHandler.validate(), SubmissionProofreadHandler.validate(), ProofreaderHandler.validate(), ManagerHandler.validate(), GroupHandler.validate(), SubmissionLayoutHandler.validate(), LayoutEditorHandler.validate(), IssueManagementHandler.validate(), EditorHandler.validate(), SubmissionCopyeditHandler.validate(), CopyeditorHandler.validate(), CommentHandler.validate(), TrackSubmissionHandler.validate(), SubmitHandler.validate(), AuthorHandler.validate(), ArticleHandler.validate(), SuppFileForm.validate(), ArticleGalleyForm.validate(), IssueForm.validate(), Handler.validate(), AuthorSubmitStep5Form.validate(), ReviewerHandler.validateAccessKey(), ThesisHandler.view(), IssueHandler.view(), AnnouncementHandler.view(), ArticleXMLGalley.viewFileContents(), ManagerPaymentHandler.viewPayments(), and XMLGalleyPlugin.viewXMLGalleyFile().

Request.getProtocol (  ) 

Get the protocol used for the request (HTTP or HTTPS).

Returns:
string

Definition at line 210 of file Request.inc.php.

References HookRegistry.call().

Referenced by getBaseUrl(), getRequestUrl(), LoginHandler.implicitAuthLogin(), LoginHandler.index(), UserHandler.setLocale(), LoginHandler.signIn(), and Handler.validate().

Request.getQueryString (  ) 

Get the complete set of URL parameters to the current request.

Returns:
string

Definition at line 163 of file Request.inc.php.

References HookRegistry.call().

Referenced by getCompleteUrl(), redirectNonSSL(), and redirectSSL().

Request.getRemoteAddr (  ) 

Request.getRemoteDomain (  ) 

Get the remote domain of the current request

Returns:
string

Definition at line 275 of file Request.inc.php.

References HookRegistry.call(), and getRemoteAddr().

Referenced by SubscriptionBlockPlugin.getContents(), and IssueAction.subscribedDomain().

Request.getRequestedArgs (  ) 

Get the arguments requested in the URL (not GET/POST arguments, only arguments prepended to the URL separated by "/").

Returns:
array

Definition at line 482 of file Request.inc.php.

References Core.cleanVar(), getUserVar(), and isPathInfoEnabled().

Referenced by TinyMCEPlugin.getEnableFields(), and TemplateManager.smartyPageLinks().

Request.getRequestedJournalPath (  ) 

Request.getRequestedOp (  ) 

Get the operation requested in the URL (assumed to exist in the requested page handler).

Returns:
string

Definition at line 457 of file Request.inc.php.

References Core.cleanFileVar(), getUserVar(), and isPathInfoEnabled().

Referenced by TinyMCEPlugin.callback(), RoleBlockPlugin.getBlockTemplateFilename(), Handler.hashPageContext(), and url().

Request.getRequestedPage (  ) 

Get the page requested in the URL.

Returns:
String the page path (under the "pages" directory)

Definition at line 433 of file Request.inc.php.

References Core.cleanFileVar(), getUserVar(), and isPathInfoEnabled().

Referenced by SearchHandler.authors(), RTHandler.bio(), TinyMCEPlugin.callback(), WebFeedPlugin.callbackAddLinks(), RTHandler.captureCite(), SuppFileForm.display(), ReviewFormResponseForm.display(), MetadataForm.display(), SubmissionCommentsHandler.editComment(), ManagerHandler.email(), RTHandler.emailAuthor(), RTHandler.emailColleague(), RTHandler.findingReferences(), RoleBlockPlugin.getBlockTemplateFilename(), WebFeedBlockPlugin.getContents(), ThesisFeedBlockPlugin.getContents(), AnnouncementFeedBlockPlugin.getContents(), Handler.hashPageContext(), SectionEditorHandler.instructions(), ProofreaderHandler.instructions(), LayoutEditorHandler.instructions(), CopyeditorHandler.instructions(), RTHandler.metadata(), MetadataForm.MetadataForm(), RTHandler.printerFriendly(), LoginHandler.requestResetPassword(), LoginHandler.resetPassword(), SubmissionCommentsHandler.saveComment(), JournalLanguagesHandler.saveLanguageSettings(), ProfileHandler.savePassword(), ProfileHandler.saveProfile(), AdminSettingsHandler.saveSettings(), SectionEditorHandler.setupTemplate(), IssueManagementHandler.setupTemplate(), EditorHandler.setupTemplate(), PeopleHandler.signInAsUser(), LoginHandler.signOut(), PeopleHandler.signOutAsUser(), RTHandler.suppFileMetadata(), RTHandler.suppFiles(), TemplateManager.TemplateManager(), url(), SubmissionEditHandler.userProfile(), SubmissionEditHandler.validate(), SectionEditorHandler.validate(), SubmissionReviewHandler.validate(), SubmissionProofreadHandler.validate(), SubmissionLayoutHandler.validate(), SubmissionCopyeditHandler.validate(), TrackSubmissionHandler.validate(), SubmissionCommentsHandler.validate(), Handler.validate(), and ArticleHandler.view().

Request.getRequestMethod (  ) 

Get the request method

Returns:
string

Definition at line 223 of file Request.inc.php.

Referenced by isGet(), and isPost().

Request.getRequestPath (  ) 

Get the completed path of the request.

Returns:
string

Definition at line 178 of file Request.inc.php.

References HookRegistry.call(), and isPathInfoEnabled().

Referenced by getRequestUrl(), redirectNonSSL(), and redirectSSL().

Request.getRequestUrl (  ) 

Get the complete URL of the request.

Returns:
string

Definition at line 148 of file Request.inc.php.

References HookRegistry.call(), getProtocol(), getRequestPath(), and getServerHost().

Referenced by getCompleteUrl(), ArticleHTMLGalley.getHTMLContents(), and OAIHandler.index().

Request.getServerHost ( default = 'localhost'  ) 

& Request.getSession (  ) 

& Request.getSite (  ) 

Get site data.

Returns:
Site

Definition at line 369 of file Request.inc.php.

References DAORegistry.getDAO().

Referenced by MailTemplate.assignParams(), ChangePasswordForm.ChangePasswordForm(), CreateReviewerForm.CreateReviewerForm(), RegistrationForm.display(), ProfileForm.display(), LoginChangePasswordForm.display(), ChangePasswordForm.display(), CreateReviewerForm.display(), UserManagementForm.display(), LanguageSettingsForm.display(), SiteSettingsForm.display(), ManagerHandler.email(), RegistrationForm.execute(), ProfileForm.execute(), CreateReviewerForm.execute(), UserManagementForm.execute(), JournalSiteSettingsForm.execute(), LanguageToggleBlockPlugin.getContents(), ArticleHTMLGalley.getHTMLContents(), Locale.getLocale(), Locale.getLocalePrecedence(), Locale.getPrimaryLocale(), Locale.getSupportedLocales(), AboutHandler.index(), AdminLanguagesHandler.installLocale(), JournalOAI.JournalOAI(), AdminLanguagesHandler.languages(), LanguageSettingsForm.LanguageSettingsForm(), LoginChangePasswordForm.LoginChangePasswordForm(), CounterPlugin.logRequest(), MailTemplate.MailTemplate(), UserXMLParser.parseData(), ProfileForm.ProfileForm(), RegistrationForm.RegistrationForm(), AdminLanguagesHandler.reloadLocale(), AdminLanguagesHandler.removeLocalesFromJournals(), LoginHandler.requestResetPassword(), LoginHandler.resetPassword(), AdminLanguagesHandler.saveLanguageSettings(), AdminSettingsHandler.saveSettings(), UserHandler.setLocale(), TemplateManager.TemplateManager(), AdminLanguagesHandler.uninstallLocale(), SiteSettingsForm.uploadPageHeaderTitleImage(), SiteSettingsForm.uploadSiteStyleSheet(), UserManagementForm.UserManagementForm(), SubmissionEditHandler.userProfile(), and PeopleHandler.userProfile().

& Request.getUser (  ) 

Get the user associated with the current request.

Returns:
User

Definition at line 399 of file Request.inc.php.

References SessionManager.getManager().

Referenced by MailTemplate._handleAttachments(), SectionEditorAction.addReviewer(), SectionEditorAction.addSubmissionNote(), IssueAction.allowedPrePublicationAccess(), SectionEditorAction.archiveSubmission(), EditorAction.assignEditor(), UserHandler.become(), SectionEditorAction.blindCcReviewsToReviewers(), SectionEditorAction.cancelReview(), ChangePasswordForm.ChangePasswordForm(), SectionEditorAction.clearReview(), CommentForm.CommentForm(), AuthorAction.completeAuthorCopyedit(), SectionEditorAction.completeCopyedit(), CopyeditorAction.completeCopyedit(), SectionEditorAction.completeFinalCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), SectionEditorAction.confirmReviewForReviewer(), CopyeditorAction.copyeditUnderway(), CommentHandler.delete(), Action.deleteComment(), ProfileForm.deleteProfileImage(), PeopleHandler.disableUser(), NativeImportExportPlugin.display(), ProfileForm.display(), ChangePasswordForm.display(), CommentForm.display(), AuthorSubmitStep5Form.display(), AuthorSubmitStep1Form.display(), MailTemplate.displayEditForm(), PayPalPlugin.displayPaymentForm(), EditCommentForm.EditCommentForm(), ManagerHandler.email(), EmailHandler.email(), RTHandler.emailAuthor(), RTHandler.emailColleague(), SectionEditorAction.emailEditorDecisionComment(), AuthorAction.emailEditorDecisionComment(), DOAJPlugin.emailRep(), PeopleHandler.enableUser(), SubmissionEditHandler.enrollSearch(), PeopleHandler.enrollSearch(), ProfileForm.execute(), ChangePasswordForm.execute(), CommentForm.execute(), AuthorSubmitStep5Form.execute(), AuthorSubmitStep1Form.execute(), EditorAction.expediteSubmission(), RoleBlockPlugin.getBlockTemplateFilename(), SubscriptionBlockPlugin.getContents(), UserHandler.index(), SectionEditorHandler.index(), RTAdminHandler.index(), ReviewerHandler.index(), ProofreaderHandler.index(), EditorHandler.index(), CopyeditorHandler.index(), AuthorHandler.index(), ProfileForm.initData(), CommentForm.initData(), ArticleLog.logEmailEntry(), ArticleLog.logEventEntry(), MailTemplate.MailTemplate(), PeopleHandler.mergeUsers(), AdminPeopleHandler.mergeUsers(), MetadataForm.MetadataForm(), SectionEditorAction.notifyAuthorCopyedit(), SectionEditorAction.notifyCopyeditor(), SectionEditorAction.notifyFinalCopyedit(), SectionEditorAction.notifyLayoutEditor(), SectionEditorAction.notifyReviewer(), IssueManagementHandler.notifyUsers(), TrackSubmissionHandler.payFastTrackFee(), TrackSubmissionHandler.payPublicationFee(), TrackSubmissionHandler.paySubmissionFee(), PeopleHandler.people(), ProfileForm.ProfileForm(), ProofreaderAction.proofreadEmail(), SectionEditorAction.rateReviewer(), SectionEditorAction.recordDecision(), SectionEditorAction.remindReviewer(), PeopleHandler.removeUser(), SectionEditorAction.resubmitFile(), Action.saveMetadata(), SectionEditorAction.selectCopyeditor(), ProofreaderAction.selectProofreader(), MailTemplate.send(), ArticleMailTemplate.send(), SectionEditorAction.setCopyeditFile(), SectionEditorAction.setDueDate(), SectionEditorAction.setReviewerRecommendation(), AboutHandler.siteMap(), TrackSubmissionHandler.submission(), TrackSubmissionHandler.submissionEditing(), TrackSubmissionHandler.submissionReview(), LayoutEditorHandler.submissions(), EditorHandler.submissions(), IssueAction.subscribedUser(), SectionEditorAction.thankAuthorCopyedit(), SectionEditorAction.thankCopyeditor(), SectionEditorAction.thankFinalCopyedit(), SectionEditorAction.thankLayoutEditor(), SectionEditorAction.thankReviewer(), SectionEditorAction.unsuitableSubmission(), SectionEditorAction.updateSubmissionNote(), CopyeditorAction.uploadCopyeditVersion(), SectionEditorAction.uploadEditorVersion(), SectionEditorAction.uploadReviewForReviewer(), AuthorAction.uploadRevisedVersion(), SubmissionEditHandler.validate(), SubmissionReviewHandler.validate(), SubmissionProofreadHandler.validate(), SubmissionLayoutHandler.validate(), SubmissionCopyeditHandler.validate(), TrackSubmissionHandler.validate(), SubmitHandler.validate(), SubmissionCommentsHandler.validate(), ArticleHandler.validate(), AuthorSubmitStep5Form.validate(), and SubmissionEditHandler.waiveSubmissionFee().

Request.getUserAgent (  ) 

Get the user agent of the current request.

Returns:
string

Definition at line 289 of file Request.inc.php.

References HookRegistry.call().

Referenced by isBot(), and SessionManager.SessionManager().

Request.getUserDateVar ( prefix,
defaultDay = null,
defaultMonth = null,
defaultYear = null,
defaultHour = 0,
defaultMinute = 0,
defaultSecond = 0 
)

Get the value of a GET/POST variable generated using the Smarty html_select_date and/or html_select_time function.

Parameters:
$prefix string
$defaultDay int
$defaultMonth int
$defaultYear int
$defaultHour int
$defaultMinute int
$defaultSecond int
Returns:
Date

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

References getUserVar().

Referenced by SearchHandler.advancedResults(), SectionEditorHandler.index(), ProofreaderHandler.index(), EditorHandler.index(), CopyeditorHandler.index(), ThesisPlugin.manage(), Form.readUserDateVars(), LayoutEditorHandler.submissions(), EditorHandler.submissions(), SubscriptionManagerHandler.subscriptions(), and SubscriptionHandler.subscriptions().

Request.getUserVar ( key  ) 

Get the value of a GET/POST variable.

Returns:
mixed

Definition at line 506 of file Request.inc.php.

References cleanUserVar().

Referenced by MailTemplate._clearAttachments(), MailTemplate._handleAttachments(), GroupHandler.addMembership(), SubmissionEditHandler.addSubmissionNote(), SectionEditorAction.addSubmissionNote(), SearchHandler.advancedResults(), EditorHandler.assignEditor(), EditorAction.assignEditor(), SubmissionEditHandler.assignLayoutEditor(), SubmissionCopyeditHandler.authorProofreadingComplete(), TrackSubmissionHandler.authorProofreadingComplete(), SearchHandler.authors(), UserHandler.become(), SubmissionCommentsHandler.blindCcReviewsToReviewers(), SectionEditorAction.blindCcReviewsToReviewers(), SectionEditorAction.cancelReview(), SubmissionEditHandler.clearAllSubmissionNotes(), SubmissionLayoutHandler.completeAssignment(), AuthorAction.completeAuthorCopyedit(), CopyeditorAction.completeCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), SubmissionProofreadHandler.completeProofreader(), SubmissionReviewHandler.confirmReview(), ReviewerAction.confirmReview(), RTHandler.context(), ReviewFormHandler.copyReviewFormElement(), AuthSourcesHandler.createAuthSource(), MetsExportDom.createmetsamdSec(), MetsExportDom.createmetsHdr(), SubmissionCommentsHandler.deleteComment(), ReviewerAction.deleteReviewerVersion(), SubmitHandler.deleteSubmitSuppFile(), PeopleHandler.disableUser(), UserImportExportPlugin.display(), PubMedExportPlugin.display(), NativeImportExportPlugin.display(), DOAJPlugin.display(), CrossRefExportPlugin.display(), RegistrationForm.display(), SuppFileForm.display(), UserManagementForm.display(), Form.display(), MailTemplate.displayEditForm(), AdminLanguagesHandler.downloadLocale(), SubmissionCommentsHandler.editComment(), SubmissionEditHandler.editorCompleteLayoutEditor(), SubmissionEditHandler.editorCompleteProofreader(), SubmissionEditHandler.editorInitiateLayoutEditor(), SubmissionEditHandler.editorInitiateProofreader(), SubscriptionManagerHandler.editSubscription(), SubscriptionHandler.editSubscription(), ManagerHandler.email(), EmailHandler.email(), RTHandler.emailAuthor(), RTHandler.emailColleague(), SubmissionCommentsHandler.emailEditorDecisionComment(), SectionEditorAction.emailEditorDecisionComment(), AuthorAction.emailEditorDecisionComment(), PeopleHandler.enroll(), SubmissionEditHandler.enrollSearch(), PeopleHandler.enrollSearch(), PeopleHandler.enrollSync(), ProfileForm.execute(), JournalSetupStep5Form.execute(), SectionForm.execute(), CommentForm.execute(), FilesHandler.fileMakeDir(), FilesHandler.files(), MetsExportDom.generateArticleFileDom(), MetsExportDom.generateArticleSuppFileDom(), Form.getFormLocale(), Locale.getLocale(), Handler.getRangeInfo(), getRequestedArgs(), getRequestedJournalPath(), getRequestedOp(), getRequestedPage(), getUserDateVar(), PayPalPlugin.handle(), LoginHandler.implicitAuthReturn(), ThesisHandler.index(), SectionEditorHandler.index(), ProofreaderHandler.index(), LoginHandler.index(), InstallHandler.index(), EditorHandler.index(), CopyeditorHandler.index(), XMLGalleySettingsForm.initData(), UserManagementForm.initData(), PayMethodSettingsForm.initData(), AdminLanguagesHandler.installLocale(), Form.isLocaleResubmit(), SubmissionLayoutHandler.layoutEditorProofreadingComplete(), CounterPlugin.logRequest(), MailTemplate.MailTemplate(), XMLGalleyPlugin.manage(), WebFeedPlugin.manage(), ThesisFeedPlugin.manage(), ThesisPlugin.manage(), PhpMyVisitesPlugin.manage(), GoogleAnalyticsPlugin.manage(), CmsRssPlugin.manage(), CmsPlugin.manage(), AnnouncementFeedPlugin.manage(), METSGatewayPlugin.manage(), PeopleHandler.mergeUsers(), AdminPeopleHandler.mergeUsers(), IssueManagementHandler.moveArticleToc(), GroupHandler.moveGroup(), IssueManagementHandler.moveIssue(), AdminJournalHandler.moveJournal(), GroupHandler.moveMembership(), ReviewFormHandler.moveReviewForm(), ReviewFormHandler.moveReviewFormElement(), SectionHandler.moveSection(), IssueManagementHandler.moveSectionToc(), SubscriptionManagerHandler.moveSubscriptionType(), SubscriptionHandler.moveSubscriptionType(), SectionEditorAction.notifyAuthorCopyedit(), SubmissionEditHandler.notifyAuthorProofreader(), SectionEditorAction.notifyCopyeditor(), SectionEditorAction.notifyFinalCopyedit(), SubmissionEditHandler.notifyLayoutEditor(), SectionEditorAction.notifyLayoutEditor(), SubmissionEditHandler.notifyLayoutEditorProofreader(), SubmissionEditHandler.notifyProofreader(), SectionEditorAction.notifyReviewer(), IssueManagementHandler.notifyUsers(), SubmissionEditHandler.orderGalley(), SubmissionLayoutHandler.orderGalley(), SubmissionEditHandler.orderSuppFile(), SubmissionLayoutHandler.orderSuppFile(), PeopleHandler.people(), SubmissionCommentsHandler.postCopyeditComment(), SubmissionCommentsHandler.postEditorDecisionComment(), SubmissionCommentsHandler.postLayoutComment(), SubmissionCommentsHandler.postPeerReviewComment(), SubmissionCommentsHandler.postProofreadComment(), ProofreaderAction.proofreadEmail(), SectionForm.readInputData(), Form.readUserVars(), SubmissionReviewHandler.recordRecommendation(), ReviewerAction.recordRecommendation(), RegistrationHandler.register(), RegistrationHandler.registerUser(), RegistrationForm.RegistrationForm(), AdminLanguagesHandler.reloadLocale(), SectionEditorAction.remindReviewer(), SubmissionEditHandler.removeSubmissionNote(), SectionEditorAction.removeSubmissionNote(), LoginHandler.requestResetPassword(), LoginHandler.resetPassword(), SearchHandler.results(), SubmissionCommentsHandler.saveComment(), SubmissionReviewHandler.saveCompetingInterests(), SubmissionEditHandler.saveGalley(), SubmissionLayoutHandler.saveGalley(), AdminLanguagesHandler.saveLanguageSettings(), Action.saveMetadata(), ProfileHandler.saveProfile(), AdminSettingsHandler.saveSettings(), SetupHandler.saveSetup(), SubmitHandler.saveSubmit(), SubmitHandler.saveSubmitSuppFile(), SubmissionEditHandler.saveSuppFile(), SubmissionLayoutHandler.saveSuppFile(), TrackSubmissionHandler.saveSuppFile(), AdminFunctionsHandler.saveSystemConfig(), SubmissionEditHandler.scheduleForPublication(), HelpHandler.search(), SubmissionEditHandler.selectProofreader(), SubscriptionManagerHandler.selectSubscriber(), SubscriptionHandler.selectSubscriber(), IssueManagementHandler.setCurrentIssue(), EditorHandler.setEditorFlags(), UserHandler.setLocale(), SubmissionEditHandler.setSuppFileVisibility(), TrackSubmissionHandler.setSuppFileVisibility(), LoginHandler.signIn(), StatisticsHandler.statistics(), AboutHandler.statistics(), LayoutEditorHandler.submissions(), EditorHandler.submissions(), SubmitHandler.submit(), SubmitHandler.submitSuppFile(), SubmitHandler.submitUploadSuppFile(), SubscriptionManagerHandler.subscriptions(), SubscriptionHandler.subscriptions(), SubmissionEditHandler.suggestUsername(), PeopleHandler.suggestUsername(), AdminFunctionsHandler.systemInfo(), SectionEditorAction.thankAuthorCopyedit(), SubmissionEditHandler.thankAuthorProofreader(), SectionEditorAction.thankCopyeditor(), SectionEditorAction.thankFinalCopyedit(), SubmissionEditHandler.thankLayoutEditor(), SectionEditorAction.thankLayoutEditor(), SubmissionEditHandler.thankLayoutEditorProofreader(), SubmissionEditHandler.thankProofreader(), SectionEditorAction.thankReviewer(), PeopleHandler.unEnroll(), AdminLanguagesHandler.uninstallLocale(), SectionEditorAction.unsuitableSubmission(), AnnouncementHandler.updateAnnouncement(), AnnouncementHandler.updateAnnouncementType(), AuthSourcesHandler.updateAuthSources(), SubmissionEditHandler.updateCommentsStatus(), EmailHandler.updateEmail(), GroupHandler.updateGroup(), IssueManagementHandler.updateIssueToc(), AdminJournalHandler.updateJournal(), ReviewFormHandler.updateReviewForm(), ReviewFormHandler.updateReviewFormElement(), SubmissionEditHandler.updateSection(), SectionHandler.updateSection(), SubmissionEditHandler.updateSubmissionNote(), SectionEditorAction.updateSubmissionNote(), SubscriptionManagerHandler.updateSubscription(), SubscriptionHandler.updateSubscription(), SubscriptionManagerHandler.updateSubscriptionType(), SubscriptionHandler.updateSubscriptionType(), SubscriptionManagerHandler.updateUser(), PeopleHandler.updateUser(), InstallHandler.upgrade(), SubmissionEditHandler.uploadGalley(), SubmissionEditHandler.uploadLayoutFile(), SubmissionLayoutHandler.uploadLayoutFile(), SubmissionEditHandler.uploadLayoutVersion(), SubmissionReviewHandler.uploadReviewerVersion(), TrackSubmissionHandler.uploadRevisedVersion(), SubmissionEditHandler.uploadSuppFile(), SubmissionReviewHandler.validate(), AuthorSubmitStep5Form.validate(), HelpHandler.view(), and SubmissionEditHandler.waiveSubmissionFee().

Request.isBot (  ) 

Determine whether a user agent is a bot or not using an external list of regular expressions.

Definition at line 310 of file Request.inc.php.

References getUserAgent(), Config.getVar(), and String.regexp_match().

Referenced by ArticleHandler.viewArticle().

Request.isGet (  ) 

Determine whether the request is a GET request

Returns:
boolean

Definition at line 239 of file Request.inc.php.

References getRequestMethod().

Request.isPathInfoEnabled (  ) 

Return true iff PATH_INFO is enabled.

Definition at line 330 of file Request.inc.php.

References Config.getVar().

Referenced by OAI.checkParams(), getRequestedArgs(), getRequestedJournalPath(), getRequestedOp(), getRequestedPage(), getRequestPath(), and url().

Request.isPost (  ) 

Determine whether the request is a POST request

Returns:
boolean

Definition at line 231 of file Request.inc.php.

References getRequestMethod().

Referenced by FormValidatorPost.isValid().

Request.redirect ( journalPath = null,
page = null,
op = null,
path = null,
params = null,
anchor = null 
)

Redirect to the specified page within OJS. Shorthand for a common call to Request.redirect(Request.url(...)).

Parameters:
$journalPath string The path of the journal to redirect to.
$page string The name of the op to redirect to.
$op string optional The name of the op to redirect to.
$path mixed string or array containing path info for redirect.
$params array Map of name => value pairs for additional parameters
$anchor string Name of desired anchor on the target page

Definition at line 48 of file Request.inc.php.

References redirectUrl(), and url().

Referenced by ReviewFormHandler.activateReviewForm(), RegistrationHandler.activateUser(), GroupHandler.addMembership(), SubmissionEditHandler.addSubmissionNote(), TrackSubmissionHandler.addSuppFile(), EditorHandler.assignEditor(), SubmissionEditHandler.assignLayoutEditor(), SubmissionCopyeditHandler.authorProofreadingComplete(), TrackSubmissionHandler.authorProofreadingComplete(), SearchHandler.authors(), UserHandler.become(), RTHandler.bio(), SubmissionCommentsHandler.blindCcReviewsToReviewers(), WebFeedPlugin.callbackHandleShortURL(), RTHandler.captureCite(), SubmissionEditHandler.clearAllSubmissionNotes(), AdminFunctionsHandler.clearDataCache(), SubmissionEditHandler.clearReviewForm(), SubmissionEditHandler.clearSubmissionEmailLog(), SubmissionEditHandler.clearSubmissionEventLog(), AdminFunctionsHandler.clearTemplateCache(), SubmissionLayoutHandler.completeAssignment(), SubmissionProofreadHandler.completeProofreader(), SubmissionReviewHandler.confirmReview(), RTHandler.context(), ReviewFormHandler.copyReviewForm(), ReviewFormHandler.copyReviewFormElement(), AuthSourcesHandler.createAuthSource(), SubmissionEditHandler.createReviewer(), ReviewFormHandler.deactivateReviewForm(), CommentHandler.delete(), AnnouncementHandler.deleteAnnouncement(), AnnouncementHandler.deleteAnnouncementType(), SubmissionEditHandler.deleteArticleFile(), TrackSubmissionHandler.deleteArticleFile(), SubmissionEditHandler.deleteArticleImage(), SubmissionLayoutHandler.deleteArticleImage(), AuthSourcesHandler.deleteAuthSource(), SubmissionCommentsHandler.deleteComment(), EmailHandler.deleteCustomEmail(), EditorHandler.deleteEditAssignment(), SubmissionEditHandler.deleteGalley(), SubmissionLayoutHandler.deleteGalley(), GroupHandler.deleteGroup(), AdminJournalHandler.deleteJournal(), GroupHandler.deleteMembership(), ReviewFormHandler.deleteReviewForm(), ReviewFormHandler.deleteReviewFormElement(), SectionHandler.deleteSection(), EditorHandler.deleteSubmission(), TrackSubmissionHandler.deleteSubmission(), SubmitHandler.deleteSubmitSuppFile(), SubscriptionManagerHandler.deleteSubscription(), SubscriptionHandler.deleteSubscription(), SubscriptionManagerHandler.deleteSubscriptionType(), SubscriptionHandler.deleteSubscriptionType(), SubmissionEditHandler.deleteSuppFile(), SubmissionLayoutHandler.deleteSuppFile(), EmailHandler.disableEmail(), PeopleHandler.disableUser(), PubMedExportPlugin.display(), NativeImportExportPlugin.display(), CrossRefExportPlugin.display(), AboutHandler.displayMembership(), SubmissionEditHandler.downloadFile(), SubmissionReviewHandler.downloadFile(), SubmissionProofreadHandler.downloadFile(), SubmissionLayoutHandler.downloadFile(), SubmissionCopyeditHandler.downloadFile(), TrackSubmissionHandler.downloadFile(), AdminLanguagesHandler.downloadLocale(), AnnouncementHandler.editAnnouncement(), AnnouncementHandler.editAnnouncementType(), SubmissionCommentsHandler.editComment(), SubmissionLayoutHandler.editGalley(), GroupHandler.editGroup(), SubmissionEditHandler.editorCompleteLayoutEditor(), SubmissionEditHandler.editorCompleteProofreader(), AboutHandler.editorialTeamBio(), SubmissionEditHandler.editorInitiateLayoutEditor(), SubmissionEditHandler.editorInitiateProofreader(), ReviewFormHandler.editReviewForm(), ReviewFormHandler.editReviewFormElement(), SubscriptionManagerHandler.editSubscription(), SubscriptionHandler.editSubscription(), SubscriptionManagerHandler.editSubscriptionType(), SubscriptionHandler.editSubscriptionType(), SubmissionLayoutHandler.editSuppFile(), TrackSubmissionHandler.editSuppFile(), ManagerHandler.email(), RTHandler.emailAuthor(), RTHandler.emailColleague(), SubmissionCommentsHandler.emailEditorDecisionComment(), DOAJPlugin.emailRep(), EmailHandler.enableEmail(), PeopleHandler.enableUser(), PeopleHandler.enroll(), PeopleHandler.enrollSync(), AdminFunctionsHandler.expireSessions(), TranslatorHandler.export(), ResolverPlugin.fetch(), FilesHandler.fileMakeDir(), FilesHandler.fileUpload(), RTHandler.findingReferences(), PaymethodPlugin.handle(), LoginHandler.implicitAuthReturn(), ThesisHandler.index(), LoginHandler.index(), InformationHandler.index(), IndexHandler.index(), GatewayHandler.index(), AnnouncementHandler.index(), AdminLanguagesHandler.installLocale(), SectionEditorHandler.instructions(), ProofreaderHandler.instructions(), LayoutEditorHandler.instructions(), CopyeditorHandler.instructions(), AuthorHandler.instructions(), SubmissionLayoutHandler.layoutEditorProofreadingComplete(), WebFeedPlugin.manage(), TranslatorPlugin.manage(), ThesisFeedPlugin.manage(), ThesisPlugin.manage(), PhpMyVisitesPlugin.manage(), OpenAdsPlugin.manage(), GoogleAnalyticsPlugin.manage(), CounterPlugin.manage(), CoinsPlugin.manage(), AnnouncementFeedPlugin.manage(), METSGatewayPlugin.manage(), ReportPlugin.manage(), ImportExportPlugin.manage(), AuthPlugin.manage(), AboutHandler.memberships(), PeopleHandler.mergeUsers(), AdminPeopleHandler.mergeUsers(), RTHandler.metadata(), IssueManagementHandler.moveArticleToc(), GroupHandler.moveGroup(), IssueManagementHandler.moveIssue(), AdminJournalHandler.moveJournal(), GroupHandler.moveMembership(), ReviewFormHandler.moveReviewForm(), ReviewFormHandler.moveReviewFormElement(), SectionHandler.moveSection(), IssueManagementHandler.moveSectionToc(), SubscriptionManagerHandler.moveSubscriptionType(), SubscriptionHandler.moveSubscriptionType(), SubmissionEditHandler.notifyAuthorProofreader(), SubmissionEditHandler.notifyLayoutEditor(), SubmissionEditHandler.notifyLayoutEditorProofreader(), SubmissionEditHandler.notifyProofreader(), SubmissionEditHandler.orderGalley(), SubmissionLayoutHandler.orderGalley(), SubmissionEditHandler.orderSuppFile(), SubmissionLayoutHandler.orderSuppFile(), ManagerPaymentHandler.payMethodSettings(), PeopleHandler.people(), PaymentHandler.plugin(), PluginHandler.plugin(), GatewayHandler.plugin(), ReviewFormHandler.previewReviewForm(), RTHandler.printerFriendly(), ProofreaderAction.proofreadEmail(), IssueManagementHandler.publishIssue(), SubmissionReviewHandler.recordRecommendation(), Validation.redirectLogin(), RegistrationHandler.registerUser(), AdminLanguagesHandler.reloadLocale(), SubmissionEditHandler.removeCoverPage(), IssueManagementHandler.removeCoverPage(), SubmissionCopyeditHandler.removeCoverPage(), TrackSubmissionHandler.removeCoverPage(), IssueManagementHandler.removeIssue(), IssueManagementHandler.removeStyleFile(), SubmissionEditHandler.removeSubmissionNote(), PeopleHandler.removeUser(), EmailHandler.resetAllEmails(), EmailHandler.resetEmail(), IssueManagementHandler.resetIssueOrder(), LoginHandler.resetPassword(), IssueManagementHandler.resetSectionOrder(), ReviewFormHandler.reviewFormElements(), ThesisHandler.save(), SubmissionCommentsHandler.saveComment(), SubmissionReviewHandler.saveCompetingInterests(), SubmissionEditHandler.saveGalley(), SubmissionLayoutHandler.saveGalley(), ProfileHandler.savePassword(), LoginHandler.savePassword(), ManagerPaymentHandler.savePayMethodSettings(), ProfileHandler.saveProfile(), SubmissionReviewHandler.saveReviewFormResponse(), SetupHandler.saveSetup(), SubmitHandler.saveSubmit(), SubmitHandler.saveSubmitSuppFile(), SubmissionEditHandler.saveSuppFile(), SubmissionLayoutHandler.saveSuppFile(), TrackSubmissionHandler.saveSuppFile(), SubmissionEditHandler.scheduleForPublication(), SubmissionEditHandler.selectProofreader(), SubmissionEditHandler.selectReviewForm(), IssueManagementHandler.setCurrentIssue(), EditorHandler.setEditorFlags(), UserHandler.setLocale(), SubmissionEditHandler.setSuppFileVisibility(), TrackSubmissionHandler.setSuppFileVisibility(), SetupHandler.setupSaved(), LoginHandler.signIn(), PeopleHandler.signInAsUser(), LoginHandler.signOut(), PeopleHandler.signOutAsUser(), ThesisHandler.submit(), SubmitHandler.submitUploadSuppFile(), RTHandler.suppFileMetadata(), RTHandler.suppFiles(), SubmissionEditHandler.thankAuthorProofreader(), SubmissionEditHandler.thankLayoutEditor(), SubmissionEditHandler.thankLayoutEditorProofreader(), SubmissionEditHandler.thankProofreader(), PeopleHandler.unEnroll(), AdminLanguagesHandler.uninstallLocale(), AnnouncementHandler.updateAnnouncement(), AnnouncementHandler.updateAnnouncementType(), AuthSourcesHandler.updateAuthSource(), AuthSourcesHandler.updateAuthSources(), SubmissionEditHandler.updateCommentsStatus(), EmailHandler.updateEmail(), GroupHandler.updateGroup(), IssueManagementHandler.updateIssueToc(), AdminJournalHandler.updateJournal(), ReviewFormHandler.updateReviewForm(), ReviewFormHandler.updateReviewFormElement(), SubmissionEditHandler.updateSection(), SectionHandler.updateSection(), SubmissionEditHandler.updateSubmissionNote(), SubscriptionManagerHandler.updateSubscription(), SubscriptionHandler.updateSubscription(), SubscriptionManagerHandler.updateSubscriptionType(), SubscriptionHandler.updateSubscriptionType(), SubscriptionManagerHandler.updateUser(), PeopleHandler.updateUser(), SubmissionEditHandler.uploadGalley(), SubmissionEditHandler.uploadLayoutFile(), SubmissionLayoutHandler.uploadLayoutFile(), SubmissionEditHandler.uploadLayoutVersion(), SubmissionReviewHandler.uploadReviewerVersion(), TrackSubmissionHandler.uploadRevisedVersion(), SubmissionEditHandler.uploadSuppFile(), SubmissionEditHandler.validate(), SubmissionReviewHandler.validate(), SubmissionProofreadHandler.validate(), GroupHandler.validate(), SubmissionLayoutHandler.validate(), InstallHandler.validate(), IssueManagementHandler.validate(), SubmissionCopyeditHandler.validate(), CommentHandler.validate(), TrackSubmissionHandler.validate(), SubmitHandler.validate(), SubmissionCommentsHandler.validate(), ArticleHandler.validate(), Handler.validate(), ThesisHandler.view(), IssueHandler.view(), ArticleHandler.view(), AnnouncementHandler.view(), ThesisHandler.viewCaptcha(), SubmissionEditHandler.viewFile(), SubmissionProofreadHandler.viewFile(), SubmissionLayoutHandler.viewFile(), SubmissionCopyeditHandler.viewFile(), TrackSubmissionHandler.viewFile(), ArticleHandler.viewFile(), UserHandler.viewPublicProfile(), and SubmissionEditHandler.waiveSubmissionFee().

Request.redirectNonSSL (  ) 

Redirect to the current URL, forcing the HTTP protocol to be used.

Definition at line 65 of file Request.inc.php.

References getQueryString(), getRequestPath(), getServerHost(), and redirectUrl().

Referenced by LoginHandler.signIn().

Request.redirectSSL (  ) 

Redirect to the current URL, forcing the HTTPS protocol to be used.

Definition at line 55 of file Request.inc.php.

References getQueryString(), getRequestPath(), getServerHost(), and redirectUrl().

Referenced by LoginHandler.implicitAuthLogin(), LoginHandler.index(), LoginHandler.signIn(), and Handler.validate().

Request.redirectUrl ( url  ) 

Perform an HTTP redirect to an absolute or relative (to base system URL) URL.

Parameters:
$url string (exclude protocol for local redirects)
$includeJournal boolean optional, for relative URLs will include the journal path in the redirect URL

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

References HookRegistry.call().

Referenced by UserHandler.become(), EmailHandler.email(), LoginHandler.implicitAuthLogin(), redirect(), redirectNonSSL(), redirectSSL(), RegistrationHandler.registerUser(), UserHandler.setLocale(), LoginHandler.signIn(), and PeopleHandler.updateUser().

Request.setCookieVar ( key,
value 
)

Set a cookie variable.

Parameters:
$key string
$value mixed

Definition at line 600 of file Request.inc.php.

References getBasePath().

Referenced by InstallHandler.index(), and InstallHandler.upgrade().

Request.url ( journalPath = null,
page = null,
op = null,
path = null,
params = null,
anchor = null,
escape = false 
)

Build a URL into OJS.

Parameters:
$journalPath string Optional path for journal to use
$page string Optional name of page to invoke
$op string Optional name of operation to invoke
$path mixed Optional string or array of args to pass to handler
$params array Optional set of name => value pairs to pass as user parameters
$anchor string Optional name of anchor to add to URL
$escape boolean Whether or not to escape ampersands for this URL; default false.

Definition at line 615 of file Request.inc.php.

References getIndexUrl(), getJournal(), getRequestedOp(), getRequestedPage(), Config.getVar(), and isPathInfoEnabled().

Referenced by OAIDAO._returnRecordFromRow(), EditorAction.assignEditor(), MailTemplate.assignParams(), SubmissionCopyeditHandler.authorProofreadingComplete(), TrackSubmissionHandler.authorProofreadingComplete(), SectionEditorAction.blindCcReviewsToReviewers(), SectionEditorAction.cancelReview(), AuthorAction.completeAuthorCopyedit(), CopyeditorAction.completeCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), SubmissionProofreadHandler.completeProofreader(), ReviewerAction.confirmReview(), SubscriptionManagerHandler.createUser(), IssueHandler.current(), PeopleHandler.disableUser(), PayPalPlugin.displayPaymentForm(), AdminLanguagesHandler.downloadLocale(), AnnouncementHandler.editAnnouncement(), AnnouncementHandler.editAnnouncementType(), EmailHandler.editEmail(), SubscriptionManagerHandler.editSubscription(), SubscriptionHandler.editSubscription(), SubscriptionManagerHandler.editSubscriptionType(), SubscriptionHandler.editSubscriptionType(), AdminFunctionsHandler.editSystemConfig(), PeopleHandler.editUser(), ManagerHandler.email(), EmailHandler.email(), RTHandler.emailAuthor(), RTHandler.emailColleague(), SectionEditorAction.emailEditorDecisionComment(), AuthorAction.emailEditorDecisionComment(), DOAJPlugin.emailRep(), EmailHandler.emails(), RegistrationForm.execute(), AuthorSubmitStep5Form.execute(), FilesHandler.files(), DOAJExportDom.generateArticleDom(), ArticleXMLGalley.getHTMLContents(), ArticleHTMLGalley.getHTMLContents(), Journal.getUrl(), PayPalPlugin.handle(), CoinsPlugin.insertFooter(), SubmissionLayoutHandler.layoutEditorProofreadingComplete(), CounterPlugin.logRequest(), PeopleHandler.mergeUsers(), AdminPeopleHandler.mergeUsers(), SectionEditorAction.notifyAuthorCopyedit(), SubmissionEditHandler.notifyAuthorProofreader(), SectionEditorAction.notifyCopyeditor(), SectionEditorAction.notifyFinalCopyedit(), SectionEditorAction.notifyLayoutEditor(), SubmissionEditHandler.notifyLayoutEditorProofreader(), SubmissionEditHandler.notifyProofreader(), SectionEditorAction.notifyReviewer(), IssueManagementHandler.notifyUsers(), PeopleHandler.people(), RTHandler.printerFriendly(), SubmissionEditHandler.proofGalleyFile(), SubmissionProofreadHandler.proofGalleyFile(), SubmissionLayoutHandler.proofGalleyFile(), SubmissionCopyeditHandler.proofGalleyFile(), TrackSubmissionHandler.proofGalleyFile(), ProofreaderAction.proofreadEmail(), ReviewerAction.recordRecommendation(), redirect(), RegistrationHandler.registerUser(), RegistrationHandler.registrationDisabled(), SectionEditorAction.remindReviewer(), LoginHandler.requestResetPassword(), LoginHandler.resetPassword(), JournalLanguagesHandler.saveLanguageSettings(), AdminLanguagesHandler.saveLanguageSettings(), ManagerPaymentHandler.savePaymentSettings(), ManagerPaymentHandler.savePayMethodSettings(), AdminSettingsHandler.saveSettings(), AdminFunctionsHandler.saveSystemConfig(), SectionHandler.sections(), SubscriptionManagerHandler.selectSubscriber(), SubscriptionHandler.selectSubscriber(), CustomThemePlugin.setBreadcrumbs(), ThesisPlugin.setBreadcrumbs(), PhpMyVisitesPlugin.setBreadcrumbs(), GoogleAnalyticsPlugin.setBreadcrumbs(), CmsRssPlugin.setBreadcrumbs(), ReportPlugin.setBreadcrumbs(), ImportExportPlugin.setBreadcrumbs(), ThesisHandler.setupTemplate(), CounterHandler.setupTemplate(), UserHandler.setupTemplate(), SubscriptionManagerHandler.setupTemplate(), SectionEditorHandler.setupTemplate(), SearchHandler.setupTemplate(), RTAdminHandler.setupTemplate(), ReviewerHandler.setupTemplate(), ProofreaderHandler.setupTemplate(), SubscriptionHandler.setupTemplate(), ManagerHandler.setupTemplate(), LayoutEditorHandler.setupTemplate(), EditorHandler.setupTemplate(), CopyeditorHandler.setupTemplate(), AuthorHandler.setupTemplate(), AnnouncementHandler.setupTemplate(), AdminHandler.setupTemplate(), AboutHandler.setupTemplate(), PeopleHandler.signInAsUser(), TemplateManager.smartyGetHelpId(), TemplateManager.smartyHelpTopic(), TemplateManager.smartyPageLinks(), TemplateManager.smartyUrl(), SectionEditorAction.submissionBreadcrumb(), ThesisHandler.submit(), SectionEditorAction.thankAuthorCopyedit(), SubmissionEditHandler.thankAuthorProofreader(), SectionEditorAction.thankCopyeditor(), SectionEditorAction.thankFinalCopyedit(), SectionEditorAction.thankLayoutEditor(), SubmissionEditHandler.thankLayoutEditorProofreader(), SubmissionEditHandler.thankProofreader(), SectionEditorAction.thankReviewer(), SectionEditorAction.unsuitableSubmission(), AnnouncementHandler.updateAnnouncement(), AnnouncementHandler.updateAnnouncementType(), GroupHandler.updateGroup(), SubscriptionManagerHandler.updateSubscription(), SubscriptionHandler.updateSubscription(), SubscriptionManagerHandler.updateSubscriptionType(), SubscriptionHandler.updateSubscriptionType(), SubscriptionManagerHandler.updateUser(), PeopleHandler.updateUser(), SubmissionEditHandler.userProfile(), PeopleHandler.userProfile(), ThesisHandler.view(), IssueHandler.view(), AnnouncementHandler.view(), ArticleHandler.viewArticle(), and ArticleXMLGalley.viewFileContents().


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

Generated on Mon Jul 14 10:55:45 2008 for Open Journal Systems by  doxygen 1.5.6