Changeset 27 for trunk/docs

Timestamp:

Dec 4, 2005 3:18:03 AM (18 years ago)

Author:

scdev

Message:

 

File:

• trunk/docs/example_config.inc.php (modified) (6 diffs)

trunk/docs/example_config.inc.php

@@ -1 +1 @@
 <?php
 /**
- * _config.inc.php lives in the document root of your site/application. It is the beginning of everything.
+ * _config.inc.php lives in the document root of the site/application. It is the beginning of everything.
  *
  * Code by Strangecode :: www.strangecode.com :: This document contains copyrighted information.
  * @author  Quinn Comendant <quinn@strangecode.com>
- * @version 1.0
- * @since   2005-08-30
+ * @version 1.2
+ * @since   03 Dec 2005 19:09:32
  */
 
-// __FILE__ must be an absolute directory path, starting with / on unix and X: on windows.
-if (!preg_match('!^/|^[A-Z]:!', __FILE__)) {
+// The constant __FILE__ must be an absolute directory path, starting with / on unix or C: on windows.
+// To work around a PHP bug always include this config file with: require_once dirname(__FILE__) . '/_config.inc.php';
+if (!preg_match('!^(/|[A-Z]:)!', __FILE__)) {
     trigger_error('_config.inc.php include must be specified with an absolute file path (eg: "require_once dirname(__FILE__) . \'/_config.inc.php\';"', E_USER_ERROR);
 }
 
+// First things first. Define the globally used directory paths.
+// The parent directory of all application DocRoots.
 define('COMMON_BASE', realpath(dirname(__FILE__) . '/../'));
-define('CODE_BASE', COMMON_BASE . '/codebase');
+
+// The DocRoot for this application. SITE_BASE is ifferent from $_SERVER['DOCUMENT_ROOT'] because the 
+// latter does not change when using the apache Alias directive or URL Rewriting to define a site.
 define('SITE_BASE', dirname(__FILE__));
 
-// Set include path.
+// Set include path for all tempates.
 ini_set('include_path', get_include_path()
     . PATH_SEPARATOR . COMMON_BASE
@@ -25 +30 @@
 
 // Include core libraries.
-require_once 'codebase/lib/App.inc.php';
 require_once 'codebase/lib/Utilities.inc.php';
 require_once 'codebase/lib/Auth_SQL.inc.php';
+require_once 'codebase/lib/App.inc.php';
 
+// Primary application class.
 $app =& App::getInstance('admin');
-
 $app->setParam(array(
     'site_name' => 'WWW Admin',
@@ -42 +47 @@
 
     'enable_session' => true,
-    'enable_db_session_handler' => true,
+    'enable_db_session_handler' => false,
     'session_use_cookies' => true,
 
@@ -49 +54 @@
     'db_debug' => true,
     'db_die_on_failure' => true,
+    'db_create_tables' => true, /// Disable after site launch.
 
     'display_errors' => true,
@@ -61 +67 @@
     'log_to_sms_address' => 'sms@example.com',
 ));
-
+// DB credentials for command line scripts stored in a file with read rights
+// given only to the user who will be executing the scripts: -rw-------
+// This file includes App:: method calls so must be included after App.
 require_once 'global/db_auth.inc.php';
 
+// Most configuration parameters must be set before starting the App.
 $app->start();
 
-
+// User authentication.
 $auth = new Auth_SQL('admin');
 $auth->setParam(array(
@@ -74 +83 @@
 ));
 
-// Setup CSS files to include. These will always be available.
+// Set CSS files.
 require_once 'codebase/lib/CSS.inc.php';
 $css = new CSS();
 $css->setParam(array('cache_css' => true));
-$css->setFile(CODE_BASE . '/css/depreciated.inc.css');
-$css->setFile(CODE_BASE . '/css/codebase.inc.css');
-$css->setFile(CODE_BASE . '/css/utilities.inc.css');
-$css->setFile(CODE_BASE . '/css/admin.inc.css');
+$css->setFile('codebase/css/codebase.inc.css');
+$css->setFile('codebase/css/utilities.inc.css');
+$css->setFile('codebase/css/admin.inc.css');
 
+// Nav class for titles, breadcrumbs, and page features.
 require_once 'codebase/lib/Nav.inc.php';
 $nav = new Nav();