Онлайн-руководство разработчика 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
Модуль «Интернет-магазин» 12.8.1Настройка модуля 12.8.2Настройка интернет-магазина 12.8.3Валюты 12.8.4Цены для разных групп пользователей 12.8.5Минимальная цена 12.8.6Способы доставки 12.8.7Способы оплаты 12.8.8Настройка шаблонов писем 12.8.9Бланки 12.8.10Скидки 12.8.11Сиюминутные скидки 12.8.12Купоны 12.8.13Редактирование заказов 12.8.14Статистика 12.8.15Компоненты товаров 12.8.16Варианты товаров 12.8.17Коллекции объектов 12.8.18Фильтр товаров 12.8.19Списки товаров 12.8.20Корзина 12.8.21Заказ 12.8.22Выгрузка предложений в Яндекс.Маркет 12.8.23Заказ на Маркете 12.8.24Выгрузка предложений в Товары@Mail.Ru 12.8.25Выгрузка товаров в Google Merchant 12.8.26Обмен данными с 1С 12.8.27Обмен данными с 1С 8-ой версии 12.8.28Обмен данными с 1С 7-ой версии 12.8.29Обмен данными с сервисом МойСклад 12.8.30Виджеты интернет-магазина 12.8.31Классы расчёта доставки 12.8.32Интернет-магазин <5.3 12.8.33Переход с прежней версии модуля 12.8.34Справочник API

Объект списка форумов

get_object()
Статичный метод. Для получения объекта следует использовать следующую конструкцию:

$parent_obj = nc_forum2_parent::get_object();

Метод возвращает объект списка форумов.

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

get_class_id()
Метод получения идентификатора связанного компонента:

$parent_obj->get_class_id();

Метод возвращает числовой идентификатор.

get_rss_class_id()
Метод получения идентификатора связанного шаблона компонента для RSS:

$parent_obj->get_rss_class_id();

Метод возвращает числовой идентификатор.

get_subclass_id()
Метод получения идентификатора компонента в разделе «Список форумов»:

$parent_obj->get_subclass_id($sub, $template = 0);

Первый обязательный параметр метода определяет, из какого корневого форума (раздела) следует получить данные. Второй параметр —идентификатор шаблона компонента.

Метод возвращает числовой идентифкатор.

get_rss_subclass_id()
Метод получения идентификатора компонента в разделе «Список форумов», который используется для RSS (в данном случае это шаблон «RSS» компонента «Список форумов»):

$parent_obj->get_subclass_id($sub);

Единственный обязательный параметр метода определяет, из какого корневого форума (раздела) следует получить данные.

Метод возвращает числовой идентифкатор.

По сути, метод использует функционал метода get_subclass_id() с передачей второго параметра.

get_rss_url()
Метод получения ссылки на ленту RSS для списка форумов:

$parent_obj->get_rss_url($sub);

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

Метод возвращает строку.

Ссылка будет получена только в том случае, если к корневому разделу прикреплён шаблон «RSS» компонента «Список форумов».

get_data()
Метод получения данных корневого раздела из MySQL таблицы Forum_Subdivisions:

$parent_obj->get_data($id, $item = "");

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

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

count_user_messages()
Метод подсчёта количества сообщений, написанных пользователем во всех форумах корневого раздела или всех написанных в системе сообщений:

$parent_obj->count_user_messages($user_id, $sub=0, $type=0);

Первый обязательный параметр метода определяет для какого пользователя подсчитываются сообщения. Второй параметр определяет, из какого корневого форума (раздела) необходимо получить данные.

Третий параметр определяет тип подсчитываемых сообщений (0 — все сообщения, 1 — только топики, 2 — только ответы).

Метод возвращает числовое значение.

get_users()
Метод получения идентификаторов всех пользователей, которые оставляли посты во всех форумах корневого раздела или во всех форумах системы:

$parent_obj->get_users($sub = 0, $type = 0);

Первый необязательный параметр определяет из какого корневого форума (раздела) получить данные. Если первый параметр не указан — учитываются все корневые разделы. Второй параметр определяет тип подсчитываемых сообщений (0 — все сообщения, 1 — только топики, 2 — только ответы).

Метод возвращает массив идентификаторов пользователей.

set_description()
Метод обновления описания корневого раздела в MySQL таблице Forum_Subdivisions:

$parent_obj->set_description($parent, $description);

Первый обязательный параметр — идентификатор корневого форума (раздела). В данном случае это идентификатор раздела в карте сайта. Второй параметр — текстовое описание корневого форума.

Объект форумов

get_object()
Статичный метод. Для получения объекта следует использовать следующую конструкцию:

$forum_obj = nc_forum2_forum::get_object();

Метод возвращает объект форумов.

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

get_class_id()
Метод используется для получения идентификатора связанного компонента:

$forum_obj->get_class_id();

get_rss_class_id()
Метод получения идентификатора связанного шаблона компонента для RSS:

$parent_obj->get_rss_class_id();

Метод возвращает числовой идентифкатор.

get_subclass_id()
Метод получения идентификатора компонента в разделе «Топики» (для форумов используется именно этот компонент):

$parent_obj->get_subclass_id($sub, $template = 0);

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

Метод возвращает числовой идентифкатор.

get_rss_subclass_id()
Метод получения идентификатора компонента в разделе «Топики», который используется для RSS (в данном случае это шаблон «RSS» компонента «Топики»):

$parent_obj->get_subclass_id($sub);

Единственный обязательный параметр метода определяет, из какого форума (раздела) следует получить данные.

Метод возвращает числовой идентифкатор.

По сути, метод использует функционал get_subclass_id(), с передачей второго параметра.

get_views()
Метод используется для получения количества просмотров форума:

$forum_obj->get_views($forum_id);

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

Метод возвращает числовое значение.

get_forum_url_by_cc_id()
Метод используется для получения ссылки на раздел форума по идентификатору компонента в разделе:

$forum_obj->get_forum_url_by_cc_id($cc);

Единственный обязательный параметр функции определяет, по какому компоненту в разделе следует получить результат. В данную функцию стоит передавать идентификатор компонента в разделе "Топики". Результирующая ссылка формируется с учётом отображения во front-office и back-office.

Метод возвращает строку.

Данный метод будет полезен для формирования возвратной ссылки в альтернативных формах.

get_rss_url()
Метод получения ссылки на ленту RSS списка топиков:

$parent_obj->get_rss_url($sub);

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

Метод возвращает строку.

Ссылка будет получена только в том случае, если к разделу форума прикреплён шаблон «RSS» компонента «Топики».

count_user_messages()
Метод используется для получения количества сообщений пользователя:

$forum_obj->count_user_messages($user_id, $forum=0, $type=0);

В функцию передаётся 3 параметра:

  • $user_id - идентификатор пользователя (обязательный);
  • $forum - идентификатор раздела форума;
  • $type - тип получаемого ответа:
    (0 — все сообщения, 1 — только топики, 2 — только ответы);

Метод возвращает числовое значение.

get_users()
Метод получения идентификаторов всех пользователей, оставлявщих посты в форуме:

$parent_obj->get_users($sub = 0, $type = 0);

Первый необязательный параметр определяет, из какого форума (раздела) следует получить данные. Второй параметр определяет тип сообщений (0 — все сообщения, 1 — только топики, 2 — только ответы).

Метод возвращает массив идентифкаторов пользователей.

get_data()
Метод получения данных раздела форума из MySQL таблицы Forum_Subdivisions:

$parent_obj->get_data($id, $item = "");

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

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

set_description()
Метод обновления описания форума в MySQL таблице Forum_Subdivisions:

$parent_obj->set_description($parent, $description);

Первый обязательный параметр — идентификатор форума (раздела). В данном случае это идентификатор раздела в карте сайта. Второй параметр — текстовое описание форума.

set_group()
Метод привязки форума к определённой категории в MySQL таблице Forum_Groups:

$parent_obj->set_group($forum, $group);

Первый обязательный параметр — идентификатор форума (раздела). В данном случае это идентификатор раздела в карте сайта. Второй параметр — идентификатор группы.

Доступные группы можно просмотреть в интерфейсе управления модулем.

check_existance()
Метод проверки существования форума в определённом корневом разделе по ключевому слову:

$parent_obj->check_existance($parent_id, $keyword);

Первый обязательный параметр — идентификатор корневого форума (раздела). В данном случае это идентификатор раздела в карте сайта. Второй параметр — ключевое слово раздела (поле EnglishName из таблицы Subdivision).

Метод возвращает идентификатор существующего раздела или false.

create()
Метод используется для создания форума (раздела форума с подключёнными компонентами):

$forum_obj->create(...);

В функцию передаются следующие параметры, их достаточно много, как и работа, которую выполняет данный метод:

  • $parent_id - идентификатор корневого раздела (обязательный);
  • $keyword — ключевое слово раздела форума (обязательный);
  • $name — название форума (обязательный);
  • $checked — включить раздел или нет;
  • $topic_keyword — ключевое слово компонента в разделе «Топики», по умолчанию topic;
  • $topic_name — название компонента в разделе «Топики», по умолчанию «Топики»;
  • $reply_keyword — ключевое слово компонента в разделе «Ответы», по умолчанию reply;
  • $reply_name — название компонента в разделе «Ответы», по умолчанию «Ответы».

Метод возвращает идентификатор созданного форума (раздела).

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