DX Auth: Руководство пользователя. События

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

События, функции которые вызываются при определённых условиях. В данном случае срабатывание происходит, когда их вызывают определённые функции библиотеки DX Auth. Для обработки этих событий вам нужно открыть 'libraries/DX_Auth_Event.php' и разместить ваш код в нужных функциях - обработчиках событий.

В библиотеке DX Auth используются следующие обработчики событий

user_activated($user_id)

Если в конфигурационном файле DX_email_activation = TRUE, то событие вызывается сразу же после активации ключа полученного пользователем через e-mail.

Если в конфигурационном файле DX_email_activation = FALSE, то событие вызывается сразу же после удачной регистрации пользователя.

$user_id - id пользователя который был активирован.

По умолчанию, при обработке этого события создаётся профиль пользователя. Если он вам не нужен, то просто удалите код создания профиля в функции обработчике события.

user_logged_in($user_id)

Событие вызывается после входа пользователя.

$user_id - id вошедшего пользователя.

user_logging_out($user_id)

Событие вызывается после выхода пользователя.

$user_id - id вышедшего пользователя.

user_changed_password($user_id, $new_password)

Событие вызывается после смены пользователем пароля.

$user_id - id пользователя сменившего пароль, $new_password - новый пароль пользователя.

user_canceling_account($user_id)

Событие вызывается после удаления учётной записи пользователя.

$user_id - id пользователя удалившего свою учётную запись.

По умолчанию, при обработке этого события удаляется профиль пользователя. Если вы не используете профили пользователей, вы можете удалить код удаления профиля пользователя из функции обработчика событий.

checked_uri_permissions($user_id, ∓$allowed)

Событие вызывается после проверки разрешений функцией check_uri_permissions() в DX Auth.

$user_id - id пользователя роли которого проверяются.

$allowed - результат проверки разрешений. Значение можно изменить, так как оно передаётся ссылкой.

got_permission_value($user_id, $key)

Событие вызывается когда происходит вызов функции get_permission_value() в DX Auth.

got_permissions_value($user_id, $key)

Событие вызывается когда происходит вызов функции get_permissions_value() в DX Auth.

sending_account_email($data, &$content)

Событие вызывается перед тем, как DX Auth отошлёт e-mail с данными учётной записи.

$data - массив содержащий записи: username, password, email, last_ip.

$content - содержимое e-mail'а, передаётся по ссылке.

По умолчанию, функция содержит код демонстрирующий как можно изменять содержимое e-mail. Вы можете его изменить в соответствии со своими потребностями.

sending_activation_email($data, &$content)

Событие вызывается перед тем, как DX Auth отошлёт e-mail с данными для активации учётной записи.

$data - массив содержащий записи: username, password, email, last_ip, activation_key, activate_url.

$content - содержимое e-mail, передаётся по ссылке.

sending_forgot_password_email($data, &$content)

Событие вызывается перед тем, как DX Auth отошлёт e-mail с данными для восстановления забытого пароля.

$data - массив содержащий password, key и reset_password_url.

$content - содержимое e-mail, передаётся по ссылке.

Заметки разработчика

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