offerComment

Класс для работы с комментариями товара

Переменные

Переменные отсутсвуют

Методы

void __call ()
mixed add ({ [offerId], [id], [userId], [userName], [userEmail], [text], [showKey], [adminViewKey], [subscribeKey], [offerRate], [textPlus], [textMinus] }) Добавляет новый коментарий.
void dropCache () Сбрасывает кеш информации о комментариях товара
mixed getAmount ({ [id], [offerId] }) Возвращает количествово комментариев к товару
mixed getId () Возвращает id комментария товара
mixed getList ({ [id], [offerId], [pageNumber], [amount], [orderType] }) Возвращает список коментариев к товару
object getNew () Возвращает новую копию класса
float getOfferRate ({ [id] }) Возвращает рейтинг товара в комментарии
float getRate ({ [id] }) Возвращает cуммарный пользовательский рейтинг комментария товара
mixed getRateMinus ({ [id] }) Возвращает отрицательный пользовательский рейтинг комментария товара
mixed getRatePlus ({ [id] }) Возвращает положительный пользовательский рейтинг комментария товара
mixed getSubscribeEmailList ({ [offerId], [excludeUserEmail] }) Возвращает список E-mail из комментариев в которых subscribeKey установлен в true
mixed getText ({ [id] }) Возвращает текст комментария товара
mixed getTextMinus ({ [id] }) Возвращает текст описания недостатков товара
mixed getTextPlus ({ [id] }) Возвращает текст описания достоинства товара
mixed getTime ({ [id] }) Возвращает время создания комментария товара в Unix формате
mixed getUserName ({ [id] }) Возвращает имя пользователя
mixed hasChild ({ [id] }) Проверяет существование вложенных комментариев
mixed init ({ [offerId], [id] }) Инициализация класса
mixed setSubscribeKey ({ [offerId], userEmail, value }) Отписываем пользователя от рассылки на комментарии и отзывы к товару
mixed updateRate ({ [id], [value] }) Обновляет рейтинга отзыва

__call

Примеры кода




add

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

Параметры

[offerId] int Id товара
[id] int Id комментария к товару. Если
[userId] int Id пользователя. По умолчанию: id авторизированного пользователя
[userName] string Имя пользователя
[userEmail] string E-mail пользователя
[text] string Текст комментария
[showKey] bool Ключ, отображать ли комментарий на сайте. Допустимы значения: 0, 1. По умолчанию: 1
[adminViewKey] bool Ключ, просмотрел ли администратор комментарий к товару. Допустимы значения: 0, 1. По умолчанию: 0
[subscribeKey] bool Ключ, подписки на уведомления к товару. Допустимы значения: 0, 1. По умолчанию: 0
[offerRate] float Рейтинг товара. По умолчанию: 0
[textPlus] int Текст, плюсы товара
[textMinus] int Текст, минусы товара

Возвращаемые значения

bool True - успех
string E101 - Неверный формат E-mail
bool False - в случае ошибки

Примеры кода




dropCache

Сбрасывает кеш информации о комментариях товара

Возвращаемые значения

void

Примеры кода




getAmount

Синоним: amount
Возвращает количествово комментариев к товару

Параметры

[id] int Id комментария к товару. По умолчанию: 0 (комментарии товара первого уровня)
[offerId] int Id товара. По умолчанию: 0 (все товары)

Возвращаемые значения

int Количествово комментариев к товару
bool False - в случае ошибки

Примеры кода




getId

Синоним: id
Возвращает id комментария товара

Возвращаемые значения

int Id коментария товара
bool False - в случае ошибки

Примеры кода




getList

Синоним: list
Возвращает список коментариев к товару

Параметры

[id] int Id комментария к товару. По умолчанию: 0 (комментарии товара первого уровня)
[offerId] int Id товара. По умолчанию: 0 (все товары)
[pageNumber] int Номер страницы. По умолчанию: 1
[amount] int Количество комментариев на странице. По умолчанию: 0 (все коментарии товара)
[orderType] string Метод сортировки. date, date desc, rate, rate desc. По умолчанию: date desc

Возвращаемые значения

array Список коментариев к товару offerComment
bool False - в случае ошибки

Примеры кода




getNew

Синоним: new
Возвращает новую копию класса

Возвращаемые значения

object offerComment

Примеры кода




getOfferRate

Синоним: offerRate
Возвращает рейтинг товара в комментарии

Параметры

[id] int Id комментария товара

Возвращаемые значения

float Рейтинг товара

Примеры кода




getRate

Синоним: rate
Возвращает cуммарный пользовательский рейтинг комментария товара

Параметры

[id] int Id комментария товара

Возвращаемые значения

float

Примеры кода




getRateMinus

Синоним: rateMinus
Возвращает отрицательный пользовательский рейтинг комментария товара

Параметры

[id] int Id комментария товара

Возвращаемые значения

int Отрицательный пользовательский рейтинг комментария товара
bool False - в случае ошибки

Примеры кода




getRatePlus

Синоним: ratePlus
Возвращает положительный пользовательский рейтинг комментария товара

Параметры

[id] int Id комментария к товару

Возвращаемые значения

int Положительный пользовательский рейтинг комментария товара
bool False - в случае ошибки

Примеры кода




getSubscribeEmailList

Синоним: subscribeEmailList
Возвращает список E-mail из комментариев в которых subscribeKey установлен в true

Параметры

[offerId] int Id товара
[excludeUserEmail] string E-mail пользователя для исключения из списка

Возвращаемые значения

array Список e-mail
bool False - в случае ошибки

Примеры кода




getText

Синоним: text
Возвращает текст комментария товара

Параметры

[id] int Id комментария к товару

Возвращаемые значения

string Текст комментария товара
bool False - в случае ошибки

Примеры кода




getTextMinus

Синоним: textMinus
Возвращает текст описания недостатков товара

Параметры

[id] int Id комментария к товару

Возвращаемые значения

string Текст описания недостатков товара
bool False - в случае ошибки

Примеры кода




getTextPlus

Синоним: textPlus
Возвращает текст описания достоинства товара

Параметры

[id] int Id комментария к товару

Возвращаемые значения

string Текст описания достоинства товара
bool False - в случае ошибки

Примеры кода




getTime

Синоним: time
Возвращает время создания комментария товара в Unix формате

Параметры

[id] int Id комментария к товару

Возвращаемые значения

int Время создания комментария товара в Unix формате
bool False - в случае ошибки

Примеры кода




getUserName

Синоним: userName
Возвращает имя пользователя

Параметры

[id] int Id комментария товара

Возвращаемые значения

string Имя пользователя
bool False - в случае ошибки

Примеры кода




hasChild

Проверяет существование вложенных комментариев

Параметры

[id] int Id комментария к товару

Возвращаемые значения

bool True - существуют
bool False - не существуют или в случае ошибки

Примеры кода




init

Инициализация класса

Параметры

[offerId] int Id товара
[id] int Id комментария к товару

Возвращаемые значения

bool True - обьект инициализирован
bool False - в случае ошибки

Примеры кода




setSubscribeKey

Отписываем пользователя от рассылки на комментарии и отзывы к товару

Параметры

[offerId] int Id товара
userEmail string E-mail пользователя
value float Устанавливаемое значение. Допустимые значения: 0, 1

Возвращаемые значения

bool True - успех
string E101 - Неверный формат E-mail
bool False - в случае ошибки

Примеры кода




updateRate

Обновляет рейтинга отзыва

Параметры

[id] int Id комментария
[value] int Значение на которыое нужно увеличить или уменьшить рейтинга комментария. Должно быть числом больше 0 (как парвило 1) или меньше 0 (как парвило -1)

Возвращаемые значения

bool True - успех
bool False - в случае ошибки

Примеры кода