Онлайн-руководство разработчика NetCat
Модуль «Поиск по сайту» 12.2.1Начало работы с модулем 12.2.2Язык запросов 12.2.3Способы хранения индекса 12.2.4Интерфейс модуля в панели управления сайтом 12.2.5Области индексирования 12.2.6Области HTML-страниц 12.2.7Области поиска на сайте 12.2.8Индексирование по расписанию, запуск индексирования в фоновом режиме 12.2.9Правила индексирования 12.2.10Постановка задачи переиндексирования в очередь 12.2.11Интеграция модуля в макеты дизайна сайта 12.2.12Простая форма поиска 12.2.13Расширенная форма поиска 12.2.14Вывод результатов поиска 12.2.15Стилизация списка подсказок 12.2.16Расширенные настройки 12.2.17Разработка расширений модуля 12.2.18Обзор архитектуры модуля 12.2.19Обработчики документов различных типов 12.2.20Текстовые фильтры 12.2.21Анализаторы текста 12.2.22Корректировщики запросов 12.2.23Подключение других поисковых систем 12.2.24Решение проблем с поиском 12.2.25Решение проблем с индексированием 12.2.26Справочник API

$nc_auth->auth_form()

$nc_auth->auth_form ( $params = array(), $template = array() )

возвращает форму авторизации или приветствие

Возвращает форму авторизации для не авторизованного пользователя и приветствие для авторизованного.

Если второй параметр метода с шаблонами отсутствует, то выводится форма авторизации по умолчанию на основе настроек, переданных в первом параметре.

Первый параметр представляет собой ассоциативный массив с ключами:

  • form_type — тип формы (для шаблонов 4.0):

    • v – вертикальная ( по умолчанию )

    • h – горизонтальная

    • t- табличная

  • submit_name — надпись на кнопке «Авторизоваться»

  • captcha_wrong — надпись при неправильной введенной каптчи

  • login_wrong — надпись при неправильно введенном логине

  • auth_text — название блока «Авторизация»

  • login_text — надпись «Логин»

  • reg_text — надпись «Регистрация»

  • pass_text — надпись «Пароль»

  • recovery_text — надпись «Забыли пароль»

  • hide_register_link — скрывать ссылку на регистрацию

  • login_save — запомнить пароль:

  • auto — checkbox не показывается, но пароль запоминается

  • checked — показывается отмеченный checkbox

  • none – не показывается

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

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

Второй параметр также представляет с собой ассоциативный массив:

  • auth_form — форма авторизации, в ней доступны следующие макропеременные:

    • %form_id — id формы

    • %action — action формы

    • %register_link — ссылка на регистрацию

    • %recovery_link — ссылка на восстановление пароля

    • %login_save — блок «запомнить меня»

    • %token_form — блок авторизации по токену

    • %vk_form – блок авторизации через ВКонтакте

    • %fb_form – блок авторизации через Facebook

    • %twitter_form – блок авторизации через Twitter

    • %openid_form – блок авторизации через OpenID

    • %oauth_form – блок авторизации через OAuth

  • login_save — блок «запомнить меня», если не задан, используется код по умолчанию

  • vk_form – форма авторизации через ВКонтакте, если не задан — берется код по умолчанию

  • fb_form – форма авторизации через Facebook если не задан — берется код по умолчанию

  • twitter_form – форма авторизации через Twitter, если не задан — берется код по умолчанию

  • openid_form – форма авторизации через OpenID, если не задан — берется код по умолчанию

  • token_form – форма авторизации через токен, значения по умолчанию нет

  • authorized — шаблон вывода приветствия, доступны следующие макропеременные:

    • %login — логин или имя пользователям

    • %profile_link — ссылка на профиль

    • %exit_link — ссылка на деавторизацию ( выход )

    • %messages — информер о личных сообщениях

  • messages — шаблон вывода сообщения о том, что нет новых сообщений ( этот код как раз и заменяет макропеременную %messages в предыдущем шаблоне)

  • messages_new — шаблон вывода сообщения о том, что новые сообщения есть ( как и в предыдущем случае, этот код заменяет %messages ), доступны следующие макропеременные:

    • %msg_url — ссылка на личные сообщениях

    • %msg_new — количество новых сообщений

Все шаблоны, кроме token_form, имеют значения по умолчанию. Если вам надо изменить, допустим, только вывод информера о новых сообщениях, то в метод надо передавать только шаблон messages_new:

$nc_auth->auth_form( null, array ('messages_new' => 'Есть новые сообщения!'))
Пример использования

Примеры использования в макете дизайна:

<?= $nc_auth->auth_form() ?>
<?= $nc_auth->auth_form( array('form_type' => 't') ) ?>
<?= $nc_auth->auth_form( null, array('authorized' => "Вы авторизованы как %login") ) ?>

Пример вывода блока авторизации через OpenID:

<script src="/netcat/modules/auth/auth.js"></script>
<?= $nc_auth->auth_form( null, array('auth_form' => "%openid_form") ) ?>

Обновлено: 01.02.2017

- 2017-02-01: добавлена документация о форме %oauth_form, исправлены опечатки, добавлен пример вывода блока авторизации через OpenID.

Описание проекта