source: trunk/docs/example_config.inc.php @ 252

<?php
/**
 * _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.2
 * @since   03 Dec 2005 19:09:32
 */

// 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__) . '/../'));

// 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 for all tempates.
ini_set('include_path', join(PATH_SEPARATOR, array(
    COMMON_BASE,
    SITE_BASE . '/_templates',
    get_include_path(),
)));

// Include core libraries.
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('example.org');
$app->setParam(array(
    'site_name' => 'My example site',
    'site_email' => 'hello@example.com',
    'redirect_home_url' => '/',

    'date_format' => 'd M Y',
    'sql_date_format' => '%e %b %Y',
    'sql_time_format' => '%k:%i',
    'character_set' => 'utf-8',

    'enable_session' => false,
    'enable_db_session_handler' => false,
    'session_use_cookies' => true,

    'enable_db' => false,
    'db_always_debug' => false,
    'db_debug' => true,
    'db_die_on_failure' => true,
    'db_create_tables' => true, /// Disable after site launch.

    'display_errors' => true,

    'log_directory' => COMMON_BASE . '/log',
    'log_filename' => 'site.log',
    'log_file_priority' => LOG_DEBUG,
    'log_email_priority' => false,
    'log_sms_priority' => false,
    'log_screen_priority' => false,
    'log_to_email_address' => 'log@example.com',
    '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';

// Start application-based functionality: database, session, environment, ini setup, etc.
// Most configuration parameters must be set before starting the App.
$app->start();

// Global DB object. Automatically preconfigured by $app->start().
$db =& DB::getInstance();

// User authentication.
$auth = new Auth_SQL('user');
$auth->setParam(array(
    'db_table'          => 'user_tbl',
    'db_primary_key'    => 'user_id',
    'login_url'         => '/login.php'
));

// Set CSS files.
require_once 'codebase/lib/CSS.inc.php';
$css = new CSS();
$css->setParam(array('cache_css' => true));
$css->setFile('codebase/css/codebase.inc.css');
$css->setFile('codebase/css/utilities.inc.css');
$css->setFile('html/css/screen.inc.css');

// Global navigation elements object.
require_once 'codebase/lib/Navigation.inc.php';
$nav = new Navigation(array(
    'path_delimiter' => ' / ',
    'last_crumb_format' => '<b>%s</b>',
));

?>