Open Journal Systems  3.3.0
Public Member Functions | Static Public Member Functions | Data Fields
PKPApplication Class Reference
Core
Inheritance diagram for PKPApplication:
iPKPApplicationInfoProvider Application

Public Member Functions

 __construct ()
 
 execute ()
 
 getCCLicenseBadge ($ccLicenseURL, $locale=null)
 
 getContextDepth ()
 
 getContextList ()
 
& getCurrentVersion ()
 
 getDAOMap ()
 
 getDefaultMetricType ()
 
 getDispatcher ()
 
& getEnabledProducts ($category=null, $mainContextId=null)
 
 getHttpClient ()
 
 getMetrics ($metricType=null, $columns=array(), $filter=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ($withDisplayNames=false)
 
 getNameKey ()
 
 getPluginCategories ()
 
 getPrimaryMetricByAssoc ($assocType, $assocId)
 
 getQualifiedDAOName ($name)
 
 getRequest ()
 
 getVersionDescriptorUrl ()
 

Static Public Member Functions

static get ()
 
static getApplication ()
 
static getCCLicenseOptions ()
 
static getIntMaxFileMBs ()
 
static getMetadataFields ()
 
static getName ()
 
static getReadableMaxFileSize ()
 
static getRoleNames ($contextOnly=false, $roleIds=null)
 
static getWorkflowStageColor ($stageId)
 
static getWorkflowStageName ($stageId)
 
static getWorkflowTypeRoles ()
 
- Static Public Member Functions inherited from iPKPApplicationInfoProvider
static getApplicationStages ()
 
static getContextAssocType ()
 
static getContextDAO ()
 
static getFileDirectories ()
 
static getRepresentationDAO ()
 
static getSectionDAO ()
 
static getSubmissionSearchDAO ()
 
static getSubmissionSearchIndex ()
 

Data Fields

 $allProducts
 
 $enabledProducts = array()
 

Detailed Description

Class describing this application.

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

Constructor & Destructor Documentation

◆ __construct()

PKPApplication::__construct ( )

Constructor

Definition at line 123 of file PKPApplication.inc.php.

References BASE_SYS_DIR, customAutoload(), fatalError(), DBConnection\getInstance(), Config\getVar(), PKPString\init(), Core\microtime(), and Registry\set().

Member Function Documentation

◆ execute()

PKPApplication::execute ( )

This executes the application by delegating the request to the dispatcher.

Definition at line 311 of file PKPApplication.inc.php.

References getDispatcher(), and getRequest().

◆ get()

static PKPApplication::get ( )
static

Get the current application object

Returns
Application

Definition at line 235 of file PKPApplication.inc.php.

References Registry\get().

Referenced by ManageQueryNoteFilesGridHandler\__construct(), QueryNoteFilesGridHandler\__construct(), CreateReviewerForm\__construct(), DependentFilesGridHandler\__construct(), IdentityForm\__construct(), IssueGridCellProvider\__construct(), PKPSubmissionSubmitStep1Form\__construct(), PKPUserImportExportDeployment\__construct(), PKP\components\forms\context\PKPDisableSubmissionsForm\__construct(), PKP\components\forms\announcement\PKPAnnouncementForm\__construct(), GenreForm\__construct(), APIHandler\__construct(), UsageStatsPlugin\__construct(), PKP\components\forms\context\PKPThemeForm\__construct(), RegistrationForm\__construct(), JournalOAI\__construct(), CommandLineTool\__construct(), CategoryForm\__construct(), PKPPublicIdentifiersForm\__construct(), EditorialReportNotificationManager\__construct(), PKPAssignPublicIdentifiersForm\__construct(), MedraSettingsForm\__construct(), DataciteSettingsForm\__construct(), URNSettingsForm\__construct(), DOISettingsForm\__construct(), CrossRefSettingsForm\__construct(), MailTemplate\__construct(), PKPFileUploadWizardHandler\_attachEntities(), PKP\Services\PKPNavigationMenuService\_callbackHandleCustomNavigationMenuItems(), UsageStatsPlugin\_downloadStatsCacheMiss(), ThemePlugin\_getBaseUrl(), QueriesGridHandler\_getCurrentUserCanLeave(), PKP\components\listPanels\PKPSubmissionsListPanel\_getItemsParams(), PluginGalleryGridHandler\_getSpecifiedPlugin(), XMLParser\_getStream(), CounterReport\_getVendorComponent(), HtmlArticleGalleyPlugin\_handleOjsUrl(), LensGalleyPlugin\_handleOjsUrl(), ApiCsrfMiddleware\_isCSRFValid(), OAIMetadataFormat_JATS\_mungeMetadata(), SubscriptionForm\_prepareNotificationEmail(), PKPStatsPublicationHandler\_processSearchPhrase(), ThemePlugin\_registerScripts(), PKP\Services\PKPPublicationService\_saveFileParam(), PLNPlugin\_sendFile(), IssueHandler\_setupIssueTemplate(), PKPRouterTestCase\_setUpMockDAOs(), PKPAnnouncementHandler\add(), PKP\Services\PKPPublicationService\add(), UsageStatsPlugin\addJavascriptData(), BrowseBySectionPlugin\addMenuItemTypes(), URNPubIdPlugin\addPublicationFormFields(), ManualPaymentPlugin\addSettings(), PaypalPaymentPlugin\addSettings(), Form\addSupportedFormLocale(), ArticleCrossrefXmlFilter\appendAsCrawledCollectionNodes(), ArticleCrossrefXmlFilter\appendTextMiningCollectionNodes(), HtmlArticleGalleyPlugin\articleDownloadCallback(), LensGalleyPlugin\articleDownloadCallback(), SubmissionMailTemplate\assignParams(), MailTemplate\assignParams(), OrcidProfilePlugin\buildOAuthUrl(), PKPUsageEventPlugin\buildUsageEvent(), AnnouncementFeedPlugin\callbackAddLinks(), WebFeedPlugin\callbackAddLinks(), StaticPagesPlugin\callbackHandleContent(), PKPAcronPlugin\callbackLoadHandler(), RecommendByAuthorPlugin\callbackTemplateArticlePageFooter(), RecommendBySimilarityPlugin\callbackTemplateArticlePageFooter(), PKP\Services\PKPSubmissionService\canCurrentUserDelete(), PKP\Services\PKPUserService\canCurrentUserGossip(), PKP\Services\PKPSubmissionService\canEditPublication(), PKP\Services\PKPUserService\canUserAccessStage(), OAI\checkParams(), UpgradeTool\checkVersion(), AdminHandler\clearScheduledTaskLogFiles(), ArticleMedraXmlFilter\createArticleNode(), ArticleCrossrefXmlFilter\createComponentListNode(), PKPInstall\createConfig(), O4DOIXmlFilter\createHeadNode(), IssueMedraXmlFilter\createIssueNode(), ArticleCrossrefXmlFilter\createJournalArticleNode(), IssueCrossrefXmlFilter\createJournalIssueNode(), PLNPlugin\curlGet(), PKPAnnouncementHandler\delete(), DataciteExportPlugin\depositXML(), UsageStatsPlugin\displayReaderStatistics(), UpgradeTool\download(), AdminHandler\downloadScheduledTaskLogFile(), PKPAnnouncementHandler\edit(), PKP\Services\PKPPublicationService\edit(), PKPStatsHandler\editorial(), PKPSiteHandler\editTheme(), PKPContextHandler\editTheme(), UserRolesRequiredPolicy\effect(), UserAccessibleWorkflowStageRequiredPolicy\effect(), PKPSiteAccessPolicy\effect(), StageRolePolicy\effect(), SetVersionTool\execute(), PKPSubmissionSubmitStep4Form\execute(), SubmissionSubmitStep4Form\execute(), InitiateExternalReviewForm\execute(), ReinstateReviewerForm\execute(), UnassignReviewerForm\execute(), NewReviewRoundForm\execute(), InitiateReviewForm\execute(), BaseProfileForm\execute(), NewLibraryFileForm\execute(), UploadPluginForm\execute(), IndividualSubscriptionForm\execute(), UserEmailForm\execute(), ReviewFormForm\execute(), InstallLanguageForm\execute(), ManageSubmissionFilesForm\execute(), EmailReviewerForm\execute(), APIProfileForm\execute(), PaymentTypesForm\execute(), PromoteForm\execute(), IssueAccessForm\execute(), RolesForm\execute(), CreateReviewerForm\execute(), ReviewerNotifyActionForm\execute(), PKPSubmissionSubmitStep3Form\execute(), ContactForm\execute(), IdentityForm\execute(), NewNoteForm\execute(), UserForm\execute(), SubmissionChecklistForm\execute(), CitationStyleLanguageSettingsForm\execute(), ThankReviewerForm\execute(), SendReviewsForm\execute(), UsageStatsSettingsForm\execute(), PKPSectionForm\execute(), ReviewFormElementForm\execute(), EditReviewForm\execute(), PKPReviewerReviewStep3Form\execute(), QueryNoteForm\execute(), GenreForm\execute(), InstitutionalSubscriptionForm\execute(), ReviewReminderForm\execute(), SubmissionFilesUploadForm\execute(), PublicProfileForm\execute(), PKPStageParticipantNotifyForm\execute(), PKPNotificationSettingsForm\execute(), SectionForm\execute(), SubscriptionTypeForm\execute(), IssueGalleyForm\execute(), RecommendationForm\execute(), SubscriptionPolicyForm\execute(), UserGroupForm\execute(), PKPAuthorForm\execute(), IssueForm\execute(), SubscriptionForm\execute(), RegistrationForm\execute(), CategoryForm\execute(), PKPReportGeneratorForm\execute(), UserDetailsForm\execute(), ReviewerForm\execute(), PKPSubmissionSubmitStep1Form\execute(), QueryForm\execute(), StatisticsReport\executeActions(), ResolverPlugin\exportHoldings(), Dc11SchemaArticleAdapter\extractMetadataFromDataObject(), UsageStatsSettingsForm\fetch(), WebFeedGatewayPlugin\fetch(), CounterReport\filterForContext(), UserStageAssignmentDAO\filterUsersNotAssignedToStageInUserGroup(), ArticleSearch\formatResults(), Version\fromString(), PKPSubmissionHandler\get(), getApplication(), UsageStatsLoader\getAssoc(), AuthorDAO\getAuthorsAlphabetizedByJournal(), PluginRegistry\getCategories(), ExportPublishedSubmissionsListGridCellProvider\getCellActions(), PubIdExportIssuesListGridCellProvider\getCellActions(), PubIdExportRepresentationsListGridCellProvider\getCellActions(), APP\components\forms\FieldSelectIssue\getConfig(), APP\components\listPanels\SubmissionsListPanel\getConfig(), PKP\components\listPanels\PKPSubmissionsListPanel\getConfig(), PKP\components\listPanels\PKPAnnouncementsListPanel\getConfig(), PKPPubIdPlugin\getContext(), UsageStatsLoader\getContextByPath(), Core\getContextPaths(), Issue\getCoverImageUrls(), PKPCurlHelper\getCurlObject(), GatewayPlugin\getCurrentContextId(), LazyLoadPlugin\getCurrentContextId(), VersionDAO\getCurrentVersion(), DAORegistry\getDAO(), Journal\getDefaultMetricType(), Context\getDefaultMetricType(), getDispatcher(), PKP\Services\PKPNavigationMenuService\getDisplayStatus(), APP\Services\NavigationMenuService\getDisplayStatusCallback(), UsageStatsPlugin\getDownloadFinishedEventHooks(), PKP\Services\PKPStatsService\getEmptyTimelineIntervals(), OAIMetadataFormatPlugin_JATS\getEnabled(), UsageStatsLoader\getExpectedPageAndOp(), UserDAO\getFetchParameters(), UsageStatsLoader\getFileTypeFromAssoc(), Identity\getFullName(), Submission\getGalleys(), getHttpClient(), APP\Services\SubmissionService\getInSections(), VersionCheck\getLatestVersion(), DOIPubIdPlugin\getLinkActions(), URNPubIdPlugin\getLinkActions(), Publication\getLocalizedCoverImageUrl(), Issue\getLocalizedCoverImageUrl(), Identity\getLocalizedData(), Identity\getLocalizedFamilyName(), AnnouncementNotificationManager\getMailTemplate(), PKPVocabHandler\getMany(), PKPStatsPublicationHandler\getMany(), PKPAnnouncementHandler\getMany(), PKPSubmissionHandler\getMany(), ScheduledTaskHelper\getMessage(), Journal\getMetrics(), Context\getMetrics(), UsageStatsLoader\getMetricType(), PKPNotificationManager\getNotificationUrl(), PKPApproveSubmissionNotificationManager\getNotificationUrl(), PKPEditingProductionStatusNotificationManager\getNotificationUrl(), EditorialReportNotificationManager\getNotificationUrl(), ThemePlugin\getOption(), OrcidProfilePlugin\getOrcidUrl(), PKPSubmissionHandler\getParticipants(), PKP\Services\PKPSubmissionService\getPropertyReviewAssignments(), PKP\Services\PKPSubmissionService\getPropertyStages(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery(), PKP\Services\PKPEmailTemplateService\getQueryBuilder(), UsageStatsPlugin\getReportPlugin(), GeneralPagingFeature\getRequestArgs(), SubscriberSelectGridHandler\getRequestArgs(), ArticleSearch\getResultSetOrderingOptions(), ReviewReportDAO\getReviewReport(), PKP\Services\PKPUserService\getRolesOverview(), APP\components\listPanels\SubmissionsListPanel\getSectionFilters(), ArticleSearch\getSparseArray(), CrossRefExportPlugin\getStatusActions(), FileDateGridColumn\getTemplateVarsFromRow(), NavigationMenuItemsGridCellProvider\getTemplateVarsFromRowColumn(), QueryNotesGridCellProvider\getTemplateVarsFromRowColumn(), NavigationMenusGridCellProvider\getTemplateVarsFromRowColumn(), QueriesGridCellProvider\getTemplateVarsFromRowColumn(), VersionDAO\getVersionHistory(), ArticleGalley\getViews(), PKPSection\getViews(), Context\getViews(), SubmissionFile\getViews(), WorkflowStageDAO\getWorkflowStageTranslationKeys(), PKP\Services\PKPSubmissionService\getWorkflowUrlByUserRoles(), NativeXmlPKPPublicationFilter\handleElement(), NativeXmlSubmissionFilter\handleElement(), OrcidProfilePlugin\handleFormDisplay(), OrcidProfilePlugin\handlePublicationStatusChange(), NativeXmlSubmissionFileFilter\handleRevisionChildElement(), OrcidProfilePlugin\handleSubmissionSubmitStep3FormExecute(), OrcidProfilePlugin\handleTemplateDisplay(), OrcidProfilePlugin\handleUserPublicProfileDisplay(), BootstrapThreeThemePlugin\init(), CriticalTimesThemePlugin\init(), DefaultThemePlugin\init(), InstallLanguageForm\initData(), CitationStyleLanguageSettingsForm\initData(), SectionForm\initData(), SubmissionChecklistForm\initData(), UsageStatsSettingsForm\initData(), ReviewFormForm\initData(), ReviewerNotifyActionForm\initData(), SendReviewsForm\initData(), ThankReviewerForm\initData(), EditorDecisionWithEmailForm\initData(), PromoteForm\initData(), ReviewReminderForm\initData(), PreviewReviewForm\initData(), PaymentTypesForm\initData(), GenreForm\initData(), ReviewFormElementForm\initData(), RecommendationForm\initData(), UserDetailsForm\initData(), SubscriptionPolicyForm\initData(), ReviewerForm\initData(), BrowseBySectionPlugin\initDataSectionFormFields(), QueryNoteFilesCategoryGridDataProvider\initGridDataProvider(), EditorialReportNotificationManager\initialize(), SubmissionEventLogGridHandler\initialize(), PKPTemplateManager\initialize(), PluginGalleryGridHandler\installPlugin(), Plugin\installSiteSettings(), ThemePlugin\isActive(), Validation\isAuthorized(), CustomBlockManagerPlugin\isSitePlugin(), PdfJsViewerPlugin\issueCallback(), StaticPagesPlugin\isTinyMCEInstalled(), FormValidatorPost\isValid(), FormValidatorCSRF\isValid(), CriticalTimesThemePlugin\loadArticleTemplateData(), PluginRegistry\loadCategory(), PluginGalleryGridHandler\loadData(), TocGridHandler\loadData(), SubscriptionSSOPlugin\loadHandlerCallback(), CriticalTimesThemePlugin\loadIssueTemplateData(), CriticalTimesThemePlugin\loadIssueTocHandler(), UsageStatsPlugin\loadJavascript(), CriticalTimesThemePlugin\loadSpotlightTemplateData(), CriticalTimesThemePlugin\loadTemplateData(), HealthSciencesThemePlugin\loadTemplateData(), URNPubIdPlugin\loadUrnFieldComponent(), PKPTestCase\mockRequest(), AnnouncementNotificationManager\notify(), DOAJXmlFilter\process(), DOAJJsonFilter\process(), TemplateBasedFilter\process(), PKP\Services\PKPPublicationService\publish(), PKPPubIdPluginHelper\readAssignInputData(), InstallLanguageForm\readInputData(), SubscriptionForm\readInputData(), BrowseBySectionPlugin\readSectionFormFields(), Form\readUserVars(), Validation\redirectLogin(), CustomBlockManagerPlugin\register(), UsageStatsPlugin\register(), GoogleAnalyticsPlugin\registerScript(), OrcidProfilePlugin\registrationFilter(), PKPSubmissionDAO\resetPermissions(), OAI\response(), ThemePlugin\saveOption(), MailTemplate\send(), Mail\send(), OrcidProfilePlugin\sendAuthorMail(), OpenAccessNotification\sendNotification(), ReviewReminder\sendReminder(), TocGridHandler\setDataElementInCategorySequence(), OAIMetadataFormatPlugin_JATS\setEnabled(), GeneralPagingFeature\setGridDataElements(), BrowseBySectionPlugin\setMenuItemDisplayDetails(), Installer\setStatsEmailSettings(), FunctionalNativeImportTest\setUp(), ArticleSearchTest\setUp(), TemplateManager\setupBackendPage(), PKPTemplateManager\setupBackendPage(), PKPTemplateManager\smartyUrl(), PKPToolsHandler\statistics(), PdfJsViewerPlugin\submissionCallback(), GoogleScholarPlugin\submissionView(), SubscriptionSSOPlugin\subscribedUserCallback(), PKPRouterTestCase\testGetContext(), FormValidatorPostTest\testIsValid(), FunctionalNativeImportTest\testNativeDoiImport(), ArticleSearchTest\testRetrieveResults(), ArticleSearchTest\testRetrieveResultsViaPluginHook(), OAIMetadataFormat_DCTest\testToXml(), OAIMetadataFormat_RFC1807\toXml(), OAIMetadataFormat_JATS\toXml(), PKP\Services\PKPPublicationService\unpublish(), PKP\Services\PKPSubmissionService\updateStatus(), ArticleHandler\userCanViewGalley(), PKPSubmissionSubmitStep1Form\validate(), PKP\Services\PKPSiteService\validate(), SectionForm\validate(), IssueGalleyForm\validate(), SubmissionFilesUploadForm\validate(), ArticleGalleyForm\validate(), SubmissionSubmitStep1Form\validate(), IssueForm\validate(), RegistrationForm\validate(), Form\validate(), APP\Services\ContextService\validateContext(), APP\Services\PublicationService\validatePublication(), PKP\Services\PKPPublicationService\version(), and ArticleHandler\view().

◆ getApplication()

static PKPApplication::getApplication ( )
static

Get the current application object

Returns
Application
Deprecated:
Use PKPApplication::get() instead.

Definition at line 227 of file PKPApplication.inc.php.

References get().

Referenced by SubmissionFileNativeXmlFilter\createSubmissionFileNode(), PLNPlugin\cronEnabled(), PLNGatewayPlugin\fetch(), DepositPackage\generateAtomDocument(), DepositPackage\generatePackage(), PLNPlugin\getServiceDocument(), IssueGalley\getViews(), and PKPSubmission\getViews().

◆ getCCLicenseBadge()

PKPApplication::getCCLicenseBadge (   $ccLicenseURL,
  $locale = null 
)

Get the Creative Commons license badge associated with a given license URL.

Parameters
$ccLicenseURLURL to creative commons license
$localestring Optional locale to return badge in
Returns
string HTML code for CC license

Definition at line 704 of file PKPApplication.inc.php.

References AppLocale\getLocale(), and PKPLocale\requireComponents().

Referenced by MarkupConversionHelper\buildSubmissionMetadata(), and DataciteXmlFilter\process().

◆ getCCLicenseOptions()

static PKPApplication::getCCLicenseOptions ( )
static

Get a mapping of license URL to license locale key for common creative commons licenses.

Returns
array

Definition at line 686 of file PKPApplication.inc.php.

Referenced by PKP\components\forms\context\PKPLicenseForm\__construct(), and PKP\components\forms\publication\PKPPublicationLicenseForm\__construct().

◆ getContextDepth()

PKPApplication::getContextDepth ( )
abstract

Get the "context depth" of this application, i.e. the number of parts of the URL after index.php that represent the context of the current request (e.g. Journal [1], or Conference and Scheduled Conference [2]).

Returns
int

Reimplemented in Application.

Referenced by getEnabledProducts().

◆ getContextList()

PKPApplication::getContextList ( )
abstract

Get the list of the contexts available for this application i.e. the various parameters that are needed to represent the (e.g. array('journal') or array('conference', 'schedConf'))

Returns
Array

Reimplemented in Application.

Referenced by getEnabledProducts().

◆ getCurrentVersion()

& PKPApplication::getCurrentVersion ( )

Return the current version of the application.

Returns
Version

Definition at line 410 of file PKPApplication.inc.php.

References getEnabledProducts(), and getName().

◆ getDAOMap()

PKPApplication::getDAOMap ( )

Get the map of DAOName => full.class.Path for this application.

Returns
array

Reimplemented in Application.

Definition at line 420 of file PKPApplication.inc.php.

Referenced by getQualifiedDAOName().

◆ getDefaultMetricType()

PKPApplication::getDefaultMetricType ( )

Returns the currently configured default metric type for this site. If no specific metric type has been set for this site then null will be returned.

Returns
null|string A metric type identifier or null if no default metric type could be identified.

Definition at line 548 of file PKPApplication.inc.php.

References getMetricTypes(), and getRequest().

Referenced by getMetrics().

◆ getDispatcher()

PKPApplication::getDispatcher ( )

Get the dispatcher implementation singleton

Returns
Dispatcher

Definition at line 287 of file PKPApplication.inc.php.

References Registry\get(), and get().

Referenced by execute().

◆ getEnabledProducts()

& PKPApplication::getEnabledProducts (   $category = null,
  $mainContextId = null 
)

This function retrieves all enabled product versions once from the database and caches the result for further access.

Parameters
$categorystring
$mainContextIdinteger Optional ID of the top-level context (e.g. Journal, Conference, Press) to query for enabled products
Returns
array

Definition at line 365 of file PKPApplication.inc.php.

References getContextDepth(), getContextList(), DAORegistry\getDAO(), and getRequest().

Referenced by getCurrentVersion().

◆ getHttpClient()

PKPApplication::getHttpClient ( )

Return a HTTP client implementation.

Returns
\GuzzleHttp\Client

Definition at line 243 of file PKPApplication.inc.php.

References $application, get(), and Config\getVar().

◆ getIntMaxFileMBs()

static PKPApplication::getIntMaxFileMBs ( )
static

Convert the max upload size to an integer in MBs

Returns
int

Definition at line 813 of file PKPApplication.inc.php.

Referenced by PKP\components\forms\FieldUpload\__construct().

◆ getMetadataFields()

static PKPApplication::getMetadataFields ( )
static

Get the supported metadata setting names for this application

Returns
array

Definition at line 830 of file PKPApplication.inc.php.

Referenced by PKPSubmissionMetadataFormImplementation\addChecks(), QuickSubmitForm\display(), and PKPSubmissionSubmitStep3Form\fetch().

◆ getMetrics()

PKPApplication::getMetrics (   $metricType = null,
  $columns = array(),
  $filter = array(),
  $orderBy = array(),
  $range = null 
)

Main entry point for PKP statistics reports.

See also
https://pkp.sfu.ca/wiki/index.php/OJSdeStatisticsConcept#Input_and_Output_Formats_.28Aggregation.2C_Filters.2C_Metrics_Data.29 for a full specification of the input and output format of this method.
Parameters
$metricTypenull|string|array metrics selection NB: If you want to use the default metric on journal level then you must set $metricType = null and add an explicit filter on a single journal ID. Otherwise the default site-level metric will be used.
$columnsstring|array column (aggregation level) selection
$filtersarray report-level filter selection
$orderByarray order criteria
$rangenull|DBResultRange paging specification
Returns
null|array The selected data as a simple tabular result set or null if the given parameter combination is not supported.

Definition at line 587 of file PKPApplication.inc.php.

References getDefaultMetricType(), getMetricTypes(), and PluginRegistry\loadCategory().

Referenced by getPrimaryMetricByAssoc().

◆ getMetricTypes()

PKPApplication::getMetricTypes (   $withDisplayNames = false)

Return all metric types supported by this application.

Returns
array An array of strings of supported metric type identifiers.

Definition at line 518 of file PKPApplication.inc.php.

References PluginRegistry\loadCategory().

Referenced by getDefaultMetricType(), and getMetrics().

◆ getName()

static PKPApplication::getName ( )
static

Get the symbolic name of this application

Returns
string

Reimplemented in Application.

Definition at line 321 of file PKPApplication.inc.php.

Referenced by getCurrentVersion().

◆ getNameKey()

PKPApplication::getNameKey ( )
abstract

Get the locale key for the name of this application.

Returns
string

Reimplemented in Application.

◆ getPluginCategories()

PKPApplication::getPluginCategories ( )
abstract

Get the list of plugin categories for this application.

Returns
array

Reimplemented in Application.

◆ getPrimaryMetricByAssoc()

PKPApplication::getPrimaryMetricByAssoc (   $assocType,
  $assocId 
)

Return metric in the primary metric type for the passed associated object.

Parameters
$assocTypeint
$assocIdint
Returns
int

Definition at line 661 of file PKPApplication.inc.php.

References getMetrics(), and getRequest().

◆ getQualifiedDAOName()

PKPApplication::getQualifiedDAOName (   $name)

Return the fully-qualified (e.g. page.name.ClassNameDAO) name of the given DAO.

Parameters
$namestring
Returns
string

Definition at line 503 of file PKPApplication.inc.php.

References Registry\get(), and getDAOMap().

◆ getReadableMaxFileSize()

static PKPApplication::getReadableMaxFileSize ( )
static

Get a human-readable version of the max file upload size

Returns
string

Definition at line 804 of file PKPApplication.inc.php.

Referenced by PKPTemporaryFilesHandler\uploadFile(), and PKPUploadPublicFileHandler\uploadFile().

◆ getRequest()

PKPApplication::getRequest ( )

Get the request implementation singleton

Returns
Request

Definition at line 270 of file PKPApplication.inc.php.

References Registry\get().

Referenced by ImmersionThemePlugin\addIssueTemplateData(), BrowseBySectionPlugin\addSitemapURLs(), AuthorDepositForm\display(), TextureArticleGalleyForm\execute(), execute(), BrowseBySectionPlugin\executeSectionFormFields(), DepositPackage\generateAtomDocument(), getDefaultMetricType(), getEnabledProducts(), and getPrimaryMetricByAssoc().

◆ getRoleNames()

static PKPApplication::getRoleNames (   $contextOnly = false,
  $roleIds = null 
)
static

Get a mapping of role keys and i18n key names.

Parameters
boolean$contextOnlyIf false, also returns site-level roles (Site admin)
array | null$roleIdsOnly return role names of these IDs
Returns
array

Reimplemented in Application.

Definition at line 736 of file PKPApplication.inc.php.

◆ getVersionDescriptorUrl()

PKPApplication::getVersionDescriptorUrl ( )
abstract

Get the URL to the XML descriptor for the current version of this application.

Returns
string

Reimplemented in Application.

◆ getWorkflowStageColor()

static PKPApplication::getWorkflowStageColor (   $stageId)
static

Get the hex color (#000000) of a workflow stage

Parameters
int$stageIdOne of the WORKFLOW_STAGE_* constants
Returns
string

Definition at line 787 of file PKPApplication.inc.php.

References AppLocale\requireComponents().

◆ getWorkflowStageName()

static PKPApplication::getWorkflowStageName (   $stageId)
static

Get the name of a workflow stage

Parameters
int$stageIdOne of the WORKFLOW_STAGE_* constants
Returns
string

Definition at line 769 of file PKPApplication.inc.php.

References AppLocale\requireComponents().

◆ getWorkflowTypeRoles()

static PKPApplication::getWorkflowTypeRoles ( )
static

Get a mapping of roles allowed to access particular workflows

Returns
array

Definition at line 756 of file PKPApplication.inc.php.

Referenced by PKPWorkflowHandler\access(), UserAccessibleWorkflowStageRequiredPolicy\effect(), UserAccessibleWorkflowStagePolicy\effect(), and PKPWorkflowHandler\index().

Field Documentation

◆ $allProducts

PKPApplication::$allProducts

Definition at line 118 of file PKPApplication.inc.php.

◆ $enabledProducts

PKPApplication::$enabledProducts = array()

Definition at line 117 of file PKPApplication.inc.php.

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