Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
Config Class Reference

Public Member Functions

 getConfigFileName ()
 
getContextBaseUrls ()
 
getData ()
 
 getVar ($section, $key, $default=null)
 
reloadData ()
 
 setConfigFileName ($configFile)
 

Detailed Description

Config class for accessing configuration parameters.

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

Member Function Documentation

Config::getConfigFileName ( )

Return the path to the configuration file.

Returns
string

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

References Registry\get().

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

& Config::getContextBaseUrls ( )

Get context base urls from config file.

Returns
array Empty array if none is set.

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

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

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

& Config::getData ( )

Get the current configuration data.

Returns
array the configuration data

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

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

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

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

Retrieve a specified configuration variable.

Parameters
$sectionstring
$keystring
$defaultstring optional
Returns
string

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

References getData().

Referenced by CounterReportPlugin\_assignTemplateCounterXML(), DOIExportPlugin\_checkForTar(), Citation\_cleanCitationString(), CopyAccessLogFileTool\_copyFile(), Dispatcher\_displayCached(), UsageStatsLoader\_getAssocFromUrl(), Core\_getBaseUrlAndPath(), DOIExportPlugin\_getExportPath(), ArticleSearch\_getMergedArray(), AcronPlugin\_parseCrontab(), EmbeddedServer\_runScript(), PluginManagementHandler\_setConnectionParams(), PluginManagementHandler\_uploadPlugin(), PKPRouter\_urlGetBaseAndContext(), HttpsPolicy\applies(), ArticleFileManager\ArticleFileManager(), ArticleNote\ArticleNote(), BooksForReviewEditorHandler\booksForReviewSettings(), PKPApplication\buildErrorMessage(), XmlWebService\call(), WebService\call(), rebuildSearchIndex\callbackBaseUrl(), SearchHandler\category(), FileLoader\checkFolderStructure(), Core\cleanVar(), ArticleNoteDAO\clearAllArticleNotes(), ArticleSearchDAO\clearIndex(), CommentForm\CommentForm(), ReviewerAction\confirmReview(), FileArchive\create(), PKPAnnouncementDAO\deleteAnnouncement(), PKPAnnouncementDAO\deleteAnnouncementById(), PKPAnnouncementDAO\deleteAnnouncementsByAssocId(), ArticleNoteDAO\deleteArticleNoteById(), AdminJournalHandler\deleteJournal(), ReviewAssignmentDAO\deleteReviewAssignmentsByArticle(), Dispatcher\dispatch(), UserManagementForm\display(), JournalSetupStep2Form\display(), ObjectsForReviewSettingsForm\display(), NotificationMailingListForm\display(), RegistrationForm\display(), JournalSetupStep1Form\display(), CommentForm\display(), PayPalPlugin\displayPaymentForm(), LanguageAction\downloadLocale(), Upgrade\dropAllIndexes(), EmailHandler\email(), Validation\encryptCredentials(), PKPApplication\errorHandler(), XmlToSqlTool\execute(), CopyAccessLogFileTool\execute(), JournalSiteSettingsForm\execute(), RegistrationForm\execute(), TranslatorAction\export(), FunctionalImportExportBaseTestCase\extractTarFile(), ArticleSearchIndex\filterKeywords(), SessionManager\gc(), CaptchaManager\generateImage(), MetsExportDom\generateIssueDmdSecDom(), AccessKey\getAccessKeyId(), ArticleNoteDAO\getAllArticleNoteFileIds(), PKPAnnouncementDAO\getAnnouncement(), PKPAnnouncement\getAnnouncementId(), PKPAnnouncementDAO\getAnnouncementsByAssocId(), PKPAnnouncementDAO\getAnnouncementsByTypeId(), Article\getArticleAbstract(), Article\getArticleCoverageChron(), Article\getArticleCoverageGeo(), Article\getArticleCoverageSample(), Article\getArticleCoverPageAltText(), Article\getArticleDiscipline(), Article\getArticleFileName(), Article\getArticleHeight(), ReviewAssignment\getArticleId(), Author\getArticleId(), Note\getArticleId(), Article\getArticleId(), ArticleNoteDAO\getArticleNoteById(), ArticleNoteDAO\getArticleNotes(), ArticleNoteDAO\getArticleNotesByUserId(), Article\getArticleOriginalFileName(), Article\getArticleShowCoverPage(), Article\getArticleSponsor(), Article\getArticleSubject(), Article\getArticleSubjectClass(), Article\getArticleTitle(), Article\getArticleType(), Article\getArticleWidth(), PKPAuthor\getAuthorId(), PrivateFileManager\getBasePath(), PKPRequest\getBaseUrl(), DonationBlockPlugin\getBlockContext(), DevelopedByBlockPlugin\getBlockContext(), HelpBlockPlugin\getBlockContext(), LanguageToggleBlockPlugin\getBlockContext(), FontSizeBlockPlugin\getBlockContext(), CustomBlockPlugin\getBlockContext(), Captcha\getCaptchaId(), Comment\getCommentId(), ArticleComment\getCommentId(), PKPPlugin\getContextSpecificSetting(), LanguageToggleBlockPlugin\getEnabled(), NotificationBlockPlugin\getEnabled(), DevelopedByBlockPlugin\getEnabled(), HelpBlockPlugin\getEnabled(), FontSizeBlockPlugin\getEnabled(), CustomBlockPlugin\getEnabled(), JournalDAO\getEnabledJournals(), JournalDAO\getEnabledJournalTitles(), PKPFile\getFileId(), ArticleFile\getFilePath(), ArticleGalley\getGalleyId(), Group\getGroupId(), ArticleNoteDAO\getInsertArticleNoteId(), OpenAdsPlugin\getInstallationPath(), Issue\getIssueId(), JournalDAO\getJournal(), PublicFileManager\getJournalFilesPath(), Journal\getJournalId(), AppLocale\getLocale(), Note\getNote(), Note\getNoteId(), AppLocale\getPrimaryLocale(), MetsExportDom\getPublicFilePath(), MetsExportDom\getPublicFileUrl(), MetsExportDom\getPublicSuppFileUrl(), QueuedPayment\getQueuedPaymentId(), PKPHandler\getRangeInfo(), ReviewAssignmentDAO\getReviewAssignmentById(), ReviewAssignmentDAO\getReviewAssignmentsByArticleId(), ReviewAssignmentDAO\getReviewAssignmentsByReviewFormId(), ReviewAssignmentDAO\getReviewAssignmentsByUserId(), ReviewFormElement\getReviewFormElementId(), ReviewFormElement\getReviewFormElementPossibleResponses(), ReviewFormElement\getReviewFormElementQuestion(), ReviewForm\getReviewFormId(), ReviewForm\getReviewFormTitle(), PKPReviewAssignment\getReviewId(), Section\getSectionId(), DonationBlockPlugin\getSeq(), DevelopedByBlockPlugin\getSeq(), HelpBlockPlugin\getSeq(), LanguageToggleBlockPlugin\getSeq(), FontSizeBlockPlugin\getSeq(), CustomBlockPlugin\getSeq(), PKPPublicFileManager\getSiteFilesPath(), Subscription\getSubscriptionId(), SuppFile\getSuppFileId(), AppLocale\getSupportedFormLocales(), AppLocale\getSupportedLocales(), Thesis\getThesisId(), SubmissionFile\getType(), PKPAnnouncementType\getTypeId(), PKPUser\getUserId(), PKPUser\getUserInterests(), PKPComponentRouter\handleAuthorizationFailure(), PKPLoginHandler\implicitAuthLogin(), CitationDAO\importCitations(), PKPLoginHandler\index(), ManagerHandler\index(), AdminHandler\index(), IndexHandler\index(), DBConnection\initDefaultDBConnection(), PKPCitationGridHandler\initialize(), ArticleNoteDAO\insertArticleNote(), ReviewFormDAO\insertReviewForm(), ReviewFormElementDAO\insertReviewFormElement(), ReviewFormResponseDAO\insertReviewFormResponse(), PKPPageRouter\isCacheable(), RuntimeEnvironment\isCompatible(), LanguageAction\isDownloadAvailable(), CaptchaManager\isEnabled(), PKPRequest\isPathInfoEnabled(), PKPRequest\isRestfulUrlsEnabled(), IssueFileManager\IssueFileManager(), FormValidatorReCaptcha\isValid(), JournalFileManager\JournalFileManager(), PluginRegistry\loadCategory(), Validation\login(), DBConnection\logQuery(), Mail\Mail(), Upgrade\migrateTimedViewsUsageStatistics(), NotificationMailingListForm\NotificationMailingListForm(), SectionEditorAction\notifyReviewer(), OAIConfig\OAIConfig(), XMLParser\parse(), UserXMLParser\parseData(), PKPMailTemplate\PKPMailTemplate(), ParaciteRawCitationNlm30CitationSchemaFilter\process(), PhpMyVisitesPlugin\register(), ArticleReportPlugin\register(), GoogleAnalyticsPlugin\register(), CoinsPlugin\register(), ReviewReportPlugin\register(), StopForumSpamPlugin\register(), PiwikPlugin\register(), AlmPlugin\register(), AcronPlugin\register(), PayPalPlugin\register(), LucenePlugin\register(), RegistrationHandler\registerUser(), ShibAuthPlugin\registerUserFromShib(), RegistrationForm\RegistrationForm(), SectionEditorAction\remindReviewer(), RoleDAO\roleExists(), PKPPageRouter\route(), SubscriptionAction\saveSubscriptionPolicies(), MailTemplate\send(), Mail\send(), SessionManager\SessionManager(), AccessKey\setAccessKeyId(), PKPAnnouncement\setAnnouncementId(), ReviewAssignment\setArticleId(), Author\setArticleId(), Note\setArticleId(), Article\setArticleId(), PKPAuthor\setAuthorId(), Captcha\setCaptchaId(), Comment\setCommentId(), ArticleComment\setCommentId(), SectionEditorAction\setDueDate(), FileCache\setEntireCache(), PKPFile\setFileId(), ArticleGalley\setGalleyId(), Group\setGroupId(), Issue\setIssueId(), Journal\setJournalId(), FileManager\setMode(), Note\setNote(), Note\setNoteId(), QueuedPayment\setQueuedPaymentId(), ReviewFormElement\setReviewFormElementId(), ReviewForm\setReviewFormId(), PKPReviewAssignment\setReviewId(), Section\setSectionId(), Subscription\setSubscriptionId(), SuppFile\setSuppFileId(), Thesis\setThesisId(), SubmissionFile\setType(), PKPAnnouncementType\setTypeId(), FunctionalMedraExportTest\setUp(), WebTestCase\setUp(), FunctionalDataciteExportTest\setUp(), PKPUser\setUserId(), PKPLoginHandler\signIn(), SMTPMailer\SMTPMailer(), SubscriptionAction\subscriptionPolicies(), AdminFunctionsHandler\systemInfo(), DOIExportPlugin\tarFiles(), TemplateManager\TemplateManager(), FunctionalOaiDcTest\testDOIAndURN(), WorldcatNlm30CitationSchemaFilterTest\testExecuteWithDoi(), FunctionalDoiExportTest\testExportAndRegisterObjectsViaCli(), SolrWebServiceTest\testGetArticleListXml(), ConfigTest\testGetVar(), ConfigTest\testGetVarFromOtherConfig(), OAIMetadataFormat_NLM\toXml(), PKPAnnouncementDAO\updateAnnouncement(), ArticleNoteDAO\updateArticleNote(), UserManagementForm\UserManagementForm(), PKPInstallHandler\validate(), FileWrapper\wrapper(), and XSLTransformer\XSLTransformer().

& Config::reloadData ( )

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 60 of file Config.inc.php.

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

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

Config::setConfigFileName (   $configFile)

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