Config Class Reference

Static Public Member Functions
static	getConfigFileName ()
static &	getContextBaseUrls ()
static &	getData ()
static	getVar ($section, $key, $default=null)
static &	reloadData ()
static	setConfigFileName ($configFile)

Detailed Description

Config class for accessing configuration parameters.

Definition at line 27 of file Config.inc.php.

Member Function Documentation

getConfigFileName()

static Config::getConfigFileName ( )

static

Return the path to the configuration file.

Returns

string

Definition at line 86 of file Config.inc.php.

References Registry\get().

Referenced by reloadData(), PKPTestCase\setTestConfiguration(), ConfigTest\testGetDefaultConfigFileName(), ConfigTest\testSetConfigFileName(), and Installer\updateConfig().

getContextBaseUrls()

static& Config::getContextBaseUrls ( )

static

Get context base urls from config file.

Returns

array Empty array if none is set.

Definition at line 94 of file Config.inc.php.

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

Referenced by Core\_checkBaseUrl(), Core\_getBaseUrlAndPath(), and PKPUsageEventPlugin\buildUsageEvent().

getData()

static& Config::getData ( )

static

Get the current configuration data.

Returns

array the configuration data

Definition at line 44 of file Config.inc.php.

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

Referenced by getContextBaseUrls(), getVar(), AdminHandler\systemInfo(), ConfigTest\testReloadDataAndGetData(), CoreTest\testRemoveBaseUrl(), and CoreTest\testRemoveBaseUrlOverride().

getVar()

static Config::getVar (   $section,   $key,   $default = null  )

static

Retrieve a specified configuration variable.

Parameters

$section	string
$key	string
$default	mixed Optional default if the var doesn't exist

Returns

mixed May return boolean (in case of "off"/"on"/etc), numeric, string, or null.

Definition at line 35 of file Config.inc.php.

References getData().

Referenced by APP\Services\ContextService\__construct(), PKPSubmissionSubmitStep1Form\__construct(), Mail\__construct(), PKP\components\forms\context\PKPEmailSetupForm\__construct(), SessionManager\__construct(), PKP\components\forms\context\PKPReviewSetupForm\__construct(), UserDetailsForm\__construct(), CopyAccessLogFileTool\__construct(), IssueFileManager\__construct(), APIHandler\__construct(), RegistrationForm\__construct(), OAIConfig\__construct(), PKPApplication\__construct(), LegacyJR1\_assignTemplateCounterXML(), PKPFileUploadWizardHandler\_checkForRevision(), DataciteExportPlugin\_checkForTar(), ApiTokenDecodingMiddleware\_decode(), Dispatcher\_displayCached(), Core\_getBaseUrlAndPath(), PluginHelper\_getConnectionParams(), SubmissionSearch\_getMergedArray(), DataciteExportPlugin\_tarFiles(), PKPRouter\_urlGetBaseAndContext(), ImmersionThemePlugin\addSiteWideData(), HttpsPolicy\applies(), IssueHandler\archive(), ArticleSearchIndex\articleChangesFinished(), ArticleSearchIndex\articleMetadataChanged(), OrcidHandler\authorize(), ArticleHandler\authorize(), PKPTestHelper\backupTables(), PKPUsageEventPlugin\buildUsageEvent(), XmlWebService\call(), rebuildSearchIndex\callbackBaseUrl(), UsageStatsPlugin\callbackParseCronTab(), PKPCatalogHandler\category(), FileLoader\checkFolderStructure(), XSLTransformer\checkSupport(), SubmissionSearchDAO\clearIndex(), ManagementHandler\context(), FileArchive\create(), PKPInstall\createDirectories(), PKPUserUserXmlFilter\createPKPUserNode(), PLNPlugin\cronEnabled(), PKP\Services\PKPContextService\delete(), Dispatcher\dispatch(), PKPTemplateManager\display(), ImportExportPlugin\displayXMLValidationErrors(), Validation\encryptCredentials(), APIProfileForm\execute(), XmlToSqlTool\execute(), CopyAccessLogFileTool\execute(), ScheduledTask\execute(), MarkupSettingsForm\execute(), RegistrationForm\execute(), PluginHelper\extractPlugin(), fatalError(), APIProfileForm\fetch(), UsageStatsSettingsForm\fetch(), RegistrationForm\fetch(), SubscriptionPolicyForm\fetch(), PLNGatewayPlugin\fetch(), SubmissionSearchIndex\filterKeywords(), SessionManager\gc(), Validation\generatePasswordResetHash(), PKPTemplateManager\get_template_vars(), PrivateFileManager\getBasePath(), PKPRequest\getBaseUrl(), CacheManager\getCache(), CacheManager\getCacheImplementation(), MarkupConversionHelper\getCitationStyleHash(), PKPTemplateManager\getCompileId(), PublicFileManager\getContextFilesPath(), Session\getCSRFToken(), PKPCurlHelper\getCurlObject(), Context\getDateTimeFormats(), CustomBlockPlugin\getEnabled(), Mail\getEnvelopeSender(), ImportExportPlugin\getExportPath(), LibraryFile\getFilePath(), PKPApplication\getHttpClient(), QuickSubmitForm\getIssueOptions(), VersionCheck\getLatestVersion(), Context\getLocalizedDateFormatLong(), Context\getLocalizedDateFormatShort(), Context\getLocalizedDateTimeFormatLong(), Context\getLocalizedDateTimeFormatShort(), Context\getLocalizedTimeFormat(), PKPTemplateManager\getManager(), APIRouter\getPathInfoParts(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery(), PKPHandler\getRangeInfo(), PKPRequest\getRemoteAddr(), OrcidProfilePlugin\getSetting(), PLNPlugin\getSetting(), Plugin\getSetting(), PKPPublicFileManager\getSiteFilesPath(), PKPLocale\getTimeZone(), PKPComponentRouter\handleAuthorizationFailure(), IndexHandler\index(), OAIHandler\index(), LoginHandler\index(), BootstrapThreeThemePlugin\init(), HealthSciencesThemePlugin\init(), DefaultThemePlugin\init(), PKPString\init(), MarkupSettingsForm\initData(), DBConnection\initDefaultDBConnection(), AdminHandler\initialize(), PKPTemplateManager\initialize(), PKPLocale\initialize(), ArticleTombstoneManager\insertArticleTombstone(), PKPPageRouter\isCacheable(), RuntimeEnvironment\isCompatible(), OrcidProfilePlugin\isGloballyConfigured(), PKPRequest\isPathInfoEnabled(), PKPRequest\isRestfulUrlsEnabled(), FormValidatorReCaptcha\isValid(), PluginRegistry\loadCategory(), HealthSciencesThemePlugin\loadTemplateData(), OrcidProfilePlugin\logFilePath(), PKPString\mime_content_type(), ScheduledTaskHelper\notifyExecutionResult(), SearchHelperParser\open(), OrcidHandler\orcidAuthorize(), OrcidHandler\orcidVerify(), AboutSiteHandler\privacy(), MarkupConversionHelper\readCredentialsFromConfig(), SubscriptionSSOPlugin\register(), GoogleAnalyticsPlugin\register(), DOIPubIdPlugin\register(), BrowseBySectionPlugin\register(), ReviewReportPlugin\register(), URNPubIdPlugin\register(), RecommendBySimilarityPlugin\register(), RecommendByAuthorPlugin\register(), RegistrationHandler\register(), CustomBlockManagerPlugin\register(), PKPAcronPlugin\register(), OrcidProfilePlugin\register(), CitationStyleLanguagePlugin\register(), UsageStatsPlugin\register(), PKPTemplateManager\register_function(), TinyMCEPlugin\registerJS(), PKPTemplateManager\registerJSLibrary(), PKPTemplateManager\registerJSLibraryData(), Validation\registerUserSession(), PKPTestHelper\restoreDB(), PKPPageRouter\route(), MailTemplate\send(), Mail\send(), OrcidProfilePlugin\sendSubmissionToOrcid(), FileManager\setMode(), MedraWebserviceTest\setUp(), FunctionalMedraExportTest\setUp(), FunctionalDataciteExportTest\setUp(), PKPTemplateManager\setupBackendPage(), PKPHandler\setupTemplate(), LoginHandler\signIn(), PKPString\stripUnsafeHtml(), PaymentsHandler\subscriptionPolicies(), AdminHandler\systemInfo(), FileArchive\tarFunctional(), ConfigTest\testGetVar(), ConfigTest\testGetVarFromOtherConfig(), DBConnectionTest\testInitDefaultDBConnection(), DBDataXMLParserTest\testParseSQLData(), DBDataXMLParserTest\testParseSQLDDL(), DispatcherTest\testUrl(), PKPUploadPublicFileHandler\uploadFile(), OAIHandler\validate(), InstallHandler\validate(), MarkupSettingsForm\validate(), RegistrationForm\validate(), and PKPHandler\validate().

reloadData()

static& Config::reloadData ( )

static

Load configuration data from a file. The file is assumed to be formatted in php.ini style.

Returns

array the configuration data

Definition at line 61 of file Config.inc.php.

References fatalError(), getConfigFileName(), and ConfigParser\readConfig().

Referenced by getData(), ConfigTest\testReloadDataAndGetData(), and ConfigTest\testReloadDataWithNonExistentConfigFile().

setConfigFileName()

static Config::setConfigFileName (   $configFile )

static

Set the path to the configuration file.

Parameters

$configFile

string

Definition at line 73 of file Config.inc.php.

References Registry\set().

Referenced by PKPTestCase\setTestConfiguration(), PKPTestCase\setUp(), ConfigTest\testGetVarFromOtherConfig(), ConfigTest\testReloadDataAndGetData(), ConfigTest\testReloadDataWithNonExistentConfigFile(), and ConfigTest\testSetConfigFileName().

---

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

• Config.inc.php