воскресенье, 12 декабря 2010 г.

DX Auth: Руководство пользователя. Конфигурация

Пятая часть перевода документации библиотеки авторизации DX Auth для фреймворка CodeIgniter.

Это файл конфигурации библиотеки DX Auth. Все параметры прокомментированы в коде.


/* 
| ------------------------------------------------------------------- 
| Конфигурация DX Auth
| ------------------------------------------------------------------- 
*/  
 
/* 
|-------------------------------------------------------------------------- 
| Настройки веб-сайта
|-------------------------------------------------------------------------- 
| 
| Эти данные используются в e-mail сообщениях отправляемых библиотекой DX Auth.
| 
*/  
 
$config['DX_website_name'] = 'Название вашего сайта';  
$config['DX_webmaster_email'] = 'webmaster@yourhost.com';  
 
/* 
|-------------------------------------------------------------------------- 
| Таблица базы данных 
|-------------------------------------------------------------------------- 
| 
| Указываем таблицы с которыми работает библиотека DX Auth
| 
| 'DX_table_prefix' позволяет указать префикс для таблиц библиотеки DX Auth.  
| 
| Например указываем префикс 'DX_' в 'DX_table_prefix' и параметр 'users' в  'DX_users_table', 
| библиотека DX Auth будет использовать таблицу 'DX_users' как таблицу пользователей. 
| 
*/  
 
$config['DX_table_prefix'] = '';  
$config['DX_users_table'] = 'users';  
$config['DX_user_profile_table'] = 'user_profile';  
$config['DX_user_temp_table'] = 'user_temp';  
$config['DX_user_autologin'] = 'user_autologin';  
$config['DX_roles_table'] = 'roles';  
$config['DX_permissions_table'] = 'permissions';  
$config['DX_login_attempts_table'] = 'login_attempts';  
 
/* 
|-------------------------------------------------------------------------- 
| Salt  пароля
|-------------------------------------------------------------------------- 
| 
| Вы можете добавить salt к  хэшам паролей.  
| Например, вы можете взять salt здесь: https://www.grc.com/passwords.htm 
| 
| Примечание:  
|  
| Помните, если вы измените значение salt после того как пользователь зарегистрировался,
| этот пользователь уже не сможет войти никогда.
| 
*/  
 
$config['DX_salt'] = '';  
 
/* 
|-------------------------------------------------------------------------- 
| Параметры связанные с регистрацией  
|-------------------------------------------------------------------------- 
| 
| 'DX_email_activation' = Активация учётной записи через e-mail. 
| 'DX_email_activation_expire' = Время через которое не активированные учётные записи
| будут удалены из базы. По умолчанию, 48 часов (60*60*24*2). 
| 'DX_email_account_details' =  Выслать пользователю информацию о его учётной записи,
| после регистрации. Работает только если 'DX_email_activation' = FALSE. 
| 
*/  
   
$config['DX_email_activation'] = TRUE;   
$config['DX_email_activation_expire'] = 60*60*24*2;   
$config['DX_email_account_details'] = TRUE;   
 
/* 
|-------------------------------------------------------------------------- 
| Праматеры входа
|-------------------------------------------------------------------------- 
| 
| 'DX_login_using_username' = TRUE, если пользователь может использовать имя для входа. 
| 'DX_login_using_email' = TRUE, ели пользователь может использовать e-mail для входа. 
| 
| Вы должны установить хотя бы один из вышеуказанных параметров в TRUE.  
| 
| 'DX_login_record_ip' = TRUE, если IP адрес пользователя должен сохранятся в базе данных при входе. 
| 'DX_login_record_time' = TRUE, если время входа должно сохранятся в базе данных при входе.
| 
*/  
 
$config['DX_login_using_username'] = TRUE;  
$config['DX_login_using_email'] = TRUE;  
$config['DX_login_record_ip'] = TRUE;  
$config['DX_login_record_time'] = TRUE;  
 
/* 
|-------------------------------------------------------------------------- 
| Параметры автовхода
|-------------------------------------------------------------------------- 
| 
| 'DX_autologin_cookie_name' = Устанавливает имя cookie автовхода. 
| 'DX_autologin_cookie_life' = Устанавливает время жизни cookie автовхода. По умолчанию 2 месяца (60*60*24*31*2). 
| 
*/  
 
$config['DX_autologin_cookie_name'] = 'autologin';  
$config['DX_autologin_cookie_life'] = 60*60*24*31*2;  
 
/* 
|-------------------------------------------------------------------------- 
| Попытки входа 
|-------------------------------------------------------------------------- 
| 
| 'DX_count_login_attempts' = TRUE, если DX Auth должна считать количество неудавшихся попыток входа. 
| 'DX_max_login_attempts' =  Указывает максимальное количество попыток, до того как функция is_login_attempt_exceeded() вернёт значение TRUE. 
| 
*/  
 
$config['DX_count_login_attempts'] = TRUE;  
$config['DX_max_login_attempts'] = 1;   
 
/* 
|-------------------------------------------------------------------------- 
| Параметры восстановления забытого пароля 
|-------------------------------------------------------------------------- 
| 
| 'DX_forgot_password_expire' = Время, через которое ключ сброса пароля перестанет быть валидным. По умолчанию 15 минут (900 секунд). 
| 
*/  
 
$config['DX_forgot_password_expire'] = 900;  
 
/* 
|-------------------------------------------------------------------------- 
| Captcha 
|-------------------------------------------------------------------------- 
| 
| Здесь вы можете выставить параметры catpcha создаваемой библиотекой DX Auth. 
| 'DX_captcha_directory' = Имя каталога в котором будет создана catpcha.  
| 'DX_captcha_fonts_path' = Имя каталога шрифтов которые будут использоваться при создании captcha. 
| 'DX_captcha_font_size' = Размер шрифта которым будет написан текст captcha. Если значение не указать будет выбираться случайный размер. 
| 'DX_captcha_grid' = Показывать сетку в созданной captcha. 
| 'DX_captcha_expire' = Время пока captcha остаётся валидной, по умолчанию 3 минуты (180 секунд). 
| 'DX_captcha_expire' = Определяет чувствительна captcha к регистру или нет. 
| 
*/  
 
$config['DX_captcha_directory'] = 'captcha';  
$config['DX_captcha_fonts_path'] = $config['DX_captcha_path'].'fonts';   
$config['DX_captcha_width'] = 320;  
$config['DX_captcha_height'] = 95;  
$config['DX_captcha_font_size'] = '';   
$config['DX_captcha_grid'] = TRUE;  
$config['DX_captcha_expire'] = 180;   
$config['DX_captcha_case_sensitive'] = TRUE;   
 
/* 
|-------------------------------------------------------------------------- 
| reCAPTCHA 
|-------------------------------------------------------------------------- 
| 
| Если вы планирует использовать функции reCAPTCHA, вы должны указать ключи reCAPTCHA
| Вы можете получить ключи после регистрации на http://recaptcha.net 
| 
*/  
 
$config['DX_recaptcha_public_key'] = '';   
$config['DX_recaptcha_private_key'] = '';  
 
 
/* 
|-------------------------------------------------------------------------- 
| URI 
|-------------------------------------------------------------------------- 
| 
| Определяем URI которые будут использоваться в библиотеки DX Auth для перенаправления. 
| 'DX_deny_uri' = Доступ к URI запрещён. 
| 'DX_login_uri' = URI входа. 
| 'DX_activate_uri' = URI активации пользователя. 
| 'DX_reset_password_uri' = URI сброса пароля пользователя. 
| 
| Эти значения доступный из библиотеки DX Auth через переменный с именем параметра без 'DX_'. 
| Например, вы можете получить значение 'DX_deny_uri' в контроллере через  $this->dx_auth->deny_uri. 
| 
*/  
 
$config['DX_deny_uri'] = '/auth/deny/';  
$config['DX_login_uri'] = '/auth/login/';  
$config['DX_banned_uri'] = '/auth/banned/';  
$config['DX_activate_uri'] = '/auth/activate/';  
$config['DX_reset_password_uri'] = '/auth/reset_password/';  
 
 
/* 
|-------------------------------------------------------------------------- 
| Параметры хэлпера
|-------------------------------------------------------------------------- 
| 
|  Параметры указанные ниже, фактически не используются в библиотеке.  
|  Они могут вам облегчить написание контроллера. 
|  Если они вам не нужны, вы можете их удалить. 
|  
| Эти значения доступный из библиотеки DX Auth через переменный с именем параметра без 'DX_'. 
| Например, вы можете получить значение 'DX_register_uri' в контроллере через  $this->dx_auth->register_uri. 
| 
*/  
 
// Регистрация  
$config['DX_allow_registration'] = TRUE;   
$config['DX_captcha_registration'] = TRUE;  
 
// Вход
$config['DX_captcha_login'] = FALSE;  
 
// URI 
$config['DX_logout_uri'] = '/auth/logout/';  
$config['DX_register_uri'] = '/auth/register/';  
$config['DX_forgot_password_uri'] = '/auth/forgot_password/';  
$config['DX_change_password_uri'] = '/auth/change_password/';  
$config['DX_cancel_account_uri'] = '/auth/cancel_account/';  
 
// Отображения форм
$config['DX_login_view'] = 'auth/login_form';  
$config['DX_register_view'] = 'auth/register_form';  
$config['DX_forgot_password_view'] = 'auth/forgot_password_form';  
$config['DX_change_password_view'] = 'auth/change_password_form';  
$config['DX_cancel_account_view'] = 'auth/cancel_account_form';  
 
// Отображения страниц
$config['DX_deny_view'] = 'auth/general_message';  
$config['DX_banned_view'] = 'auth/general_message';  
$config['DX_logged_in_view'] = 'auth/general_message';  
$config['DX_logout_view'] = 'auth/general_message';  
 
$config['DX_register_success_view'] = 'auth/general_message';  
$config['DX_activate_success_view'] = 'auth/general_message';  
$config['DX_forgot_password_success_view'] = 'auth/general_message';  
$config['DX_reset_password_success_view'] = 'auth/general_message';  
$config['DX_change_password_success_view'] = 'auth/general_message';  
 
$config['DX_register_disabled_view'] = 'auth/general_message';  
$config['DX_activate_failed_view'] = 'auth/general_message';  
$config['DX_reset_password_failed_view'] = 'auth/general_message';   

Похожие по тематике посты:

Комментариев нет: