AuthForm
Описание и параметры
CMain::AuthForm( mixed mess, bool show_prolog = true, bool show_epilog = true, string not_show_links = "N", bool do_die = true )
Метод подключает ряд компонентов в зависимости от параметров пришедших на страницу:
Параметр | Значение | Название компонента |
---|---|---|
forgot_password | yes | Форма отправки контрольного слова для смены пароля (system.auth.forgotpasswd) |
change_password | yes | (Форма смены забытого пароля (system.auth.changepasswd) |
register | yes | Форма регистрации (system.auth.registration) |
authorize_registration | yes | Форма авторизации (system.auth.authorize) |
Если не указан ни один из параметров, то по умолчанию метод подключит компонент "Форма авторизации".
Примечание. После вывода соответствующего компонента метод завершает выполнение страницы.
Нестатический метод.
Параметры
Параметр | Описание | С версии |
---|---|---|
mess | Строка - сообщение об ошибке или массив вида Array("MESSAGE" => сообщение, "TYPE" => "ERROR"|"OK") (обрабатывается функцией ShowMessage) | |
show_prolog | Если значение "true" - то будет выведен пролог (верх) сайта, "false" - пролог выводиться не будет. | 3.3.4 |
show_epilog | Если значение "true" - то будет выведен эпилог (низ) сайта, "false" - эпилог выводиться не будет. | 3.3.4 |
not_show_links | Данный параметр передается в компонент "Форма авторизации" (main/auth/authorize.php). Если значение "Y" - то ссылки ведущие на регистрацию и форму запроса и смены забытого пароля выводиться не будут, если "N" - ссылки выводиться будут (значение по умолчанию). | 3.3.4 |
do_die | Если значение "true" - то страница будет завершена после вывода формы и (опционально) эпилога, "false" - страница прерываться не будет. | 8.0.5 |
Смотрите также
Примеры использования
<? // определим право чтения на файл "/download/document.doc" у текущего пользователя $FILE_PERM = $APPLICATION->GetFileAccessPermission("/download/document.doc"); $FILE_PERM = (strlen($FILE_PERM)>0 ? $FILE_PERM : "D"); // если право чтения нет, то выводем форму авторизации if($FILE_PERM < "R") $APPLICATION->AuthForm("У вас нет права доступа к данному файлу."); ?>
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.