Static Public Member Functions | |
| static | getDefault ($key) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | getNotFound () |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | getOption ($key) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | initialize () |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | isDefaultSet ($key) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | isOptionSet ($key) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | setDefault ($key, $value) |
| Set the default value for an option. | |
| static | setOption ($key, $value) |
| INSERT BRIEF DESCRIPTION HERE. | |
Static Protected Member Functions | |
| static | addNotFound ($key) |
| INSERT BRIEF DESCRIPTION HERE. | |
A static class for storing all the defaults and options for use with a Shodor Web App (in lieu of storing them all in the global scope)
Defaults are (in most cases) what the server or framework specifies as the "normal" value of an option. Option values can be set to mask/override those defaults. If an option value is not found, the default value is returned. When a value is not found, the miss is logged in the notFound array for reporting.
Created: 11/27/07 -- jwsm@shodor.org
Definition at line 18 of file SConfig.php5.
| static SConfig::addNotFound | ( | $ | key | ) | [static, protected] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
| $key | [TYPE]: DESCRIPTION |
Definition at line 152 of file SConfig.php5.
Referenced by getDefault().
| static SConfig::getDefault | ( | $ | key | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
| $key | [TYPE]: DESCRIPTION |
Definition at line 74 of file SConfig.php5.
References addNotFound().
Referenced by SLdapAuthModule::__construct(), SDRServiceRequest::__construct(), SLdap::__construct(), SCacheManager::addToPageCache(), SCacheManager::checkPageCache(), SCacheManager::clearIncludeCache(), SCacheManager::clearPageCache(), DBI2::getDefaultOperator(), SCacheManager::getIncludeCacheCount(), SCacheManager::getIncludeCacheEntries(), getOption(), SCacheManager::getPageCacheCount(), SCacheManager::getPageCacheEntries(), TSD::init(), Snap2::init(), SDR::init(), SLayout2::layoutTopTags(), SLayout::layoutTopTags(), TSDLeaf::listAlignments(), TSDStandardCategory::listChildren(), TSDChapter::listChildren(), SnapResource::loadActiveVersion(), SCacheManager::loadIncludeCache(), Snap2::reinit(), PageRender2::renderPrint(), PageRender2::runTestSuite(), TSD::setPermission(), TSDBook::uploadCoverImage(), and PageRender2::useCachedVersion().
| static SConfig::getNotFound | ( | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
Definition at line 163 of file SConfig.php5.
| static SConfig::getOption | ( | $ | key | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
| $key | [TYPE]: DESCRIPTION |
Definition at line 120 of file SConfig.php5.
References getDefault().
Referenced by NavXMLModule::__construct(), DBI::__destruct(), STransNSDLSearchXML::addForwardBackButtons(), SAutoLoad::addModule(), SSucceedAuthModule::authenticate(), SSigmaxiAuthModule::authenticate(), SNcsiAuthModule::authenticate(), SGlobalAuthModule::authenticate(), SCserdAuthModule::authenticate(), SQL::doSQL(), SErrorManager::failsafe_show_errors(), SPath::getFullPath(), SPath::getRelPath(), SDRService::init(), CSERD::init(), SErrorManager::initialize(), TutorialsLayout::layoutStartBodyTags(), SLayout2::layoutStartBodyTags(), Petascale::layoutStartBodyTags(), MainLayout::layoutStartBodyTags(), CXXE::layoutStartBodyTags(), SnapVersion::lookup(), SErrorManager::php_error_handler(), TKSnapPreview::previewVersion(), SErrorManager::prm_printMessages(), DBI::query(), and PageRender2::renderPrint().
| static SConfig::initialize | ( | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
Definition at line 37 of file SConfig.php5.
| static SConfig::isDefaultSet | ( | $ | key | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
| $key | [TYPE]: DESCRIPTION |
Definition at line 90 of file SConfig.php5.
Referenced by isOptionSet().
| static SConfig::isOptionSet | ( | $ | key | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
| $key | [TYPE]: DESCRIPTION |
Definition at line 135 of file SConfig.php5.
References isDefaultSet().
| static SConfig::setDefault | ( | $ | key, | |
| $ | value | |||
| ) | [static] |
Set the default value for an option.
| $key | [string]: The name of the option | |
| $value | [mixed]: The value |
Definition at line 61 of file SConfig.php5.
Referenced by TKSnapPreview::previewVersion(), and TSD::setPermission().
| static SConfig::setOption | ( | $ | key, | |
| $ | value | |||
| ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
| $key | [TYPE]: DESCRIPTION | |
| $value | [TYPE]: DESCRIPTION |
Definition at line 107 of file SConfig.php5.
Referenced by SErrorManager::php_error_handler(), and PageRender2::rebaseCserdUrls().
1.5.6