Онлайн-руководство разработчика NetCat
Новогодние скидки до 25%!
Подробнее
Модуль «Поиск по сайту» 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

API

  • $action
    тип действия текущей страницы
  • $addForm
    вывод альтернативной формы добавления
  • $addLink
    ссылка на страницу с формой добавления объекта
  • $AUTH_USER_ID
    номер авторизованного пользователя
  • $begRow
    порядковый номер объекта, с которого начинается вывод списка объектов на текущей странице
  • $catalogue
    номер (ID) текущего сайта
  • $cc
    номер (ID) текущего инфоблока
  • $ccLink
    содержит путь (URI) к текущему инфоблоку
  • $cc_array
    массив номеров инфоблоков в текущем разделе
  • $checkedLink
    ссылка на страницу включения-выключения объекта
  • $current_catalogue
    массив свойств текущего сайта
  • $current_cc
    массив свойств текущего инфоблока
  • $current_sub
    массив свойств текущего раздела
  • $current_user
    массив свойств текущего пользователя
  • $deleteLink
    ссылка на страницу удаления объекта с запросом подтверждения
  • $dropLink
    ссылка на страницу удаления объекта без запроса подтверждения
  • $editLink
    ссылка на страницу изменения объекта
  • $endRow
    порядковый номер объекта, которым кончается вывод списка объектов на текущей странице
  • $fullDateLink
    ссылка на страницу полного вывода объекта с датой добавления
  • $fullLink
    ссылка на страницу полного вывода объекта
  • $fullRSSLink
    ссылка на rss-просмотр объекта
  • $f_AdminButtons
    панелька управления объектом
  • $f_AdminCommon
    панелька управления инфоблоком
  • $f_Checked
    истина, если объект включен, и наоборот
  • $f_Created
    дата и время создания объекта
  • $f_IP
    IP-адрес посетителя, добавившего объект
  • $f_LastIP
    IP-адрес посетителя, последним изменившего объект
  • $f_LastUpdated
    дата и время последнего изменения этого объекта
  • $f_LastUserAgent
    UserAgent пользователя, последним изменившего объект
  • $f_LastUserID
    номер пользователя, последним изменившего объект
  • $f_RowID
    номер (ID) объекта в таблице БД (MessageXX), имеет строковое значение
  • $f_RowNum
    порядковый номер объекта на странице
  • $f_UserAgent
    UserAgent пользователя, создавшего объект
  • $f_UserID
    номер пользователя, создавшего объект
  • $f_ИмяПоля
    содержит значение поля компонента
  • $http->get_current_url()
    Возвращает полный URI адрес текущего HTTP запроса.
  • $http->make_get_request()
    Отправляет GET HTTP запрос. Выбрасывает nc_http_exception
  • $http->make_post_request()
    Отправляет POST HTTP запрос. Выбрасывает nc_http_exception
  • $http->set_base_url()
    Устанавливает базовый uri адрес удаленного сервера.
  • $http->set_headers()
    Задает заголовки для каждого HTTP запроса.
  • $http->set_request_timeout()
    Задает время ожидания от сервера. Значение по умолчанию - 60 секунд.
  • $message
    номер (ID) объекта в таблице БД (MessageXX), имеет целочисленное значение
  • $messaging->send_flash_call()
    Отправляет входящий звонок, выбрасывает исключение nc_messaging_exception, если у заданного сервиса не реализован интерфейс nc_messaging_api_flash_call
  • $messaging->send_message()
    Отправляет сообщение по заданным параметрам. Выбрасывает исключение nc_messaging_exception.
  • $messaging->send_netshop_message()
    Отправляет уведомление о изменении статуса заказа, является оберткой над базовым методом send_message(). Выбрасывает исключение nc_messaging_exception.
  • $messaging->send_security_message()
    Отправляет уведомление фильтра безопасности, является оберткой над базовым методом send_message(). Выбрасывает исключение nc_messaging_exception.
  • $messaging->send_system_message()
    Отправляет системное уведомление, является оберткой над базовым методом send_message(). Выбрасывает исключение nc_messaging_exception.
  • $MODULE_VARS
    содержит значения переменных настроек модулей
  • $msgID
    номер (ID) объекта в таблице БД (MessageXX), имеет целочисленное значение
  • $nc_auth->auth_form()
    возвращает форму авторизации или приветствие
  • $nc_auth->auth_links()
    возвращает код со ссылками на регистрацию и авторизацаию
  • $nc_auth->hash->add_pseudo_user()
    Метод для создания псевдопользователя
  • $nc_auth->hash->create_auth_hash()
    создает хэш для авторизации по хэшу
  • $nc_auth->hash->delete_auth_hash()
    удаляет хэш для пользователя
  • $nc_auth->hash->get_hash_by_user()
    возвращает хэш для пользователя
  • $nc_auth->pa_add()
    вносит средства на личный счет и возвращает его состояние
  • $nc_auth->pa_deduct()
    списывает средства с личного счета и возвращает его состояние
  • $nc_core->admin_mode
    определение текущего режима страницы
  • $nc_core->cache
    Возвращает экземпляр по-умолчанию сервисного класса nc_file_cache_service для кэширования данных в файле. Файлы кэша данного объекта хранятся в директории /netcat_cache/shared
  • $nc_core->catalogue->get_by_host_name()
    получение данных сайта по доменному имени
  • $nc_core->catalogue->get_by_id()
    получение данных сайта по его id
  • $nc_core->catalogue->get_mobile()
    получение на основном сайте данных мобильной версии
  • $nc_core->check_field()
    включение поля в компоненте или системной таблице
  • $nc_core->CLASS_TEMPLATE_FOLDER
    путь к директории шаблонов компонентов
  • $nc_core->component->get_by_id()
    получение данных компонента по его id
  • $nc_core->cookie->remove()
    метод удаляет cookie по имени
  • $nc_core->cookie->set()
    метод устанавливает cookie
  • $nc_core->db->column_exists()
    метод проверяет наличие определенного поля в таблице
  • $nc_core->db->connect()
    метод выполняет соединение с БД MySQL
  • $nc_core->db->debug()
    метод отображает последний запрос к базе данных и результат его выполнения
  • $nc_core->db->dumpvar()
    метод отображает содержимое переданного объекта в отформатированном виде.
  • $nc_core->db->escape()
    экранирует специальные символы и символ '/' в строке
  • $nc_core->db->flush()
    метод очищает закэшированные результаты запросов.
  • $nc_core->db->get_col()
    метод получает данные из определенного столбца таблицы в базе данных
  • $nc_core->db->get_col_info()
    метод отображает мета-информацию о поле из последнего запроса.
  • $nc_core->db->get_results()
    метод возвращает набор результатов выполненного запроса к базе данных
  • $nc_core->db->get_row()
    метод получает данные из определенной строки таблицы в базе данных
  • $nc_core->db->get_var()
    метод получает одну переменную из базы данных или ранее кэшированных результатов
  • $nc_core->db->hide_errors()
    метод отключает показ ошибок
  • $nc_core->db->prepare()
    метод экранирует специальные символы в строке
  • $nc_core->db->query()
    выполнение произвольного MySQL-запроса и попытка получения результата
  • $nc_core->db->quick_connect()
    быстрое соединение с БД MySQL
  • $nc_core->db->register_error()
    метод позволяет вывести ошибку SQL/DB
  • $nc_core->db->select()
    выбор базы данных для работы
  • $nc_core->db->show_errors()
    метод включает показ ошибок
  • $nc_core->db->sysdate()
    возвращает синтаксис получения текущей даты в MySQL
  • $nc_core->db->vardump()
    метод отображает содержимое переданного объекта в отформатированном виде
  • $nc_core->DOCUMENT_ROOT
    путь к корневой директории сайта
  • $nc_core->drop_settings()
    метод удаляет данные из таблицы настроек системы и модулей
  • $nc_core->edit_field()
    включение или выключение поля в компоненте или системной таблице
  • $nc_core->event->add_listener()
    метод прикрепления анонимной функции для обработки события
  • $nc_core->event->bind()
    метод прикрепления объекта к событию
  • $nc_core->event->check_event()
    проверка события по его имени
  • $nc_core->event->event_name()
    получение имени события
  • $nc_core->event->execute()
    вызов функции объектов для текущего события
  • $nc_core->event->get_all_events()
    получение массива всех событий
  • $nc_core->event->register_event()
    регистрация события
  • $nc_core->files->create_dir()
    создание директории с путем $path
  • $nc_core->files->delete_dir()
    удаление директории $path
  • $nc_core->files->field_save_file()
    метод сохраняет файл и добавляет его в поле компонента
  • $nc_core->files->save_file()
    метод сохраняет файл и добавляет его к системной таблице "Пользователи"
  • $nc_core->get_display_type()
    метод возвращает способ отображения для текущего раздела
  • $nc_core->get_interface()
    метод отображает текущую настройку мобильности сайта
  • $nc_core->get_login_field_label()
    метод возвращает текстовую подсказку к полю логина, в зависимости от выбранного метода авторизации
  • $nc_core->get_object()
    статический метод для получения объекта
  • $nc_core->get_settings()
    метод возвращает данные из таблицы настроек системы и модулей
  • $nc_core->get_system_table_fields()
    пример метода дедубликации
  • $nc_core->get_variable()
    метод доступа позволяет получить значение системной переменной объекта
  • $nc_core->gzip->check()
    метод проверяет возможность использования сжатия браузером
  • $nc_core->input->clear_system_vars()
    метод удаляет из массива переданного в первом параметре все системные переменные
  • $nc_core->input->fetch_cookie()
    метод доступа к обработанному COOKIE массиву
  • $nc_core->input->fetch_files()
    метод доступа к обработанному FILES массиву
  • $nc_core->input->fetch_get()
    метод доступа к обработанному GET массиву
  • $nc_core->input->fetch_get_post()
    метод доступа к обработанному GET массиву и POST массиву. Данные из GET массива имеют приоритет при схождении перед данными из POST массива
  • $nc_core->input->fetch_post()
    метод доступа к обработанному POST массиву
  • $nc_core->input->fetch_post_get()
    метод доступа к обработанному GET массиву и POST массиву. Данные из POST массива имеют приоритет при схождении перед данными из GET массива
  • $nc_core->input->fetch_session()
    метод доступа к обработанному SESSION массиву
  • $nc_core->input->filter()
    фильтрация символов переменной
  • $nc_core->input->in_superglobal()
    находится ли переменная в глобальном массиве
  • $nc_core->input->prepare_extract()
    массив подготавливает данные из REQUEST массивов, очищает их и заносит в объект $nc_core
  • $nc_core->input->prepare_superglobals()
    метод обработки содержимого глобального массива
  • $nc_core->input->recursive_add_slashes()
    метод добавляет слэши к переданным ему данным
  • $nc_core->input->recursive_stripcslashes()
    метод убирает слэши из переданных ему данных
  • $nc_core->InsideAdminAccess()
    метод проверяет имеет ли текущий пользователь доступ в административный раздел
  • $nc_core->inside_admin
    определение, находимся ли в панели администратора
  • $nc_core->is_mobile()
    метод проверяет зашёл ли пользователь с мобильного устройства
  • $nc_core->lang->acronym_from_full()
    метод возвращает акроним языка по его полному названию
  • $nc_core->lang->detect_lang()
    метод определение языка
  • $nc_core->lang->full_from_acronym()
    метод возвращает полное название языка по его акрониму
  • $nc_core->lang->get_all()
    метод получения массива языков
  • $nc_core->load()
    метод предназначен для загрузки расширений в систему
  • $nc_core->load_env()
    метод аналогичен устаревшей функции LoadEnv()
  • $nc_core->message->delete_by_id()
    метод удаляет запись(объект) из таблицы сущности(компонента)
  • $nc_core->message->get_by_id()
    метод возвращает данные определённого сообщения
  • $nc_core->modules->get_by_keyword()
    метод возвращает ассоциативный массив данных для конкретного модуля
  • $nc_core->modules->get_data()
    метод возвращает ассоциативный массив данных для всех модулей
  • $nc_core->modules->get_module_vars()
    метод возвращает многомерный массив параметров для всех модулей
  • $nc_core->modules->get_vars()
    метод возвращает параметры для конкретного модуля
  • $nc_core->modules->load_env()
    метод по сути повторяет устаревшую функцию LoadModuleEnv() загрузки модулей в систему
  • $nc_core->NC_CHARSET
    отображение текущей кодировки сайта
  • $nc_core->page->get_description()
    метод возвращает значение description для текущей страницы
  • $nc_core->page->get_field_name()
    получение имени поля
  • $nc_core->page->get_h1()
    метод возвращает заголовок для текущей страницы
  • $nc_core->page->get_keywords()
    метод возвращает значение keywords для текущей страницы
  • $nc_core->page->get_language_field()
    получение поля используемого языка
  • $nc_core->page->get_metatags()
    Метод позволяет получить блоки seo/smo для страницы.
  • $nc_core->page->get_smo_description()
    метод возвращает описание из SMO-разметки для текущей страницы
  • $nc_core->page->get_smo_image()
    метод возвращает путь к файлу SMO image для страницы (от корня сайта)
  • $nc_core->page->get_smo_keywords()
    метод возвращает ключевые слова из SMO-разметки для текущей страницы
  • $nc_core->page->get_smo_title()
    метод возвращает значение title из SMO разметки для текущей страницы
  • $nc_core->page->get_title()
    метод возвращает значение title для текущей страницы
  • $nc_core->page->set_canonical_link()
    устанавливает значение тэга <link rel="canonical"> для текущей страницы
  • $nc_core->page->set_current_metatags()
    метод установки метаданных по данным текущего раздела
  • $nc_core->page->set_h1()
    метод задаёт произвольный заголовок для текущей страницы
  • $nc_core->page->set_metatags()
    метод устанавливает указанный мета-тег для текущей страницы
  • $nc_core->php_ext()
    метод проверяет наличие php-расширения с именем $name
  • $nc_core->return_device()
    метод определяет тип устройства
  • $nc_core->set_settings()
    метод устанавливает настройку системы или модуля
  • $nc_core->set_variable()
    метод доступа, позволяет задать системную переменную объекта
  • $nc_core->subdivision->get_by_id()
    метод возвращает информацию о разделе по id
  • $nc_core->subdivision->get_by_uri()
    метод возвращает информацию о разделе по url
  • $nc_core->subdivision->get_lang()
    метод возвращает значение языка раздела по его id
  • $nc_core->subdivision->get_level_count()
    метод возвращает значение _level_count (уровень вроженности) для данного раздела
  • $nc_core->subdivision->get_parent_tree()
    метод возвращает системный массив _parent_tree для данного раздела
  • $nc_core->subdivision->get_template_settings()
    метод возвращает значение пользовательских настроек макета дизайна для указанного раздела с учётом иерархии разделов и значений по умолчанию
  • $nc_core->subdivision->inherit()
    метод наследует данные от сайта
  • $nc_core->subdivision->set_current_by_uri()
    метод устанавливает текущие данные сущности по адресу из системного массива $parsed_url
  • $nc_core->subdivision->update()
    метод обновления раздела
  • $nc_core->subdivision->validate_english_name()
    метод проверяет соответствие поля English_Name раздела системным требованиям
  • $nc_core->subdivision->validate_hidden_url()
    метод проверяет соответствие поля Hidden_URL раздела системным требованиям
  • $nc_core->sub_class->get_by_id
    получить информацию о сущности по id
  • $nc_core->sub_class->get_by_subdivision_id()
    метод возвращает данные инфоблоков по идентификатору раздела
  • $nc_core->sub_class->inherit()
    метод наследует данные из раздела, который, в свою очередь, наследует данные от сайта
  • $nc_core->sub_class->set_current_by_id()
    метод задаёт данные текущей сущности по её идентификатору
  • $nc_core->sub_class->validate_english_name()
    метод проверяет соответствие ключевого слова компонента в разделе системным требованиям
  • $nc_core->SYSTEM_FOLDER
    путь к системной директории Netcat
  • $nc_core->template->convert_subvariables()
    метод заменяет субпеременные полей (%имя_переменной) на их значения
  • $nc_core->template->inherit()
    метод наследует данные от родительских сущностей (макетов дизайна)
  • $nc_core->TEMPLATE_FOLDER
    путь к директории макетов Netcat
  • $nc_core->token->get()
    метод получения токена пользователя
  • $nc_core->token->get_input()
    метод вывода поля токена пользователя
  • $nc_core->token->get_url()
    метод получения ссылки с токеном пользователя
  • $nc_core->token->is_use()
    метод выбора действия для токена
  • $nc_core->token->verify()
    метод проверки соответствия токена
  • $nc_core->trash
    получение объекта сущности Trash расширения nc_Essence
  • $nc_core->uncheck_field()
    выключение поля в компоненте или системной таблице
  • $nc_core->url->build_url()
    метод возвращает строку параметров разделёнными амперсандами
  • $nc_core->url->get_parsed_url()
    метод доступа к многомерному системному массиву $parsed_url
  • $nc_core->url->get_uri_date()
    метод возвращает дату из строки адреса, в соответствии с принципом работы системы
  • $nc_core->url->parse_url()
    метод обрабатывает системный параметр REQUEST_URI и задаёт системный массив $parsed_url
  • $nc_core->url->set_parsed_url_item()
    метод доступа заменяет значения в системном массиве $parsed_url
  • $nc_core->url->source_url()
    метод формирует полную ссылку на основе системного массива $parsed_url и возвращает её как результат
  • $nc_core->user->add()
    метод позволяет добавить нового пользователя или пользователей
  • $nc_core->user->authorize_by_id()
    метод авторизирует пользователя с номером $user_id
  • $nc_core->user->authorize_by_pass
    авторизация пользователя с логином и паролем
  • $nc_core->user->change_password
    метод изменения пароля у пользователя
  • $nc_core->user->check_login
    метод проверяет логин на занятость и корректность ввода
  • $nc_core->user->delete_by_id
    метод удаления указанного пользователя
  • $nc_core->user->get_by_id
    метод выводит данные указанного пользователя
  • $nc_core->utf8->array_utf2win()
    метод конвертирует массив данных из кодировки UTF-8 в кодировку cp1251
  • $nc_core->utf8->array_win2utf()
    метод конвертирует массив данных из кодировки cp1251 в кодировку UTF-8
  • $nc_core->utf8->conv()
    метод конвертации строки из одной кодировки в другую
  • $nc_core->utf8->func_overload()
    метод возвращает значение mbstring.func_overload
  • $nc_core->utf8->mbstring_ext()
    метод проверяет, загружено ли расширение mbstring
  • $nc_core->utf8->utf2win()
    метод конвертирует строку из кодировки UTF-8 в кодировку cp1251
  • $nc_core->utf8->win2utf()
    метод конвертирует строку из кодировки cp1251 в кодировку UTF-8
  • $nc_core->widget->add_widget()
    метод добавления нового виджета
  • $nc_core->widget->add_widgetclass()
    метод добавления нового виджета-компонента
  • $nc_core->widget->assistant()
    метод выполняет определенное действие с виджетом
  • $nc_core->widget->drop_widget()
    метод удаления виджета
  • $nc_core->widget->drop_widgetclass()
    метод удаления виджета-компонента
  • $nc_core->widget->edit_widget()
    метод изменения существующего виджета
  • $nc_core->widget->edit_widgetclass()
    метод изменения существующего виджета-компонента
  • $nc_core->widget->generate()
    динамически выводит виджет на страницу с заданными параметрами
  • $nc_core->widget->get_id()
    метод получения id виджета или виджета-компонента
  • $nc_core->widget->get_where()
    метод возвращает строку запроса MySQL для получения информации о виджете или виджет-компоненте
  • $nc_core->widget->get_widget()
    метод получения информации о виджете
  • $nc_core->widget->get_widgetclass()
    метод получения информации о виджете-компоненте
  • $nc_core->widget->list_widgetclass()
    метод получает список всех виджет-компонентов
  • $nc_core->widget->load()
    метод загружает виджет-компонент
  • $nc_core->widget->show()
    метод возвращает html-код виджета
  • $nc_core->widget->show_macrofunc()
    метод определяет, показывать ли виджет макрофункции
  • $nc_core->widget->validate_keyword()
    метод проверяет ключевое слово
  • $nc_core->WIDGET_TEMPLATE_FOLDER
    путь к директории шаблонов виджетов
  • $nc_next_object
    ссылка на следующий объект в списке
  • $nc_parent_field_path
    наследования содержимого родительского поля в шаблонах компонента
  • $nc_parent_template_folder_path
    URI папки макета дизайна
  • $nc_prev_object
    ссылка на предыдущий объект в списке
  • $nc_search->get_results()
    выводит результаты поиска
  • $nc_search->show_advanced_form()
    выводит расширенную форму поиска
  • $nc_search->show_form()
    выводит форму поиска
  • $netshop->cart->get_discount_sum()
    сумма всех скидок в корзине
  • $netshop->cart->get_field_sum()
    cумма по полю в корзине
  • $netshop->cart->get_items()
    доступ к содержимому корзины
  • $netshop->cart->get_item_count()
    количество товаров в корзине
  • $netshop->cart->get_quantity_notifications()
    список оповещений о невозможности заказать выбранное количество товаров
  • $netshop->cart->get_totals()
    стоимость всех товаров в корзине
  • $netshop->check_new_order()
    проверка нового заказа перед оформлением
  • $netshop->convert_currency()
    конвертация валют
  • $netshop->filter->get_all_fields()
    все поля текущего компонента магазина
  • $netshop->filter->get_field()
    возвращает поле с установленными параметрами
  • $netshop->filter->get_field()
    возвращает поле с установленными параметрами
  • $netshop->filter->get_fields()
    возвращает массив полей с установленными параметрами
  • $netshop->filter->make_field()
    метод генерирует html-код фильтрующего поля
  • $netshop->format_price()
    форматирование цены в магазине
  • $netshop->get_add_order_url()
    возвращает URL для оформления заказа
  • $netshop->get_add_to_cart_url()
    путь к скрипту добавления товара в корзину
  • $netshop->get_currency_column()
    возвращает название колонки, соответствующей колонке с ценой
  • $netshop->get_previous_orders_count()
    общее количество предыдущих заказов
  • $netshop->get_previous_orders_sum()
    общая сумма предыдущих заказов
  • $netshop->get_price_column()
    возвращает название колонки цен для товара исходя из имеющихся правил выбора цен
  • $netshop->get_setting()
    настройки магазина для текущего сайта
  • $netshop->goodslist_compare()
    работа со списком сравниваемых товаров
  • $netshop->goodslist_favorite()
    добавление и удаление товаров в список избранных товаров
  • $netshop->goodslist_recent()
    работа со списком последних просмотренных товаров
  • $netshop->load_order()
    загрузить заказ с указанным идентификатором
  • $netshop->location->get_suggest_script()
    добавляет на страницу javascript-код для выбора населённого пункта
  • $netshop->place_order()
    оформление заказа
  • $netshop->previous_orders_had_item()
    присутствует ли товар в прошлых заказах
  • $netshop->promotion->activate_item_discount()
    активировать указанную сиюминутную скидку для конкретного товара
  • $netshop->promotion->deactivate_all_item_discounts()
    деактивировать все «сиюминутные» скидки
  • $netshop->promotion->deactivate_item_discount()
    деактивировать указанную «сиюминутную» скидку для конкретного товара
  • $netshop->promotion->get_activated_item_discounts_for_item()
    список «сиюминутных» скидок, которые могли бы быть применены к товару
  • $netshop->promotion->get_all_item_discounts()
    список всех действующих скидок на данном сайте (в том числе активированных введёнными купонами)
  • $netshop->promotion->get_coupon()
    получение объекта nc_netshop_promotion_coupon по коду купона
  • $netshop->promotion->get_coupon_notifications()
    получение списка сообщений, связанных с попыткой активации купона
  • $netshop->promotion->get_item_discount_sum()
    возвращает сумму скидки для указанного товара
  • $netshop->promotion->get_registered_coupons()
    возвращает список купонов, привязанных к пользовательской сессии
  • $netshop->promotion->is_item_discount_activated()
    проверить, активирована ли «сиюминутная» скидка
  • $netshop->promotion->register_coupon_code()
    привязывает купон к сессии пользователя
  • $netshop->promotion->unregister_coupon_code()
    удаляет купон из пользовательской сессии
  • $netshop->round_price()
    округление цены товара
  • $nextLink
    содержит ссылку на следующую страницу списка объектов
  • $parent_sub_tree
    массив свойств текущего раздела и его родителей всех уровней
  • $prevLink
    содержит ссылку на предыдущую страницу списка объектов
  • $recNum
    количество объектов для вывода
  • $rowCount
    реальное количество выведенных на страницу объектов компонента
  • $rssLink
    ссылка на страницу с rss-лентой этой страницы (если доступно)
  • $searchLink
    ссылка на страницу с формой поиска по данным инфоблока
  • $sub
    номер (ID) текущего раздела (в таблице Subdivision)
  • $subHost
    содержит основной хост (домен) сайта вида «www.company.ru»
  • $subLink
    содержит URI текущего раздела вида «/about/news/»
  • $subscribeLink
    ссылка на подписку на данный инфоблок
  • $sub_level_count
    содержит текущий уровень вложенности навигации
  • $template_settings[]
    массив, содержащий пользовательские настройки макета
  • $totRows
    cодержит общее количество объектов данного инфоблока
  • $xmlLink
    ссылка на xml-выгрузки содержимого страницы (если доступно)
  • %Footer
    вывод футера родительского макета
  • %Header
    вывод хедера родительского макета
  • %NAME
    макропеременная подстановки названия раздела/инфоблока
  • %NEXT_LEVEL
    макропеременная подстановки следующего уровня при выводе многоуровневого меню
  • %URL
    макропеременная подстановки URL раздела/инфоблока
  • %Поле
    выводит содержимое дополнительного поля макета
  • banner_rotate()
    возвращает HTML-код баннеров
  • banner_url()
    возвращает ссылку для баннера с номером $id
  • banner_zone()
    определяет номер актуальной баннерной зоны
  • browse_messages()
    формирует листинг страниц с объектами
  • decode_host()
    функция возвращает декодированное значение параметра $host содержащее доменное имя в формате punycode.
  • encode_host()
    функция возвращает закодированное в punycode значение параметра $host, содержащее доменное имя.
  • is_even()
    Проверяет параметр на четность.
  • listQuery()
    функция производит запрос $sql_query к базе данных, форматирует в соответствии с шаблоном $output_template и выводит результаты запроса
  • nc_array_to_string()
    переводит массив в строку по шаблону
  • nc_array_value()
    возвращает элемент $key массива $array, или $default, если такого элемента в массиве нет.
  • nc_auth_add_bann()
    добавляет пользователя во враги
  • nc_auth_add_friend()
    добавляет пользователя в друзья
  • nc_auth_add_relation()
    добавляет отношение пользователя к другому пользователю
  • nc_auth_delete_relation()
    удаляет отношение между пользователями
  • nc_auth_get_all_banned()
    возвращает всех врагов пользователя
  • nc_auth_get_all_friend()
    возвращает всех друзей пользователя
  • nc_auth_get_all_relation()
    возвращает все отношения пользователя
  • nc_auth_get_relation()
    позволяет узнать отношения между пользователями
  • nc_auth_is_banned()
    позволяет узнать, является ли пользователь врагом
  • nc_auth_is_friend()
    позволяет узнать, является ли пользователь другом
  • nc_auth_is_mutual()
    возвращает взаимный статус пользователей
  • nc_auth_messages_new()
    возвращает количество новых личных сообщений
  • nc_auth_messages_url()
    возвращает ссылку на раздел личных сообщений
  • nc_auth_profile_url()
    возвращает путь к профайлу пользователя
  • nc_auth_users_online()
    отображает список пользователей, присутствующих на сайте
  • nc_bbcode()
    обрабатывает текст с BB-кодами
  • nc_bbcode_bar()
    отображает панельку вставки BB-кодов
  • nc_bbcode_clear()
    функция очистки текста от BB-кодов (кроме URL)
  • nc_bool_field()
    функция генерирует поле типа «Логическая переменная»
  • nc_browse_catalogue()
    вывод списка сайтов
  • nc_browse_cc()
    вывод списка инфоблоков текущего раздела
  • nc_browse_level()
    вывод меню (списка разделов) определенного уровня
  • nc_browse_messages()
    формирует листинг страниц с объектами
  • nc_browse_path()
    вывод пути «хлебные крошки»
  • nc_browse_path_range()
    вывод пути («хлебные крошки») указанного диапазона
  • nc_browse_sub()
    вывод списка подразделов заданного раздела в соответствии с шаблоном $template
  • nc_bytes2size
    функция перевода байтов в Kb, Mb, Gb
  • nc_calendar_possibility_check()
    проверка наличия в таблице MessageXX поля $DateField
  • nc_camelcase_to_dashcase
    переводит строку CamelCase в dash-case
  • nc_check_email
    валидирует адрес электронной почты $email.
  • nc_cond_browse_sub()
    вывод списка подразделов заданного раздела
  • nc_copy_data()
    копирование данных из одной таблицы в другую
  • nc_Core::get_object()
    инстанцирование объекта nc_Core
  • nc_date_field()
    функция генерирует поле типа «Дата и время»
  • nc_delete_dir()
    удаление директории
  • nc_edit_inline()
    добавляет функционал inline-редактирования к текстовому или строковому полю
  • nc_fields_form()
    функция генерации формы добавления, редактирования, поиска, в зависимости от $action
  • nc_fields_form_fs()
    функция генерации формы добавления, редактирования, поиска, в зависимости от $action (для версий > 5)
  • nc_field_extension
    вывод содержимого из связанного поля
  • nc_file_field()
    функция генерирует поле типа «Файл»
  • nc_file_path()
    функция позволяет получить путь к файлу, указанному в определенном поле, по номеру (ID) этого объекта и номеру (ID) компонента, которому он принадлежит
  • nc_float_field()
    функция генерирует поле типа «Число с плавающей запятой»
  • nc_folder_path()
    возвращает путь к разделу с указанным идентификатором
  • nc_folder_url()
    возвращает полный (с доменными именем) URL раздела с указанным идентификатором
  • nc_format_typo()
    типографирование текста
  • nc_get_field_params()
    функция отдаёт массивы полей, для генерации альтернативных форм
  • nc_get_list_item_name()
    возвращает имя записи в списке (классификаторе) $classifier с ID = $id
  • nc_get_scheme()
    определение протокола http или https
  • nc_get_sub_children()
    получить идентификаторы всех подразделов раздела с идентификатором $sub
  • nc_get_template_children
    получить идентификаторы всех дочерних макетов для макета с идентификатором $template
  • nc_get_visual_settings()
    функция возвращает текущие визуальные настройки компонента в разделе по его идентификатору $cc
  • nc_image_edit_inline
    добавляет функционал inline-редактирования к изображению
  • nc_infoblock_path()
    возвращает путь к инфоблоку с указанным идентификатором
  • nc_infoblock_url()
    возвращает полный (с доменным именем) URL инфоблока с указанным идентификатором
  • nc_int_field()
    функция генерирует поле типа «Целое число»
  • nc_jquery()
    функция подключения jQuery скриптов
  • nc_js()

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

  • nc_list_field()
    функция генерирует поле типа «Список»
  • nc_list_select()
    функция позволяет генерировать HTML списки из Списков NetCat
  • nc_load_multifield()
    инициализирует объект призвольного поля мультифайла
  • nc_ls_display_container()
    формирует атрибут, необходимый для корректной работы нетрадиционного отображения страницы
  • nc_ls_display_form()
    возвращает специальный атрибут для html-форм в shortpage или longpage
  • nc_ls_display_link()
    возвращает специальный атрибут для ссылки в shortpage или longpage
  • nc_ls_display_pointer()
    плавный скроллинг к указанному контейнеру
  • nc_mail2queue()
    функция является частью функционала по рассылке писем.
  • nc_message_link()
    функция позволяет получить относительный путь к объекту (без домена) по номеру (ID) этого объекта и номеру (ID) компонента, которому он принадлежит
  • nc_messaging::get_instance()
    Возвращает экземпляр класса для работы с отправкой текстовых сообщений
  • nc_minify_all_js_files
    автоматическое сжатие указанных JavaScript файлов
  • nc_minify_file
    минифицирует CSS и JS файлы и возвращает ссылку на обработанный файл
  • nc_module_check_by_keyword
    функция проверяет установлен ли модуль
  • nc_move_directory()
    рекурсивное перемещение директорий
  • nc_multilist_field()
    функция генерирует поле типа «Множественный выбор»
  • nc_netshop_item_collection
    коллекции объектов
  • nc_netshop_item_variant_admin_table()
    вывод таблицы со списком вариантов в админразделе
  • nc_normalize_phone_number
    нормализует номер телефона
  • nc_numeral_inclination()
    склонение числительных
  • nc_objects_list()
    выводит данные из другого инфоблока
  • nc_object_path()
    возвращает путь к объекту
  • nc_object_url()
    возвращает полный (с доменным именем) URL объекта
  • nc_print_status
    вывод системного сообщения
  • nc_put_field()
    функция генерирует поле любого типа
  • nc_related_field()
    элементы для редактирования поля типа «связь с другим объектом»
  • nc_related_parse_format()
    возвращает массив с данными для получения заголовка связанного объекта по формату, указанном в формате поля типа «Связь с др. объектом»
  • nc_reset_button
    кнопка «отменить» для использования в альтернативных формах
  • nc_search::index_area()
    ставит задание на переиндексирование в очередь
  • nc_send_page_404()
    отправляет страницу 404 («не найдено»)
  • nc_set_calendar()
    вывод настроек календаря в шапке макета
  • nc_show_calendar()
    вывод календаря
  • nc_string_field()
    функция генерирует поле типа «Строка»
  • nc_submit_button
    кнопка «отправить данные» для использования в альтернативных формах
  • nc_text_field()
    функция генерирует поле типа «Текстовый блок»
  • nc_transliterate
    функция перевода русских букв в латинницу
  • nc_truncate_plain_string
    обрезка строки до указанного количества символов
  • nc_usergroup_add_to_group()
    функция добавляет пользователя в группу
  • nc_usergroup_create()
    функция создает группу пользователей именем $name
  • nc_usergroup_delete()
    функция удаляет группу(-ы) пользователей по идентификатору группы или массиву с идентификаторами групп $PermissionGroupID
  • nc_usergroup_get_group_by_user()
    функция возвращает все группы, в которых состоит пользователь
  • nc_usergroup_get_users_from_group()
    функция возвращает всех пользователей, находящихся в группе PermissionGroupID
  • nc_usergroup_remove_from_group()
    функция исключает пользователя из группы (пользователь должен состоять хотя бы в одной группе)
  • nc_usergroup_rename()
    функция переименовывает группу пользователей
  • opt()
    функция выводит строку $string в случае если $flag не ложь, не имеет пустое значение или не ноль
  • opt_case()
    выводит строку $string1 в случае если $flag не ложь, не имеет пустое значение или не ноль; в противном случае выводит строку $string2
  • parentofmessage()
    возвращает номер объекта – родителя «ветки» объектов (может использоваться в иерархическом форуме), в которой, в частности, содержится объект с номером $message_id
  • poll_alreadyAnswered()
    проверяет, участвовал ли пользователь в указанном опросе
  • poll_alternativeAnswer()
    выводит список альтернативных вариантов ответа
  • poll_percentLine()
    рисует линию, ширина которой в шаблоне $template соответствует количеству голосов
  • s_browse_catalogue()
    функция выводит список сайтов (блок навигации) в соответствии с шаблоном, описанным в хэш-массиве $template
  • s_browse_cc()
    выводит список ссылок по компонентам раздела в соответствии с шаблоном $template
  • s_browse_level()
    выводит список разделов уровня $level в соответствии с шаблоном $template
  • s_browse_path()
    выводит навигацию типа «хлебные крошки» (путь до текущей страницы) в соответствии с шаблоном $template
  • s_browse_path_range()
    вывод пути («хлебные крошки») указанного диапазона
  • s_browse_sub()
    вывод списка подразделов заданного раздела в соответствии с шаблоном $template
  • s_list_class()
    функция выводит «верхние» объекты из раздела $sub, компонента раздела $cc с параметрами $params
Описание проекта