Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Config Class Reference

Static Public Member Functions

static getConfigFileName ()
 
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

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(), and ConfigTest\testSetConfigFileName().

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 getVar(), SystemInfoGridHandler\initialize(), and ConfigTest\testReloadDataAndGetData().

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

Retrieve a specified configuration variable.

Parameters
$sectionstring
$keystring
$defaultstring optional
Returns
string

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

References getData().

Referenced by SubmissionSearch\_getMergedArray(), PKPAcronPlugin\_parseCrontab(), PageHandler\authorize(), XmlWebService\call(), SubmissionSearchDAO\clearIndex(), CopyAccessLogFileTool\CopyAccessLogFileTool(), FileArchive\create(), PKPUserUserXmlFilter\createPKPUserNode(), NotificationMailingListForm\display(), PayPalPlugin\displayPaymentForm(), PKPLanguageAction\downloadLocale(), PKPValidation\encryptCredentials(), CopyAccessLogFileTool\execute(), TranslatorAction\export(), FunctionalImportExportBaseTestCase\extractTarFile(), EmailTemplatesForm\fetch(), SubmissionSearchIndex\filterKeywords(), FormValidatorReCaptcha\FormValidatorReCaptcha(), PrivateFileManager\getBasePath(), LanguageToggleBlockPlugin\getBlockContext(), DevelopedByBlockPlugin\getBlockContext(), PublicFileManager\getContextFilesPath(), DevelopedByBlockPlugin\getEnabled(), LanguageToggleBlockPlugin\getEnabled(), PKPFile\getFileId(), LibraryFile\getFilePath(), AppLocale\getLocale(), Application\getPluginSettingsContextColumnName(), AppLocale\getPrimaryLocale(), ReviewerAction\getResponseEmail(), LanguageToggleBlockPlugin\getSeq(), DevelopedByBlockPlugin\getSeq(), PKPPublicFileManager\getSiteFilesPath(), AppLocale\getSupportedFormLocales(), AppLocale\getSupportedLocales(), InfoGridCellProvider\getTemplateVarsFromRowColumn(), PKPLocale\getTimeZone(), SubmissionFile\getType(), PKPUser\getUserInterests(), Handler\getWorkingContexts(), PKPLoginHandler\implicitAuthLogin(), PKPLoginHandler\index(), OAIHandler\index(), ReviewReminderForm\initData(), PKPAuditorReminderForm\initData(), ReviewerForm\initData(), AnnouncementGridHandler\initialize(), PublicationFormatTombstoneManager\insertTombstoneByPublicationFormat(), PKPLanguageAction\isDownloadAvailable(), PluginRegistry\loadCategory(), ServerInfoGridHandler\loadData(), PKPValidation\login(), Mail\Mail(), ParaciteRawCitationNlm30CitationSchemaFilter\process(), MonographSearchIndex\rebuildIndex(), PKPRequest\redirectSSL(), PKPAcronPlugin\register(), PayPalPlugin\register(), RegistrationHandler\registerUser(), PKPValidation\registerUserSession(), EditorAction\setDueDates(), FileCache\setEntireCache(), PKPFile\setFileId(), FileManager\setMode(), SubmissionFile\setType(), WebTestCase\setUp(), PKPLoginHandler\signIn(), TemplateManager\TemplateManager(), WorldcatNlm30CitationSchemaFilterTest\testExecuteWithDoi(), ConfigTest\testGetVar(), ConfigTest\testGetVarFromOtherConfig(), Plugin\updateSetting(), and PKPInstallHandler\validate().

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 getConfigFileName(), and ConfigParser\readConfig().

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

static Config::setConfigFileName (   $configFile)
static

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