Open Monograph Press  3.3.0
Application Class Reference
Inheritance diagram for Application:
PKPApplication iPKPApplicationInfoProvider

Public Member Functions

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

Static Public Member Functions

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

Additional Inherited Members

- Data Fields inherited from PKPApplication
 $allProducts
 
 $enabledProducts = array()
 

Detailed Description

Class describing this application.

See also
PKPApplication

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

Member Function Documentation

◆ getApplicationStages()

◆ getContextAssocType()

static Application::getContextAssocType ( )
static

Returns the context type for this application.

Implements iPKPApplicationInfoProvider.

Definition at line 203 of file Application.inc.php.

Referenced by PKPSitemapHandler\_createContextSitemap(), ReviewFormGridHandler\activateReviewForm(), ReviewFormElementsGridHandler\authorize(), ReviewFormGridHandler\copyReviewForm(), ReviewFormGridHandler\deactivateReviewForm(), ReviewFormGridHandler\deleteReviewForm(), ReviewFormElementsGridHandler\deleteReviewFormElement(), UserSettingsDAO\deleteSetting(), ReviewFormGridHandler\editReviewForm(), ReviewFormForm\execute(), AnnouncementTypeForm\execute(), ReviewFormElementForm\execute(), EditReviewForm\execute(), ReviewerForm\execute(), EditReviewForm\fetch(), PKPReviewerReviewStep3Form\fetch(), ReviewerForm\fetch(), PKPMetricsDAO\foreignKeyLookup(), PKPToolsHandler\generateReport(), UsageStatsLoader\getAssoc(), PKPUsageStatsReportPlugin\getDefaultReportTemplates(), UsageStatsLoader\getExpectedPageAndOp(), PKPToolsHandler\getObjectTitle(), OPSUsageStatsReportPlugin\getObjectTypes(), UserSettingsDAO\getSetting(), UserSettingsDAO\getSettingsByContextId(), PKPUsageEventPlugin\getUsageEventData(), UserSettingsDAO\getUsersBySetting(), Context\getViews(), ReviewFormForm\initData(), ReviewFormElements\initData(), PreviewReviewForm\initData(), ReviewFormGridHandler\loadData(), AuthorReviewerGridHandler\readReview(), PKPReviewerGridHandler\readReview(), ReviewFormGridHandler\reviewFormPreview(), ReviewFormGridHandler\updateReviewForm(), ReviewFormElementsGridHandler\updateReviewFormElement(), UserSettingsDAO\updateSetting(), and AnnouncementHandler\view().

◆ getContextDAO()

static Application::getContextDAO ( )
static

Get the top-level context DAO.

Implements iPKPApplicationInfoProvider.

Definition at line 145 of file Application.inc.php.

References DAORegistry\getDAO().

Referenced by CopyAccessLogFileTool\__construct(), UsageStatsLoader\__construct(), AdminLanguageGridHandler\_canManage(), PKPSitemapHandler\_createSitemapIndex(), NotificationsGridCellProvider\_getTitle(), AdminLanguageGridHandler\_updateContextLocaleSettings(), PKPEmailTemplateHandler\add(), PKPContextHandler\add(), PKP\Services\PKPContextService\add(), UserFormHelper\assignRoleContent(), CitationsParsingTool\execute(), ReviewReminder\executeActions(), CSVImportExportPlugin\executeCLI(), PKPMetricsDAO\foreignKeyLookup(), MonographSearch\formatResults(), PKP\Services\PKPContextService\get(), NotificationsGridCellProvider\getCellActions(), PKPStatisticsHelper\getContext(), PKPPubIdPlugin\getContext(), PKP\Services\PKPNavigationMenuService\getDisplayStatus(), PKPPageRouter\getHomeUrl(), PKP\Services\PKPContextService\getMany(), PKPNotificationManager\getNotificationUrl(), ApproveSubmissionNotificationManager\getNotificationUrl(), PKPEditingProductionStatusNotificationManager\getNotificationUrl(), SubmissionNotificationManager\getNotificationUrl(), PKPToolsHandler\getObjectTitle(), MonographSearch\getSearchFilters(), PKPHandler\getSiteRedirectContext(), MonographSearch\getSparseArray(), PKPHandler\getTargetContext(), TemplateManager\initialize(), Installer\installDefaultNavigationMenus(), ContextGridHandler\loadData(), PKPPubIdPlugin\manage(), Installer\migrateSidebarBlocks(), Upgrade\migrateStaticPagesToNavigationMenuItems(), ProfileHandler\profile(), UserFormHelper\saveRoleContent(), PKPNotificationOperationManager\sendNotificationEmail(), LanguageGridHandler\setContextPrimaryLocale(), ContextGridHandler\setDataElementSequence(), RegistrationHandler\validate(), and PKPPublicIdentifiersForm\validate().

◆ getContextDepth()

Application::getContextDepth ( )

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], or Press [1]).

Returns
int

Reimplemented from PKPApplication.

Definition at line 46 of file Application.inc.php.

◆ getContextList()

Application::getContextList ( )

Get a list of contexts for this application.

Returns
array

Reimplemented from PKPApplication.

Definition at line 54 of file Application.inc.php.

Referenced by PKPRequest\getQueryArray().

◆ getDAOMap()

Application::getDAOMap ( )

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

Returns
array

Reimplemented from PKPApplication.

Definition at line 87 of file Application.inc.php.

◆ getFileDirectories()

static Application::getFileDirectories ( )
static

Get the file directory array map used by the application.

Implements iPKPApplicationInfoProvider.

Definition at line 196 of file Application.inc.php.

Referenced by ContextFileManager\getBasePath(), and BaseSubmissionFileManager\getBasePath().

◆ getName()

static Application::getName ( )
static

Get the symbolic name of this application

Returns
string

Reimplemented from PKPApplication.

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

Referenced by InstallForm\initData(), and UsageStatsHandler\privacyInformation().

◆ getNameKey()

Application::getNameKey ( )

Get the locale key for the name of this application.

Returns
string

Reimplemented from PKPApplication.

Definition at line 70 of file Application.inc.php.

Referenced by ScheduledTaskHelper\getMessage().

◆ getPaymentManager()

◆ getPluginCategories()

Application::getPluginCategories ( )

Get the list of plugin categories for this application.

Returns
array

Reimplemented from PKPApplication.

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

Referenced by InstallPluginVersionTool\execute().

◆ getRepresentationDAO()

◆ getSectionDAO()

static Application::getSectionDAO ( )
static

◆ getSubmissionSearchDAO()

static Application::getSubmissionSearchDAO ( )
static

◆ getSubmissionSearchIndex()

◆ getVersionDescriptorUrl()

Application::getVersionDescriptorUrl ( )

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

Returns
string

Reimplemented from PKPApplication.

Definition at line 79 of file Application.inc.php.


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