From ee9c2053b5e1a0945fb04240be86ccc2e4bec36d Mon Sep 17 00:00:00 2001 From: Sam Minnee Date: Tue, 19 Oct 2010 03:44:24 +0000 Subject: [PATCH] MINOR Documentation for constants in Core.php (from r111052) git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@112890 467b73ca-7a2a-4603-9d3b-597d59a354a9 --- core/Core.php | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/core/Core.php b/core/Core.php index 00fc5c046..afc9c05b3 100755 --- a/core/Core.php +++ b/core/Core.php @@ -5,11 +5,28 @@ * It takes care of: * - Including _ss_environment.php * - Normalisation of $_SERVER values - * - Initialisation of TEMP_FOLDER, BASE_URL, BASE_PATH, and other SilverStripe defines + * - Initialisation of necessary constants (mostly paths) * - Checking of PHP memory limit * - Including all the files needed to get the manifest built * - Building and including the manifest * + * Initialized constants: + * - BASE_URL: Full URL to the webroot, e.g. "http://my-host.com/my-webroot" (no trailing slash). + * - BASE_PATH: Absolute path to the webroot, e.g. "/var/www/my-webroot" (no trailing slash). + * See Director::baseFolder(). Can be overwritten by Director::setBaseFolder(). + * - TEMP_FOLDER: Absolute path to temporary folder, used for manifest and template caches. Example: "/var/tmp" + * See getTempFolder(). No trailing slash. + * - MODULES_DIR: Not used at the moment + * - MODULES_PATH: Not used at the moment + * - THEMES_DIR: Path relative to webroot, e.g. "themes" + * - THEMES_PATH: Absolute filepath, e.g. "/var/www/my-webroot/themes" + * - CMS_DIR: Path relative to webroot, e.g. "cms" + * - CMS_PATH: Absolute filepath, e.g. "/var/www/my-webroot/cms" + * - SAPPHIRE_DIR: Path relative to webroot, e.g. "sapphire" + * - SAPPHIRE_PATH:Absolute filepath, e.g. "/var/www/my-webroot/sapphire" + * - THIRDPARTY_DIR: Path relative to webroot, e.g. "sapphire/thirdparty" + * - THIRDPARTY_PATH: Absolute filepath, e.g. "/var/www/my-webroot/sapphire/thirdparty" + * * @todo This file currently contains a lot of bits and pieces, and its various responsibilities should probably be * moved into different subsystems. * @todo A lot of this stuff is very order-independent; for example, the require_once calls have to happen after the defines.'