The Site Configuration File

The following is an explanation of the config file variables. Also explain how people should set up the config file for their particular server.

$config = new Config();

Page / Paging Variables

Typical values shown …

$config->page['referer']; // set automatically
$config->page['current']; // set automatically
$config->page['items'] = 20;

Database Connection Variables

These are the database details. Typical values shown …

$config->db['host'] = 'localhost';
$config->db['name'] = 'databasenamehere';
$config->db['user'] = 'yourusername';
$config->db['pass'] = 'yourpassword';

Application Variables

These are the application variables. Typical values shown (the telephotos website used as an example in this case) …

$this->app['location'] = "http://telephotos.co.uk";
$this->app['title'] = "Telephotos";
$this->app['author'] = "David George Hamilton";
$this->app['company'] = "Something Easy To Remember Ltd";
$this->app['default_lang'] = "English";
$this->app['mod_rewrite'] = true;
$this->app['unicode'] = true;
$this->app['cookiename'] = "telephotos";
$this->app['extension'] = "html";

Mail Settings

These variables define whether mail is setup on the server and the email address from which notices are sent. Typical values shown (the telephotos website used as an example in this case) …

$this->mail['name'] = "Telephotos";
$this->mail['address'] = "no-reply@telephotos.co.uk";
$this->mail['enabled'] = false;

Project File Location Variables

These variables are used for settings the location of your project files.

$this->classes['path'] = "_classes";
$this->classes['domain'] = $this->classes['path'] . "/_domain";
$this->classes['inf'] = $this->classes['path'] . "/_inf";
$this->classes['app'] = $this->classes['path'] . "/_app";
$this->classes['ui'] = $this->classes['path'] . "/_ui/_" . strtolower($this->app['client']);

Orqi Location Variables

These variables are used for setting the location of the Orqi files.

$this->orqi['path'] = "_orqi";
$this->orqi['domain'] = $this->orqi['path'] . "/_domain";
$this->orqi['app'] = $this->orqi['path'] . "/_app";
$this->orqi['inf'] = $this->orqi['path'] . "/_inf";
$this->orqi['ui'] = $this->orqi['path'] . "/_ui/_" . strtolower($this->app['client']);

Resource Variables

These variables are used for settings the location of front end stuff like images, css and javascript. The first two in the list ‘url’ and ‘path’ are for uploads. ‘path’ is the physical location in the directory structure on the server and ‘url’ is the address you then type into the browser to reach the uploaded file. Typical values shown (the telephotos website used as an example in this case) …

$this->resource['path'] = '/home/htdocs/telephotos.co.uk';
$this->resource['url'] = $this->app['location'];
$this->resource['img'] = $this->app['location'] . '/_img/_' . strtolower($this->app['client']);
$this->resource['css'] = $this->app['location'] . '/_css/_' . strtolower($this->app['client']);

Tags: config, config file