Онлайн-руководство разработчика 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

Функции, доступные после установки модуля

После установки модуля Captcha в макетах дизайна и в компонентах доступны следующие функции:
 

nc_captcha_formfield ( [string $attributes, [string $beg, [string $mid, [string $end, [string $btn, [bool $norefresh, [int|string $id ]]]]]] )

Возвращает строку, которая содержит поле типа hidden, хранящее хэш-код от сгенерированной картинки и кода подтверждения на ней и html-код картинки с кодом подтверждения.

Хэш-код генерируется вызовом функции nc_captcha_generate_hash. Возвращает готовую разметку, пригодную для вставки в форму. Функция принимает необязательный аргумент с дополнительными атрибутами для тэга img.

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

<?=nc_captcha_formfield();?>

возвращает строку вида:

<input type='hidden' name='nc_captcha_hash' value='d41d8cd98f00b204e9800998ecf8427e'><img src='/netcat/modules/captcha/img.php?code=d41d8cd98f00b204e9800998ecf8427e'>
<?=nc_captcha_formfield('width="150" height="30" border="0"');?>

возвращает строку вида:

<input type='hidden' name='nc_captcha_hash' value='d41d8cd98f00b204e9800998ecf8427e'><img src='/netcat/modules/captcha/img.php?code=d41d8cd98f00b204e9800998ecf8427e' width="150" height="30" border="0">

$beg, $mid, $end — отвечают за отображения аудио капчи.

Значения по умолчанию:

$beg:

<span class='nc_captcha_voice' style='margin:0 0 0 10px;'><a class='nc_captcha_js' href='#' onclick='nc_captcha$id.play();return false;'>

$mid:

NETCAT_MODULE_CAPTCHA_AUDIO_LISTEN — макропеременная, содержащая «Прослушать».

$end:

</a><span id='nc_captcha_player' style='display:none;'></span></span>

Следующие параметры позволяют убрать кнопку обновления и изменить ее текст. начиная с версии 5.4

$btn:

NETCAT_MODULE_CAPTCHA_REFRESH — макропеременная, содержащая «Обновить».

$norefresh:

логическая переменная, если равна 1, то не будет отображена кнопка обновления.

$id:

суффикс для идентификаторов формы, нужен если функция вызывается несколько раз на странице, автоматически увеличивается при каждом вызове функции на странице.
 

nc_captcha_generate_hash ()

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

Функция не принимает аргументов. Возвращает хэш-код.

Код следует передавать через поле типа hidden на страницу валидации формы (обычно это Условие добавления объекта). На основе хэш-кода также генерируется картинка с кодом подтверждения. Путь к картинке: /netcat/modules/captcha/img.php?code=d41d8cd98f00b204e9800998ecf8427e. Пример использования в альтернативной форме добавления объекта:

".opt($captcha_hash = nc_captcha_generate_hash(), "")."
<input type='hidden' name='nc_captcha_hash' value='$captcha_hash'>
<img src='/netcat/modules/captcha/img.php?code=$captcha_hash'><br>
Введите код на картинке: <input type='text' name='nc_captcha_code' value=''>

Примечание! в большинстве случае достаточно использовать функцию nc_captcha_formfield; пример использования приведен выше.


nc_captcha_verify_code ( string $user_code [, string $user_hash [, bool $delete_hash = 1]] )

Проводит проверку корректности введенного пользователем кода подтверждения и полученного из этой же формы хэш-кода. Функция принимает от одного до двух аргументов. Первый – код подтверждения, введенный пользователем. Второй – необязательный хэш-код, по которому следует устанавливать корректность кода подтверждения. Если второй аргумент опущен, функция пытается получить его из массивов $_GET и $_POST (по имени, заданному в параметре HIDDEN_FIELD_NAME настроек модуля). Функция учитывает время действия (параметр DURATION в настройках модуля) хэш-кода.

Возвращает true, либо false. Пример использования в условии добавления объекта:

//Работает с предыдущим примером
if (!nc_captcha_verify_code($nc_captcha_code, $nc_captcha_hash) ) {
    $posting = 0;
    $warnText = "Здравствуй, робот!";
}

Если параметр $delete_hash будет равыен false, то хэш удаляться не будет.
 

nc_captcha_image

string nc_captcha_generate_image ( string $captcha_hash )

Функция содержит алгоритм генерации картинки с заданной последовательностью символов на основе хэш-кода. Возвращает картинку в формате gif. Подробнее см. Модификация модуля Captcha.


nc_captcha_generate_code

string nc_captcha_generate_code ( string $captcha_hash )

Функция создает случайный код и сопостовляет его хэшу, указанному в параметре $captcha_hash. Длина кода и набор символов, из которых состоит код, задается в настройках модуля.

Примечание! Во всех примерах использован хэш-код d41d8cd98f00b204e9800998ecf8427e, который является результатом выполнения функции md5 от пустой строки. 

Комментарии 2

intrell  ООО "Интрелл" 29 января 2015, 13:59:21
Дайте пример, как отключить кнопку обновления картинки в функции nc_captcha_formfield().
   
okn.name  Константин Орленко 30 января 2015, 11:53:27
[CODE]<input type="text" name="nc_captcha_code" id="code_control" />
<?= nc_captcha_formfield("", "", "", "", "", 1) ?>[/CODE]
   
Описание проекта