Menu

## Todo
in package

Todo.php : 27

Класс для работы с Напоминаниями

Class Todo

##### Tags

author

  Vladislav Andreev v@salesman.pro

version
  1.0

  (06/09/2019)

### Table of Contents

KEYS = ["tid" => "Идентификатор", "maintid" => "Идентификатор основного напоминания (при групповых напоминаниях)", "title" => "Тема", "des" => "Описание", "datum" => "Дата", "totime" => "Время", "tip" => "Тип", "active" => "Признак выполнения", "autor" => "Автор", "iduser" => "Исполнитель", "priority" => "Приоритет", "speed" => "Срочность", "alert" => "Уведомлять", "pid" => "Контакты", "clid" => "Клиент", "did" => "Сделка", "readonly" => "Только для чтения", "day" => "На весь день", "status" => "Статус выполнения"]
  Описание полей
$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>
  Передача различных параметров
$skey : mixed
  Различные параметры, в основном из GLOBALS
$sqlname : mixed
  Различные параметры, в основном из GLOBALS
$tmzone : mixed
  Различные параметры, в основном из GLOBALS
$rootpath : false|string
__construct() : mixed
add() : array<string|int, mixed>
  Добавление Напоминания
createCal() : bool
  Создает и отправляет по email напоминание и файл ical для импорта
doit() : array<string|int, mixed>
  Отметка выполненным
edit() : array<string|int, mixed>
  Редактирование Напоминания
editdate() : mixed
  Обновление даты напоминания
info() : array<string|int, mixed>
  Получение сырой информации по напоминанию
remove() : array<string|int, mixed>
  Удаление напоминания
taskTemplate() : array<string|int, mixed>
  Формирование массива данных для отправки письма

### Constants

#### KEYS

Todo.php : 56

Описание полей

`public mixed KEYS = ["tid" => "Идентификатор", "maintid" => "Идентификатор основного напоминания (при групповых напоминаниях)", "title" => "Тема", "des" => "Описание", "datum" => "Дата", "totime" => "Время", "tip" => "Тип", "active" => "Признак выполнения", "autor" => "Автор", "iduser" => "Исполнитель", "priority" => "Приоритет", "speed" => "Срочность", "alert" => "Уведомлять", "pid" => "Контакты", "clid" => "Клиент", "did" => "Сделка", "readonly" => "Только для чтения", "day" => "На весь день", "status" => "Статус выполнения"]`

### Properties

#### $db

Todo.php : 39

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

`public mixed $db`

#### $fpath

Todo.php : 39

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

`public mixed $fpath`

#### $identity

Todo.php : 39

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

`public mixed $identity`

#### $iduser1

Todo.php : 39

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

`public mixed $iduser1`

#### $ivc

Todo.php : 39

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

`public mixed $ivc`

#### $opts

Todo.php : 39

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

`public mixed $opts`

#### $otherSettings

Todo.php : 32
`public array<string|int, mixed> $otherSettings`

#### $params

Todo.php : 46

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

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

#### $skey

Todo.php : 39

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

`public mixed $skey`

#### $sqlname

Todo.php : 39

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

`public mixed $sqlname`

#### $tmzone

Todo.php : 39

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

`public mixed $tmzone`

#### $rootpath

Todo.php : 51
`private false|string $rootpath`

### Methods

#### __construct()

Todo.php : 78
`public __construct() : mixed`

##### Return values

mixed —

#### add()

Todo.php : 280

Добавление Напоминания

`public add(int $iduser[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$iduser : int
  - сотрудник, которому ставим напоминание
$params : array<string|int, mixed> = []
  - параметры см. KEYS
  - users - массив идентификаторов сотрудников, для группового напоминания

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

good result - result = Success - id = id записи - text = сообщения - notice = предупреждения

error result - result = Error - error - code - text

code:

    405 - Отсутствуют параметры - id автора напоминания

#### createCal()

Todo.php : 1592

Создает и отправляет по email напоминание и файл ical для импорта

`public createCal(int $id[, string $printrez = "true" ]) : bool`

##### Parameters

$id : int
  - идентификатор напоминания
$printrez : string = "true"
  - true|false - вывод результата

##### Tags

throws
  Exception

##### Return values

bool —

#### doit()

Todo.php : 1216

Отметка выполненным

`public doit( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id :
  - id напоминания
$params : array<string|int, mixed> = []
  - параметры
  - string rezultat - комментарий к выполнению
  - string tip - тип активности
  - int status - статус выполнения (1-успешно,2-не успешно)
  - datetime datum - дата + время выполнения
  - array files - массив идентификаторов файлов (файлы должны быть уже загружены в систему)

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

good result - result = Success - text = сообщения - cid = id записи Активности - notice = предупреждения

error result - result = Error - error - code - text

code:

    403 - Напоминание с указанным id не найдено в пределах аккаунта
    405 - Отсутствуют параметры - id автора напоминания

todo: добавить загрузку файлов из массива $_FILES через класс Upload

#### edit()

Todo.php : 557

Редактирование Напоминания

`public edit( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>`

##### Parameters

$id :
  - id напоминания
$params : array<string|int, mixed> = []
  - параметры см. KEYS
  - users - массив идентификаторов сотрудников, для группового напоминания

##### Tags

throws
  Exception

##### Return values

array<string|int, mixed> —

good result - result = Success - data = id записи - text = сообщения - notice = предупреждения

error result - result = Error - error - code - text

code:

    405 - Отсутствуют параметры - id автора напоминания

#### editdate()

Todo.php : 853

Обновление даты напоминания

`public editdate( $id, $newdate) : mixed`

##### Parameters

$id :
$newdate :

##### Tags

throws
  Exception

##### Return values

mixed —

#### info()

Todo.php : 184

Получение сырой информации по напоминанию

`public static info(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - id напоминания

##### Return values

array<string|int, mixed> —

- массив результата
- int tid - Идентификатор
- int maintid - Идентификатор основного напоминания (при групповых напоминаниях)
- str title - Тема
- str des - Описание
- date datum - Дата
- time totime - Время
- str tip - Тип
- str active - Признак выполнения - Уведомлять (yes|no)
- int autor - Автор
- int iduser - Исполнитель
- int priority - Приоритет (0-важно, 1-обычно, 2-не важно)
- int speed - Срочность (0-срочно, 1-обычно, 2-не срочно)
- str alert - Уведомлять (yes|no)
- str cid - Связанная активность
- str pid - Контакты (разделитель ;)
- int clid - id Клиента
- str client - Клиент
- int did - id Сделка
- int deal - Сделка
- str readonly - Только для чтения (yes|no)
- str day - На весь день" (yes|no)
- array child - Массив связанных напоминаний (для групповых)
- array users - Массив связанных исполнителей (для групповых)

#### remove()

Todo.php : 1131

Удаление напоминания

`public remove(int $id) : array<string|int, mixed>`

##### Parameters

$id : int
  - id напоминания

##### Return values

array<string|int, mixed> —

good result - result = Success - text = сообщения

error result - result = Error - error - code - text

code:

    403 - Напоминание с указанным id не найдено в пределах аккаунта
    405 - Отсутствуют параметры - id напоминания

#### taskTemplate()

Todo.php : 1383

Формирование массива данных для отправки письма

`public taskTemplate(int $id[, string $type = 'add' ][, string $rezultat = '' ]) : array<string|int, mixed>`

##### Parameters

$id : int
  - id напоминания
$type : string = 'add'
  - тип события: add, edit, doit
$rezultat : string = ''
  - результат выполнения

##### Return values

array<string|int, mixed> —

- ответ
  - to - email получателя
  - toname - имя получателя
  - from - email отправителя
  - fromname - имя отправителя
  - theme - Тема сообщения
  - html - Содержание ( http://www.php.su/htmlspecialchars )
  - tid - id напоминания
  - subscription - on|off
  - sendcal - on|off
  - iduser - id сотрудника
  - autor - автор напоминания todo: Перевести на шаблон в формате Mustache

## Search results