Метод выводит «стенку комментариев» в прикреплённом объекте. Под прикреплённым объектом, понимается сообщение, которое комментируют. В методе доступны следующие параметры:

Параметр	Описание
$message_id	идентификатор сообщения, к которому следует вывести комментарии
$template	идентификатор шаблона вывода, прописанного в административной части модуля (по умолчанию равен 0)
$from	параметр, обозначающий с какого комментария начинать вывод «стенки комментариев» (по умолчанию равен 0)
$quantity	параметр, указывающий сколько комментариев вывести (по умолчанию равен 0, что означает, что нет ограничения на кол-во комментариев для вывода)
$reset	параметр, с помощью которого можно принудительно произвести инициализацию массива комментариев, если на момент использования метода он пуст. Значение по умолчанию – 0
$ignore	параметр, используемый для организации листинга (т.е. постраничной разбивки) комментариев. При значении 1 исключает из вывода подключение javascript файла comments.js, повторное формирование json параметров, префикс и суффикс «стенки комментариев», дублирование листинга комментариев и кнопки показа всех комментариев (если она включена)
$show_all	параметр, используемый для обнуления значения параметра $quantity для работы кнопки «Показать все»

$nc_comments->count ( $message_id, $selector = 0 )

Метод выводит количество комментариев в прикреплённом объекте. Доступны следующие параметры:

Параметр	Описание
$message_id	идентификатор сообщения, в котором следует подсчитать комментарии
$selector	параметр имеет 3 варианта значений: 0 - считать и комментарии, и ответы (по умолчанию), 1 - считать только комментарии, 2 - считать только ответы.

$nc_comments->last_visit ( $message_id )

Метод обновляет в таблице Comments_LastVisit сведения о последнем посещении текущего пользователя страницы объекта с комментариями. В методе доступен только 1 параметр:

$message_id – идентификатор сообщения, сведения о посещении которого следует обновить.

$nc_comments->addComment ( $message_id, $parent_message, $comment, $user = 0, $nc_comments_guest_name = '', $nc_comments_guest_email = '' )

Метод добавляет комментарий в базу и пересчитывает общее количество комментариев и ответов в таблице Comments_Count. В методе доступны параметры:

Параметр	Описание
$message_id	идентификатор сообщения, в котором добавлен комментарий
$parent_message	идентификатор родителя комментария
$comment	текст комментария
$user	идентификатор пользователя, добавившего комментарий
$nc_comments_guest_name	имя неавторизованного пользователя, добавившего комментарий
$nc_comments_guest_email	электронная почта неавторизованного пользователя, добавившего комментарий

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

$nc_comments->updateComment ( $id, $comment, $user = 0 )

Метод обновляет сведения о комментарии в базе. Доступны параметры:

Параметр	Описание
$message_id	идентификатор обновляемого комментария
$comment	текст комментария
$user	идентификатор пользователя, изменившего комментарий

$nc_comments->deleteComment( $id )

Метод удаляет комментарий из базы по заданному идентификатору ($id).

$nc_comments->changeChecked ( $id, $action='' )

Метод включает/выключает комментарий. Доступны параметры:

Параметр	Описание
$id	идентификатор включаемого/выключаемого комментария
$action	параметр, по умолчанию не имеет явно заданного действия, поэтому применение данного метода влючит комментарий, если он выключен и наоборот. Дополнительные значения устанавливают действия вне завивсимости от текущего значения поля Checked таблицы Comments_Text: Check – включить комментарий, Uncheck – выключить комментарий.

Параметр

Описание

$id

идентификатор включаемого/выключаемого комментария

$action

параметр, по умолчанию не имеет явно заданного действия, поэтому применение данного метода влючит комментарий, если он выключен и наоборот. Дополнительные значения устанавливают действия вне завивсимости от текущего значения поля Checked таблицы Comments_Text:
Check – включить комментарий,
Uncheck – выключить комментарий.

$nc_comments->delete_allComments()

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

Все параметры методов, у которых есть значение по умолчанию, являются необязательными для заполнения.

← Назад 12.19.2 Функционал модуля 12.19.4 Настройки Далее →

Наверх