Class messages

---

[Строка 2]

Размещен: /messages/messages.class.php

---

---

Свойства класса

• $CacheMessages = array()
  Кэш сообщений

---

Константы класса

---

Унаследованные константы класса

---

Унаследованные свойства класса

---

Методы

• boolean AccessSiteUserToMessage()
  Проверка доступа пользователя сайта к сообщению
• boolean ChangeMessagesReadStatus()
  Метод изменения статуса сообщения "прочитано"/"не прочитано"
• resource DeleteSiteUsersMail()
  Удаление сообщения
• int GetCountUnreadMessages()
  Получение количества не прочитанных сообщений
• mixed GetMessage()
  Получение информации о сообщении
• mixed GetXMLForMessage()
  Формирование XML сообщения
• mixed InsertSiteUsersMail()
  Вставка/обновление сообщения
• boolean MarkEraseSiteUsersMail()
  Удаление сообщения пользователем сайта
• boolean RecalcMessagesInfo()
  Метод пересчёта информации о дереве сообщений
• boolean ShowMessages()
  Вывод личных сообщений пользователя сайта

Унаследованные методы

---

Описания методов

messages::AccessSiteUserToMessage

AccessSiteUserToMessage( int $site_users_mail_id, int $site_user_id );

Описание

Проверка доступа пользователя сайта к сообщению

Принимаемые параметры

$site_users_mail_id

идентификатор родительского сообщения

$site_user_id

идентификатор пользователя сайта

Возвращает

TRUE если пользователь имеет доступ к сообщению, иначе NULL

[ Наверх ]




messages::ChangeMessagesReadStatus

ChangeMessagesReadStatus( int $site_users_mail_id, [array $param = array('read_status' => 1)] );

Описание

Метод изменения статуса сообщения "прочитано"/"не прочитано"

Принимаемые параметры

$site_users_mail_id

идентификатор сообщения

$param

массив параметров

• int $param['read_status'] статус сообщения 0 - "не прочитано", 1 - "прочитано" (по умолчанию)
• int $param['all'] параметр определяем изменение статуса. Если 0 - для одного сообщения(по умолчанию), 1 - всех сообщения в переписке
• int $param['site_users_id'] идентификатор пользователя сайта, которым просмотрено сообщение. Если не передан определяется автоматически.

Возвращает

true - в случае удачного выполнения, иначе null

[ Наверх ]




messages::DeleteSiteUsersMail

DeleteSiteUsersMail( int $site_users_mail_id );

Описание

Удаление сообщения

Принимаемые параметры

$site_users_mail_id

идентификатор сообщения

[ Наверх ]




messages::GetCountUnreadMessages

GetCountUnreadMessages( int $site_users_mail_id, int $site_user_id );

Описание

Получение количества не прочитанных сообщений

Принимаемые параметры

$site_users_mail_id

идентификатор родительского сообщения

$site_user_id

идентификатор пользователя сайта

Возвращает

количество не прочитанных сообщений

[ Наверх ]




messages::GetMessage

GetMessage( int $site_users_mail_id );

Описание

Получение информации о сообщении

Принимаемые параметры

$site_users_mail_id

идентификатор сообщения

Возвращает

массив данных, либо null если сообщения не существует

[ Наверх ]




messages::GetXMLForMessage

GetXMLForMessage( int $site_users_mail_id );

Описание

Формирование XML сообщения

Принимаемые параметры

$site_users_mail_id

идентификатор сообщения

Возвращает

XML сообщения, либо NULL если сообщения не существует

[ Наверх ]




messages::InsertSiteUsersMail

InsertSiteUsersMail( array $param );

Описание

Вставка/обновление сообщения

Принимаемые параметры

$param

массив параметров

• int $param['site_users_mail_id'] идентификатор сообщения
• str $param['site_users_mail_datetime'] время сообщения, если не передано - берется текущее время сервера
• int $param['site_users_mail_from_id'] идентификатор пользователя (отправитель)
• int $param['site_users_mail_to_id'] идентификатор пользователя (получатель)
• str $param['site_users_mail_subject'] тема сообщения
• str $param['site_users_mail_text'] текст сообщения
• int $param['site_users_mail_read'] прочитано ли сообщение (1 - прочитано, 0 - не прочитано)
• int $param['site_users_mail_deleted_by_sender'] сообщение удалено отправителем (1 - удалено, 0 - не удалено)
• int $param['site_users_mail_deleted_by_recipient'] сообщение удалено получателем (1 - удалено, 0 - не удалено)
• int $param['site_users_mail_answer_to_mail_id'] идентификатор родительского сообщения

Возвращает

идентификатор вставленной/обновленной записи, либо NULL

[ Наверх ]




messages::MarkEraseSiteUsersMail

MarkEraseSiteUsersMail( int $site_users_mail_id, int $site_users_id );

Описание

Удаление сообщения пользователем сайта

Принимаемые параметры

$site_users_mail_id

идентификатор сообщения

$site_users_id

идентификатор пользователя

[ Наверх ]




messages::RecalcMessagesInfo

RecalcMessagesInfo( int $site_users_mail_id, [array $param = array()] );

Описание

Метод пересчёта информации о дереве сообщений

Принимаемые параметры

$site_users_mail_id

идентификатор сообщения

$param

массив параметров

• bool $param['undelete'] если true - отменяет удаление переписки, по умолчанию false

Возвращает

true - в случае удачного выполнения, иначе null

[ Наверх ]




messages::ShowMessages

ShowMessages( array $param );

Описание

Вывод личных сообщений пользователя сайта

Принимаемые параметры

$param

масиив параметров

• int $param['site_users_mail_id'] идентификатор сообщения, если 0 - выводится список диалогов
• int $param['site_users_id'] идентификатор пользователя сайта
• bool $param['show_external_property_for_user'] выводить в XML информацию о дополнительных свойствах пользователя сайта(true - выводить, false - не выводить). По умолчанию - false.
• int $param['after_message_id'] идентификатор сообщения, выводить в XML информацию только о сообщениях отправленных после переданного
• int $param['limit_from'] порядковый номер сообщения, с которого начинать вывод сообщений
• int $param['limit_count'] количество выводимых сообщений. По умолчанию 15.
• array $param['external_properties'] массив параметров для передачи в XML

[ Наверх ]

---

Описания переменных

• $CacheMessages = array() [Строка 9]
• Data type: array

Описание

Кэш сообщений

---

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

---