CL Auth BETA v0.2.5

Newest Release: 17/08/2008

« Hide Menu

CL Auth Config

This is an overview of the CL Auth config file.

<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');

/*
| CONFIGURATION ARRAY FOR CL AUTH
|
| @subpackage  Config
| @category    CL Auth Configuration
| @author      Jason Ashdown aka Flash
| @copyright   Copyright (c) 2008
| @version     v0.2 [BETA]
*/

/*
=====================
 MAIN CONFIGURATION
=====================
*/

// Enable/Disable (WARNING! Disabling may break your pages)
$config['CL_Auth'] = TRUE;

// Site Details
$config['CL_website_name'] = 'Manga Masters';
$config['CL_webmaster_email'] = 'webmaster@mangamasters.com';

$config['CL_cookie_life'] = 60*60*24*31*2; // Default 2 months

// Session Class
$config['track_activity'] = FALSE;
$config['regen'] = TRUE;

// Database
$config['CL_table_prefix'] = 'cl_';

$config['CL_users_table'] = 'users';
$config['CL_user_profile_table'] = 'user_profile';
$config['CL_user_temp_table'] = 'user_temp';
$config['CL_groups_table'] = 'groups';
$config['CL_group_to_uri_table'] = 'group_uri';

// URI Locations
$config['CL_banned_uri'] = '/auth/banned';
$config['CL_deny_uri'] = '/auth/deny';
$config['CL_login_uri'] = '/auth/login';
$config['CL_logout_uri'] = '/auth/logout';
$config['CL_register_uri'] = '/auth/register';
$config['CL_activate_uri'] = '/auth/activate';
$config['CL_forgotten_uri'] = '/auth/forgotten';
$config['CL_reset_uri'] = '/auth/reset';
$config['CL_changepass_uri'] = '/auth/changepassword';

// Registration
$config['CL_allow_registration'] = TRUE;
$config['CL_email_verification'] = FALSE;
$config['CL_temp_expire'] = 60*60*24*2; // Default 48 Hours

$config['CL_username_min'] = 3; // Default 3
$config['CL_username_max'] = 20; // Default 20
$config['CL_password_min'] = 6; // Default 6
$config['CL_password_max'] = 25; // Default 25

$config['CL_forgotten_expire'] = 900; // Default 15mins

// CAPTCHA
$config['CL_captcha_path'] = './captcha/'; // Absolute path to directory
$config['CL_captcha_fonts_path'] = $config['CL_captcha_path'].'fonts'; // Usually located in the same folder as captcha

$config['CL_captcha_registration'] = TRUE;
$config['CL_captcha_login'] = TRUE;
$config['CL_captcha_login_attempts'] = 3;

$config['CL_captcha_expire'] = 180; // Default 3mins

// Email
$config['CL_support_email'] = 'webmaster@mangamasters.com';
$config['CL_account_subject'] = $config['CL_website_name'].' account details';
$config['CL_activate_subject'] = $config['CL_website_name'].' activation';

$config['CL_activate_email'] = 'auth/email/activate';
$config['CL_account_email'] = 'auth/email/account';
$config['CL_forgotten_email'] = 'auth/email/forgotten';

// Pages
$config['CL_deny_page'] = 'auth/deny';
$config['CL_banned_page'] = 'auth/banned';
$config['CL_login_page'] = 'auth/login_form';
$config['CL_logged_in_page'] = 'auth/logged_in';
$config['CL_logout_page'] = 'auth/logged_out';
$config['CL_register_page'] = 'auth/register_form';
$config['CL_register_success'] = 'auth/register_success';
$config['CL_activate_success'] = 'auth/activate_success';
$config['CL_activate_failed'] = 'auth/activate_failed';
$config['CL_forgotten_page'] = 'auth/forgotten_form';
$config['CL_forgotten_success'] = 'auth/forgotten_success';
$config['CL_reset_page'] = 'auth/reset_form';
$config['CL_reset_success'] = 'auth/reset_success';

?>

A break down of each section in more detail.

Enable/Disable CL Auth

CL Auth hasn't been designed to function while disabled. Disabling will cause inpredicted behaviour.

# Enable/Disable (WARNING! Disabling may break your pages)
$config['CL_Auth'] = TRUE;

Session Class

With CL Auth you can now track a users activity when you enable track_activity. This logs the users total time spent on the website and the last_page the user visited. By default this is set to FALSE.

The users total time is saved in the users table as active_time in seconds.

Regen will generate a new cookie id everytime the userdata is updated in the Session class. It is recommended you have this setting set to TRUE for increased security, but if you are experience problems with losing your sessions, set it to FALSE.

// Session Class
$config['track_activity'] = FALSE;
$config['regen'] = TRUE;

Database Tables

These tables are referenced through out the models with these config values. If you ever rename your tables, change these.

// Database
$config['CL_table_prefix'] = 'cl_';

$config['CL_users_table'] = 'users';
$config['CL_user_profile_table'] = 'user_profile';
$config['CL_user_temp_table'] = 'user_temp';
$config['CL_groups_table'] = 'groups';
$config['CL_group_to_uri_table'] = 'group_uri';

URI Locations

CL Auth is dependant on knowing where your auth functions exist. So if you use anything other than the default setup, change these.

// URI Locations
$config['CL_banned_uri'] = '/auth/banned';
$config['CL_deny_uri'] = '/auth/deny';
$config['CL_login_uri'] = '/auth/login';
$config['CL_logout_uri'] = '/auth/logout';
$config['CL_register_uri'] = '/auth/register';
$config['CL_activate_uri'] = '/auth/activate';
$config['CL_forgotten_uri'] = '/auth/forgotten';
$config['CL_reset_uri'] = '/auth/reset';
$config['CL_changepass_uri'] = '/auth/changepassword';

Views

# Pages
$config['CL_deny_page'] = 'auth/deny';
$config['CL_banned_page'] = 'auth/banned';
$config['CL_login_page'] = 'auth/login_form';
$config['CL_logged_in_page'] = 'auth/logged_in';
$config['CL_logout_page'] = 'auth/logged_out';
$config['CL_register_page'] = 'auth/register_form';
$config['CL_register_success'] = 'auth/register_success';
$config['CL_activate_success'] = 'auth/activate_success';
$config['CL_activate_failed'] = 'auth/activate_failed';
$config['CL_forgotten_page'] = 'auth/forgotten_form';
$config['CL_forgotten_success'] = 'auth/forgotten_success';
$config['CL_reset_page'] = 'auth/reset_form';
$config['CL_reset_success'] = 'auth/reset_success';