From 9bf807b2b674e74a8a0dc06d13a82f649f5f67cf Mon Sep 17 00:00:00 2001 From: john Date: Sat, 17 Feb 2007 18:38:36 +0000 Subject: [PATCH] Proofing the comments in core.php. Fixing spelling errors and trying to reword sections. git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@4532 3807eeeb-6ff5-0310-8944-8be069107fe0 --- app/config/core.php | 135 ++++++++++++++++++++++++-------------------- 1 file changed, 74 insertions(+), 61 deletions(-) diff --git a/app/config/core.php b/app/config/core.php index 2cc8b3fd5..5968e9473 100644 --- a/app/config/core.php +++ b/app/config/core.php @@ -27,115 +27,128 @@ * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ /** - * If you do not have mod rewrite on your system - * or if you prefer to use CakePHP pretty urls. - * uncomment the line below. - * Note: If you do have mod rewrite but prefer the - * CakePHP pretty urls, you also have to remove the - * .htaccess files - * release/.htaccess - * release/app/.htaccess - * release/app/webroot/.htaccess + * To configure CakePHP *not* to use mod_rewrite and to + * use CakePHP pretty URLs, remove these .htaccess + * files: + * + * /.htaccess + * /app/.htaccess + * /app/webroot/.htaccess + * + * And uncomment the define below: */ + // define ('BASE_URL', env('SCRIPT_NAME')); + /** - * Set debug level here: - * - 0: production - * - 1: development - * - 2: full debug with sql - * - 3: full debug with sql and dump of the current object - * - * In production, the "flash messages" redirect after a time interval. - * With the other debug levels you get to click the "flash message" to continue. + * CakePHP Debug Level: + * + * Production Mode: + * 0: No error messages, errors, or warnings shown. Flash messages redirect. + * + * Development Mode: + * 1: Errors and warnings shown, model caches refreshed, flash messages halted. + * 2: As in 1, but also with full debug messages and SQL output. + * 3: As in 2, but also with full controller dump. * + * In production mode, flash messages redirect after a time interval. + * In development mode, you need to click the flash message to continue. */ define('DEBUG', 2); /** - * Turn of caching checking wide. - * You must still use the controller var cacheAction inside you controller class. - * You can either set it controller wide, or in each controller method. - * use var $cacheAction = true; or in the controller method $this->cacheAction = true; + * Turn off or enable cache checking application-wide. + * + * If set to true, you must still use the controller var $cacheAction inside + * your controllers to define caching settings. You can either set it + * controller-wide by setting var $cacheAction = true, or in each action + * using $this->cacheAction = true. */ define('CACHE_CHECK', false); /** - * Error constant. Used for differentiating error logging and debugging. - * Currently PHP supports LOG_DEBUG + * Defines the default error type when using the log() function. Used for + * differentiating error logging and debugging. Currently PHP supports LOG_DEBUG. */ define('LOG_ERROR', 2); /** - * CakePHP includes 3 types of session saves - * database or file. Set this to your preferred method. - * If you want to use your own save handler place it in - * app/config/name.php DO NOT USE file or database as the name. - * and use just the name portion below. - * - * Setting this to cake will save files to /cakedistro/tmp directory - * Setting it to php will use the php default save path - * Setting it to database will use the database + * The preferred session handling method. Valid values: + * + * 'php' Uses settings defined in your php.ini. + * 'cake' Saves session files in CakePHP's /tmp directory. + * 'database' Uses CakePHP's database sessions. + * + * To define a custom session handler, save it at /app/config/.php. + * Set the value of CAKE_SESSION_SAVE to to utilize it in CakePHP. + * + * To use database sessions, execute the SQL file found at /app/config/sql/sessions.sql. * */ define('CAKE_SESSION_SAVE', 'php'); /** - * If using you own table name for storing sessions - * set the table name here. - * DO NOT INCLUDE PREFIX IF YOU HAVE SET ONE IN database.php - * + * The name of the table used to store CakePHP database sessions. + * + * CAKE_SESSION_SAVE must be set to 'database' in order to utilize this constant. + * + * The table name set here should *not* include any table prefix defined elsewhere. */ define('CAKE_SESSION_TABLE', 'cake_sessions'); /** - * Set a random string of used in session. - * + * A random string used in session management. */ define('CAKE_SESSION_STRING', 'DYhG93b0qyJfIxfs2guVoUubWwvniR2G0FgaC9mi'); /** - * Set the name of session cookie - * + * The name of CakePHP's session cookie. */ define('CAKE_SESSION_COOKIE', 'CAKEPHP'); /** - * Set level of Cake security. - * + * The level of CakePHP session security. The session timeout time defined + * in CAKE_SESSION_TIMEOUT is multiplied according to the settings here. + * Valid values: + * + * 'high' Session timeout in CAKE_SESSION_TIMEOUT x 10 + * 'medium' Session timeout in CAKE_SESSION_TIMEOUT x 100 + * 'low' Session timeout in CAKE_SESSION_TIMEOUT x 300 + * + * CakePHP session IDs are also regenerated between requests if + * CAKE_SECURITY is set to 'high'. */ define('CAKE_SECURITY', 'high'); /** - * Set Cake Session time out. - * If CAKE_SECURITY define is set - * high: multiplied by 10 - * medium: is multiplied by 100 - * low is: multiplied by 300 - * - * Number below is seconds. + * Session time out time (in seconds). + * Actual value depends on CAKE_SECURITY setting. */ define('CAKE_SESSION_TIMEOUT', '120'); /** - * Uncomment the define below to use cake built in admin routes. - * You can set this value to anything you want. - * All methods related to the admin route should be prefixed with the - * name you set CAKE_ADMIN to. - * For example: admin_index, admin_edit + * Uncomment the define below to use CakePHP admin routes. + * + * The value of the define determines the name of the route + * and its associated controller actions: + * + * 'admin' -> admin_index() and /admin/controller/index + * 'superuser' -> superuser_index() and /superuser/controller/index */ // define('CAKE_ADMIN', 'admin'); /** - * The define below is used to turn cake built webservices - * on or off. Default setting is off. + * Enable or disable CakePHP webservices routing. Set to 'off' or 'on'. */ define('WEBSERVICES', 'off'); /** - * Compress output CSS (removing comments, whitespace, repeating tags etc.) - * This requires a/var/cache directory to be writable by the web server (caching). + * Compress CSS output by removing comments, whitespace, repeating tags, etc. + * This requires a/var/cache directory to be writable by the web server for caching. + * * To use, prefix the CSS link URL with '/ccss/' instead of '/css/' or use Controller::cssTag(). */ define('COMPRESS_CSS', false); /** - * If set to false, session would not automatically be started. + * If set to false, sessions are not automatically started. */ define('AUTO_SESSION', true); /** - * Set the max size of file to use md5() . + * The max size of file allowed for MD5 hashes (in bytes). */ define('MAX_MD5SIZE', (5 * 1024) * 1024); /** - * To use Access Control Lists with Cake... + * The classname, filename, (and database) used in CakePHP's + * access control lists. */ define('ACL_CLASSNAME', 'DB_ACL'); define('ACL_FILENAME', 'dbacl' . DS . 'db_acl');