Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
Request Class Reference
Inheritance diagram for Request:
PKPRequest PKPRequest

Public Member Functions

getContext ($level=1)
 
getContextByName ($contextName)
 
getJournal ()
 
 getRequestedContextPath ($contextLevel=null)
 
 getRequestedJournalPath ()
 
 redirectHome ()
 
 url ($journalPath=null, $page=null, $op=null, $path=null, $params=null, $anchor=null, $escape=false)
 
- Public Member Functions inherited from PKPRequest
_checkThis ()
 
_delegateToRouter ($method)
 
 cleanUserVar (&$var)
 
 encodeBasePathFragment ($fragment)
 
 getBasePath ()
 
 getBaseUrl ()
 
 getCompleteUrl ()
 
getContext ()
 
 getCookieVar ($key)
 
getDispatcher ()
 
 getIfModifiedSince ()
 
 getIndexUrl ()
 
 getProtocol ()
 
 getQueryArray ()
 
 getQueryString ()
 
 getRemoteAddr ()
 
 getRemoteDomain ()
 
 getRequestedArgs ()
 
 getRequestedContextPath ($contextLevel=null)
 
 getRequestedOp ()
 
 getRequestedPage ()
 
 getRequestMethod ()
 
 getRequestPath ()
 
 getRequestUrl ()
 
getRouter ()
 
 getServerHost ($default= 'localhost')
 
getSession ()
 
getSite ()
 
getUser ()
 
 getUserAgent ()
 
 getUserDateVar ($prefix, $defaultDay=null, $defaultMonth=null, $defaultYear=null, $defaultHour=0, $defaultMinute=0, $defaultSecond=0)
 
 getUserVar ($key)
 
getUserVars ()
 
 isBot ()
 
 isGet ()
 
 isPathInfoEnabled ()
 
 isPost ()
 
 isRestfulUrlsEnabled ()
 
 redirect ($context=null, $page=null, $op=null, $path=null, $params=null, $anchor=null)
 
 redirectNonSSL ()
 
 redirectSSL ()
 
 redirectUrl ($url)
 
 redirectUrlJson ($url)
 
 setCookieVar ($key, $value)
 
 setDispatcher (&$dispatcher)
 
 setRouter (&$router)
 
 url ($context=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.

Mock implementation of the Request class.

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

Member Function Documentation

& Request::getContext (   $level = 1)

Deprecated

See Also
PKPPageRouter::getContext()

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

References PKPRequest\_checkThis().

& Request::getContextByName (   $contextName)

Deprecated

See Also
PKPPageRouter::getContextByName()

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

References PKPRequest\_checkThis().

& Request::getJournal ( )

Deprecated

See Also
PKPPageRouter::getContext()

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

References PKPRequest\_checkThis().

Referenced by CounterReportPlugin\_assignTemplateCounterXML(), SitemapHandler\_createJournalSitemap(), SubscriptionForm\_prepareNotificationEmail(), AnnouncementTypeForm\_setAnnouncementTypeAssocId(), ArticleXMLGalley\_xsltCacheMiss(), ReviewFormHandler\activateReviewForm(), GroupHandler\addMembership(), ArticleXMLGalleyDAO\appendXMLGalleys(), ArticleGalleyForm\ArticleGalleyForm(), BookForReviewForm\BookForReviewForm(), SwordPlugin\callbackAuthorDeposits(), CustomBlockManagerPlugin\callbackLoadCategory(), AboutHandler\contact(), ReviewFormHandler\copyReviewForm(), ReviewFormHandler\copyReviewFormElement(), CreateReviewerForm\CreateReviewerForm(), SubscriptionManagerHandler\createUser(), ReviewFormHandler\deactivateReviewForm(), EmailHandler\deleteCustomEmail(), JournalSetupStep5Form\deleteImage(), ReviewFormHandler\deleteReviewForm(), ReviewFormHandler\deleteReviewFormElement(), SubscriptionAction\deleteSubscription(), SubscriptionAction\deleteSubscriptionType(), EmailHandler\disableEmail(), PeopleHandler\disableUser(), EmailTemplateForm\display(), IssueForm\display(), ReviewFormResponseForm\display(), UsageStatsReportPlugin\display(), UserManagementForm\display(), SubscriptionReportPlugin\display(), ArticleGalleyForm\display(), DOAJPlugin\display(), VersionForm\display(), ContextForm\display(), SearchForm\display(), SubscriptionForm\display(), SuppFileForm\display(), ProfileForm\display(), RegistrationForm\display(), SectionForm\display(), CommentForm\display(), IssueGalleyForm\display(), MetadataForm\display(), ExternalFeedPlugin\displayHomepage(), AboutHandler\displayMembership(), ReviewerAction\downloadReviewerFile(), GroupHandler\editGroup(), AboutHandler\editorialPolicies(), AboutHandler\editorialTeam(), AboutHandler\editorialTeamBio(), ReviewFormHandler\editReviewForm(), ReviewFormHandler\editReviewFormElement(), SubscriptionAction\editSubscription(), SubscriptionAction\editSubscriptionType(), PeopleHandler\editUser(), ProofreadCommentForm\email(), LayoutCommentForm\email(), CopyeditCommentForm\email(), EditorDecisionCommentForm\email(), ManagerHandler\email(), CommentForm\email(), EditCommentForm\emailHelper(), EmailHandler\emails(), EmailHandler\enableEmail(), PeopleHandler\enrollSync(), PeopleHandler\enrollSyncSelect(), JournalSetupForm\execute(), AbntSettingsForm\execute(), ReviewFormForm\execute(), GroupForm\execute(), ReviewObjectTypeForm\execute(), PayMethodSettingsForm\execute(), LanguageSettingsForm\execute(), ObjectForReviewAssignmentForm\execute(), EmailTemplateForm\execute(), ReviewObjectMetadataForm\execute(), ExternalFeedForm\execute(), SubscriptionPolicyForm\execute(), CreateReviewerForm\execute(), SubscriptionTypeForm\execute(), ArticleGalleyForm\execute(), ObjectForReviewForm\execute(), CommentForm\execute(), ThesisForm\execute(), IssueGalleyForm\execute(), StudentThesisForm\execute(), SectionForm\execute(), RegistrationForm\execute(), SubscriptionForm\execute(), ProfileForm\execute(), UserManagementForm\execute(), BookForReviewForm\execute(), IssueForm\execute(), MetadataForm\execute(), ResolverPlugin\fetch(), ThesisFeedGatewayPlugin\fetch(), WebFeedGatewayPlugin\fetch(), AnnouncementFeedGatewayPlugin\fetch(), SettingsForm\fetch(), RoleBlockPlugin\getBlockTemplateFilename(), RelatedItemsBlockPlugin\getContents(), InformationBlockPlugin\getContents(), KeywordCloudBlockPlugin\getContents(), ExternalFeedBlockPlugin\getContents(), OpenAdsBlockPlugin\getContents(), LanguageToggleBlockPlugin\getContents(), AnnouncementFeedBlockPlugin\getContents(), ThesisFeedBlockPlugin\getContents(), WebFeedBlockPlugin\getContents(), CustomBlockPlugin\getContents(), SwordPlugin\getEnabled(), GatewayPlugin\getEnabled(), PiwikPlugin\getEnabled(), SectionEditorSubmission\getHighlightClass(), ArticleHTMLGalley\getHTMLContents(), ArticleXMLGalley\getHTMLContents(), IssueAction\getIssueOptions(), AppLocale\getLocale(), AppLocale\getLocalePrecedence(), AppLocale\getPrimaryLocale(), SectionEditorAction\getReviewDueDate(), ExternalFeedPlugin\getStyleSheetFile(), AppLocale\getSupportedFormLocales(), AppLocale\getSupportedLocales(), GroupForm\GroupForm(), GroupHandler\groups(), ReferralPlugin\handleAuthorTemplateInclude(), AboutHandler\history(), InformationHandler\index(), ThesisHandler\index(), ManagerHandler\index(), RTAdminHandler\index(), IndividualSubscriptionForm\IndividualSubscriptionForm(), PayMethodSettingsForm\initData(), JournalSetupForm\initData(), ReviewFormForm\initData(), EmailTemplateForm\initData(), LanguageSettingsForm\initData(), SettingsForm\initData(), SubscriptionPolicyForm\initData(), ReviewFormElementForm\initData(), IssueForm\initData(), PaymentSettingsForm\initData(), SectionForm\initData(), PhpMyVisitesPlugin\insertFooter(), PiwikPlugin\insertFooter(), GoogleAnalyticsPlugin\insertFooter(), InstitutionalSubscriptionForm\InstitutionalSubscriptionForm(), Action\instructions(), Validation\isAuthorized(), ManualPaymentPlugin\isConfigured(), PayPalPlugin\isConfigured(), IssueGalleyForm\IssueGalleyForm(), IssueHandler\IssueHandler(), HandlerValidatorJournal\isValid(), JournalOAI\JournalOAI(), AboutHandler\journalSponsorship(), MailTemplate\MailTemplate(), PubIdPlugin\manage(), AlmPlugin\manage(), CustomBlockManagerPlugin\manage(), StaticPagesPlugin\manage(), CustomBlockPlugin\manage(), AbntCitationPlugin\manage(), AnnouncementFeedPlugin\manage(), ThesisFeedPlugin\manage(), PhpMyVisitesPlugin\manage(), BrowsePlugin\manage(), WebFeedPlugin\manage(), StopForumSpamPlugin\manage(), ThesisPlugin\manage(), PiwikPlugin\manage(), XMLGalleyPlugin\manage(), GoogleAnalyticsPlugin\manage(), SwordPlugin\manage(), ExternalFeedPlugin\manage(), AboutHandler\memberships(), PeopleHandler\mergeUsers(), GroupHandler\moveGroup(), ReviewFormHandler\moveReviewForm(), SubscriptionAction\moveSubscriptionType(), OJSPaymentAction\payments(), OJSPaymentAction\payMethodSettings(), PeopleHandler\people(), ReviewFormHandler\previewReviewForm(), ProofreaderAction\proofreadEmail(), ReviewerAction\recordRecommendation(), SectionEditorAction\removeArticleCoverPage(), PeopleHandler\removeUser(), SubscriptionAction\renewSubscription(), StatisticsHandler\report(), EmailHandler\resetAllEmails(), SubscriptionAction\resetDateReminded(), EmailHandler\resetEmail(), ReviewFormHandler\reviewFormElements(), ReviewObjectMetadataForm\ReviewObjectMetadataForm(), ReviewObjectTypeForm\ReviewObjectTypeForm(), OpenAdsPlugin\rtOutputFilter(), PaymentSettingsForm\save(), ThesisHandler\save(), OJSPaymentAction\savePaymentSettings(), OJSPaymentAction\savePayMethodSettings(), SearchHandler\SearchHandler(), SectionForm\SectionForm(), SubscriptionAction\sendOnlinePaymentNotificationEmail(), GatewayPlugin\setEnabled(), PiwikPlugin\setEnabled(), XMLGalleyPlugin\setEnabled(), PubIdPlugin\setEnabled(), AboutHandler\setupTemplate(), InformationHandler\setupTemplate(), EditorHandler\setupTemplate(), StudentThesisForm\StudentThesisForm(), SubmissionEditHandler\submissionReview(), AboutHandler\submissions(), ThesisHandler\submit(), IssueAction\subscriptionRequired(), SubscriptionAction\subscriptions(), SubscriptionAction\subscriptionsSummary(), SubscriptionTypeForm\SubscriptionTypeForm(), SubscriptionAction\subscriptionTypes(), ThesisForm\ThesisForm(), PeopleHandler\unEnroll(), EmailHandler\updateEmail(), ReferralHandler\updateReferral(), ReviewFormHandler\updateReviewForm(), ReviewFormHandler\updateReviewFormElement(), SubscriptionAction\updateSubscription(), SubscriptionAction\updateSubscriptionType(), SubscriptionManagerHandler\updateUser(), JournalSetupStep5Form\uploadImage(), JournalSetupStep5Form\uploadStyleSheet(), SubscriptionManagerHandler\userProfile(), PeopleHandler\userProfile(), IssueForm\validate(), ArticleGalleyForm\validate(), SuppFileForm\validate(), IssueGalleyForm\validate(), SectionEditorHandler\validate(), MetadataForm\validate(), GroupHandler\validate(), IssueManagementHandler\validate(), StopForumSpamPlugin\validateExecute(), ThesisHandler\view(), ArticleXMLGalley\viewFileContents(), OJSPaymentAction\viewPayment(), OJSPaymentAction\viewPayments(), XMLGalleyPlugin\viewXMLGalleyFile(), and SubmissionEditHandler\waivePublicationFee().

Request::getRequestedContextPath (   $contextLevel = null)

Deprecated

See Also
PKPPageRouter::getRequestedContextPath()

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

References PKPRequest\_checkThis().

Referenced by PKPHandler\hashPageContext().

Request::getRequestedJournalPath ( )
Request::redirectHome ( )

Deprecated

See Also
PageRouter::redirectHome()

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

References PKPRequest\_checkThis().

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

Deprecated

See Also
PKPPageRouter::url()

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

References PKPRequest\_checkThis().

Referenced by SitemapHandler\_createJournalSitemap(), SitemapHandler\_createSitemapIndex(), PubIdPlugin\_setBreadcrumbs(), LucenePlugin\_setBreadcrumbs(), MailTemplate\assignParams(), SwordPlugin\callbackAuthorDeposits(), SubscriptionManagerHandler\createUser(), DataverseHandler\dataAvailabilityPolicy(), PeopleHandler\disableUser(), SubscriptionHandler\editSubscriptionType(), SubscriptionManagerHandler\editSubscriptionType(), PeopleHandler\editUser(), ManagerHandler\email(), AuthorAction\emailEditorDecisionComment(), EmailHandler\emails(), PeopleHandler\enrollSearch(), RegistrationForm\execute(), Dc11SchemaArticleAdapter\extractMetadataFromDataObject(), DOAJExportDom\generateArticleDom(), MetsExportDom\generateArticleFileDom(), MetsExportDom\generateArticleSuppFileDom(), CrossRefExportDom\generateComponentListDom(), CrossRefExportDom\generateJournalArticleDom(), CrossRefExportDom\generateJournalIssueDom(), ArticleHTMLGalley\getHTMLContents(), ArticleXMLGalley\getHTMLContents(), Journal\getUrl(), CoinsPlugin\insertFooter(), CustomBlockManagerPlugin\manage(), StaticPagesPlugin\manage(), CustomBlockPlugin\manage(), AdminPeopleHandler\mergeUsers(), PeopleHandler\mergeUsers(), PeopleHandler\people(), SubmissionEditHandler\proofGalleyFile(), ProofreaderAction\proofreadEmail(), ManagerPaymentHandler\savePaymentSettings(), SubscriptionManagerHandler\savePaymentSettings(), ManagerPaymentHandler\savePayMethodSettings(), SubscriptionManagerHandler\savePayMethodSettings(), SectionHandler\sections(), SubscriptionAction\sendOnlinePaymentNotificationEmail(), BooksForReviewReminder\sendReminder(), ObjectsForReviewReminder\sendReminder(), ImportExportPlugin\setBreadcrumbs(), CustomThemePlugin\setBreadcrumbs(), CounterReportPlugin\setBreadcrumbs(), TimedViewReportPlugin\setBreadcrumbs(), StopForumSpamPlugin\setBreadcrumbs(), PhpMyVisitesPlugin\setBreadcrumbs(), ThesisPlugin\setBreadcrumbs(), PiwikPlugin\setBreadcrumbs(), GoogleAnalyticsPlugin\setBreadcrumbs(), ReferralPlugin\setBreadcrumbs(), ExternalFeedPlugin\setBreadcrumbs(), BrowsePlugin\setBreadcrumbs(), AbntCitationPlugin\setBreadcrumbs(), ReportPlugin\setBreadcrumbs(), AdminHandler\setupTemplate(), DataverseHandler\setupTemplate(), AboutHandler\setupTemplate(), CopyeditorHandler\setupTemplate(), ManagerHandler\setupTemplate(), ProofreaderHandler\setupTemplate(), RTAdminHandler\setupTemplate(), BooksForReviewHandler\setupTemplate(), ReviewerHandler\setupTemplate(), BooksForReviewAuthorHandler\setupTemplate(), SectionHandler\setupTemplate(), SectionEditorHandler\setupTemplate(), LayoutEditorHandler\setupTemplate(), ThesisHandler\setupTemplate(), SubscriptionHandler\setupTemplate(), EditorHandler\setupTemplate(), SubscriptionManagerHandler\setupTemplate(), BooksForReviewEditorHandler\setupTemplate(), TemplateManager\smartyGetHelpId(), TemplateManager\smartyHelpTopic(), TemplateManager\smartyPageLinks(), SectionEditorAction\submissionBreadcrumb(), ThesisHandler\submit(), OAIMetadataFormat_RFC1807\toXml(), OAIMetadataFormat_MARC21\toXml(), OAIMetadataFormat_MARC\toXml(), OAIMetadataFormat_NLM\toXml(), GroupHandler\updateGroup(), SubscriptionHandler\updateSubscriptionType(), SubscriptionManagerHandler\updateSubscriptionType(), SubscriptionManagerHandler\updateUser(), PeopleHandler\updateUser(), SubscriptionManagerHandler\userProfile(), PeopleHandler\userProfile(), ThesisHandler\view(), and ArticleXMLGalley\viewFileContents().


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