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

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 — название компонента в разделе «Ответы», по умолчанию «Ответы».

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