Documentation

Comments
in package

Класс для управления обсуждениями

Class Comments

Tags
author

Vladislav Andreev v@salesman.pro

version
1.0

(06/09/2019)

Table of Contents

$db  : mixed
Различные параметры, в основном из GLOBALS
$fpath  : mixed
Различные параметры, в основном из GLOBALS
$identity  : mixed
Различные параметры, в основном из GLOBALS
$iduser1  : mixed
Различные параметры, в основном из GLOBALS
$ivc  : mixed
Различные параметры, в основном из GLOBALS
$opts  : mixed
Различные параметры, в основном из GLOBALS
$otherSettings  : array<string|int, mixed>
$params  : array<string|int, mixed>
Передача различных параметров
$response  : mixed
$rootpath  : string
Абсолютный путь
$settingsUser  : array<string|int, mixed>
$skey  : mixed
Различные параметры, в основном из GLOBALS
$sqlname  : mixed
Различные параметры, в основном из GLOBALS
$tmzone  : mixed
Различные параметры, в основном из GLOBALS
__construct()  : mixed
Работает только с объектом Подключает необходимые файлы, задает первоначальные параметры
close()  : array<string|int, mixed>
Метод закрытия/открытия обсуждения
delete()  : array<string|int, mixed>
Метод удаление комментария/обсуждения ( в т.ч. удаляет подписки, если это обсуждение, и файлы )
deleteFile()  : void
Удаление файла из обсуждения или комментария
edit()  : array<string|int, mixed>
Метод добавления/редактирования записей
info()  : array<string|int, mixed>
Информация по обсуждению
list()  : array<string|int, mixed>
Вывод списка тем или записей обсуждений
listForComments()  : void
TODO: не доделано Обсуждения в списке обсуждений
send()  : array<string|int, mixed>
Метод ортправки email-уведомления
sendplus()  : array<string|int, mixed>
Метод ортправки email-уведомления всем сотрудникам в одном письме
subscribe()  : bool
Метод подписки пользователя на обсуждение
unsubscribe()  : bool
Метод отписки пользователя от обсуждения

Properties

$db

Различные параметры, в основном из GLOBALS

public mixed $db

$fpath

Различные параметры, в основном из GLOBALS

public mixed $fpath

$identity

Различные параметры, в основном из GLOBALS

public mixed $identity

$iduser1

Различные параметры, в основном из GLOBALS

public mixed $iduser1

$ivc

Различные параметры, в основном из GLOBALS

public mixed $ivc

$opts

Различные параметры, в основном из GLOBALS

public mixed $opts

$otherSettings

public array<string|int, mixed> $otherSettings

$params

Передача различных параметров

public array<string|int, mixed> $params = []

$rootpath

Абсолютный путь

public string $rootpath

$settingsUser

public array<string|int, mixed> $settingsUser

$skey

Различные параметры, в основном из GLOBALS

public mixed $skey

$sqlname

Различные параметры, в основном из GLOBALS

public mixed $sqlname

$tmzone

Различные параметры, в основном из GLOBALS

public mixed $tmzone

Methods

__construct()

Работает только с объектом Подключает необходимые файлы, задает первоначальные параметры

public __construct() : mixed
Return values
mixed —

close()

Метод закрытия/открытия обсуждения

public static close(int $id) : array<string|int, mixed>
Parameters
$id : int
Tags
throws
Exception
Return values
array<string|int, mixed> —

  • массив с результатом

  • int id - id обсуждения

  • str message - ответ

delete()

Метод удаление комментария/обсуждения ( в т.ч. удаляет подписки, если это обсуждение, и файлы )

public static delete(int $id) : array<string|int, mixed>
Parameters
$id : int
Return values
array<string|int, mixed> —

  • массив с результатом

  • str res - ok | error

  • str text - ответ

  • int idparent - id обсуждения

deleteFile()

Удаление файла из обсуждения или комментария

public static deleteFile(int $id, int $fid) : void
Parameters
$id : int
$fid : int
Return values
void —

edit()

Метод добавления/редактирования записей

public edit(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id : int
  • id записи или 0
$params : array<string|int, mixed> = []

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

  • int iduser - пользователь, от имени которого добавляется обсуждение или комментарий ( = $iduser1, если не указан )

  • str title - название обсуждения ( для комментария не указывается )

  • str content - содержание записи

  • int pid - id контакта

  • int clid - id клиента

  • int did - id сделки

  • int project - id проекта

Tags
throws
Exception
Return values
array<string|int, mixed> —
  • int id - id записи
  • int idparent - id обсуждения
  • str text - ответ

info()

Информация по обсуждению

public static info( $id) : array<string|int, mixed>
Parameters
$id :
Return values
array<string|int, mixed> —
  • int id - id записи
  • int idparent - id обсуждения, = 0, если это голова ветки, > 0, если это ответ
  • str title - название обсуждения, пусто для ответов
  • str content - текст обсуждения/ответа
  • array fid - массив вложенных файлов ( id )
  • int clid - id Клиента
  • int did - id Сделки
  • int project - id Проекта

list()

Вывод списка тем или записей обсуждений

public list([string $type = 'themes' ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$type : string = 'themes'
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

listForComments()

TODO: не доделано Обсуждения в списке обсуждений

public listForComments( $id) : void
Parameters
$id :
Return values
void —

send()

Метод ортправки email-уведомления

public static send(int $id, int $iduser[, string $event = 'new' ], int $idcomment) : array<string|int, mixed>
Parameters
$id : int
  • id обсуждения
$iduser : int
  • id сотрудника
$event : string = 'new'
  • тип события (new - новое обсуждение, answer - ответ в ветке)
$idcomment : int
Tags
throws
Exception
Return values
array<string|int, mixed> —

sendplus()

Метод ортправки email-уведомления всем сотрудникам в одном письме

public static sendplus(int $id[, array<string|int, mixed>|null $users = NULL ][, string $event = 'new' ], int $idcomment) : array<string|int, mixed>
Parameters
$id : int
  • id обсуждения
$users : array<string|int, mixed>|null = NULL
  • массив id сотрудников
$event : string = 'new'
  • тип события (new - новое обсуждение, answer - ответ в ветке)
$idcomment : int
Tags
throws
Exception
Return values
array<string|int, mixed> —

subscribe()

Метод подписки пользователя на обсуждение

public static subscribe(int $id, int $iduser) : bool
Parameters
$id : int
  • id обсуждения
$iduser : int
  • id сотрудника
Return values
bool —

unsubscribe()

Метод отписки пользователя от обсуждения

public static unsubscribe(int $id, int $iduser) : bool
Parameters
$id : int
  • id обсуждения
$iduser : int
  • id сотрудника
Return values
bool —

Search results