Documentation

Project
in package

Класс для работы с объектом Проект и его элементами

Class Project

Tags
author

Vladislav Andreev v@salesman.pro

version
2.1

(06/09/2019)

example

$Project = \Salesman\Project::info($id);

Table of Contents

COLORSPROJECT  = [0 => 'broun', 1 => 'blue', 2 => 'green', 3 => 'red', 4 => 'gray']
COLORSWORK  = [0 => 'broun', 1 => 'blue', 2 => 'orange', 3 => 'gray', 4 => 'green', 5 => 'red']
FIELDSPROJECT  = ["id" => "ID Проекта", "name" => "Название", "content" => "Описание", "datum" => "Дата создания", "date_start" => "Дата.Старт", "date_end" => "Дата.План", "date_fact" => "Дата.Факт", "comment" => "Комментарий", "status" => "Статус", "did" => "Сделка", "clid" => "Клиент", "pid_list" => "Контакты", "fid" => "Файлы", "author" => "Автор", "iduser" => "Ответственный", "identity" => ""]
FIELDSWORK  = ["id" => "ID Работы", "idproject" => "ID Проекта", "type" => "Тип работ", "name" => "Название", "datum" => "Дата создания", "date_start" => "Дата.Старт", "date_end" => "Дата.План", "date_fact" => "Дата.Факт", "content" => "Описание", "comment" => "Комментарий", "status" => "Статус", "author" => "Автор", "iduser" => "Ответственный", "workers" => "Исполнители", "fid" => "Файлы", "identity" => ""]
ICONSPROJECT  = [0 => 'icon-lamp', 1 => 'icon-tools', 2 => 'icon-check', 3 => 'icon-cancel-circled', 4 => 'icon-pause']
ICONSWORK  = [0 => 'icon-lamp', 1 => 'icon-tools', 2 => 'icon-jobsearch', 3 => 'icon-pause', 4 => 'icon-check', 5 => 'icon-cancel-circled']
STATUSPROJECT  = [0 => 'Новый', 1 => 'В работе', 2 => 'Выполнен', 3 => 'Отменен', 4 => 'Пауза']
STATUSWORK  = [0 => 'Новая', 1 => 'В работе', 2 => 'Проверка', 3 => 'Пауза', 4 => 'Выполнена', 5 => 'Отменена']
$response  : mixed
delete()  : array<string|int, mixed>
Удаление проекта
deleteTemplate()  : int
Удаление шаблона проекта
deleteType()  : array<string|int, mixed>
Удаление типа работы
deleteWork()  : array<string|int, mixed>
Удаление работы
edit()  : array<string|int, mixed>
Добавление/изменение проекта
editType()  : array<string|int, mixed>
Добавление/изменение типа работы
getCancelStatuses()  : array<string|int, mixed>
Получение массива финальных статусов Работ
getFinalStatuses()  : array<string|int, mixed>
Получение массива финальных статусов Проектов
getNextStatusProject()  : mixed|string
Получение следующего статуса проекта
getNextStatusWork()  : mixed|string
Получение следующего статуса работы
getStatusesProject()  : array<string|int, mixed>
Функция возвращает все статусы, в т.ч. кастомные
getStatusesWork()  : array<string|int, mixed>
Функция возвращает все статусы, в т.ч. кастомные
getTags()  : mixed
Подготовка тегов для шаблонов email
getTemplate()  : array<string|int, mixed>
Шаблон проекта
getTemplates()  : array<string|int, mixed>
Список шаблонов проектов
getWinStatuses()  : array<string|int, mixed>
Получение массива финальных статусов Работ
getWorkInfo()  : array<string|int, mixed>
Получение данных о работе
info()  : array<string|int, mixed>
Получение информации о проекте
listFull()  : array<string|int, mixed>
вывод списка проектов с работами для API. НЕ ДЛЯ ИНТЕРФЕЙСА
sendNotify()  : array<string|int, mixed>
Отправка уведомлений через систему Нотификации
setTemplate()  : int
Добавление/Обновление шаблона
stateToggleTemplate()  : int
Переключатель статуса активности шаблона
statusLog()  : array<string|int, mixed>
Вывод лога изменения статуса
statusProject()  : array<string|int, mixed>
Изменение статуса Проекта
statusWork()  : array<string|int, mixed>
Изменение статуса Работы
taskEdit()  : array<string|int, mixed>
Редактирование напоминания
taskInfo()  : mixed
Информация по Задаче. Если 0, то подготавливает данные для формы Задачи для новой
updateWork()  : array<string|int, mixed>
Добавление/изменение работы

Constants

COLORSPROJECT

public mixed COLORSPROJECT = [0 => 'broun', 1 => 'blue', 2 => 'green', 3 => 'red', 4 => 'gray']

COLORSWORK

public mixed COLORSWORK = [0 => 'broun', 1 => 'blue', 2 => 'orange', 3 => 'gray', 4 => 'green', 5 => 'red']

FIELDSPROJECT

public mixed FIELDSPROJECT = ["id" => "ID Проекта", "name" => "Название", "content" => "Описание", "datum" => "Дата создания", "date_start" => "Дата.Старт", "date_end" => "Дата.План", "date_fact" => "Дата.Факт", "comment" => "Комментарий", "status" => "Статус", "did" => "Сделка", "clid" => "Клиент", "pid_list" => "Контакты", "fid" => "Файлы", "author" => "Автор", "iduser" => "Ответственный", "identity" => ""]

FIELDSWORK

public mixed FIELDSWORK = ["id" => "ID Работы", "idproject" => "ID Проекта", "type" => "Тип работ", "name" => "Название", "datum" => "Дата создания", "date_start" => "Дата.Старт", "date_end" => "Дата.План", "date_fact" => "Дата.Факт", "content" => "Описание", "comment" => "Комментарий", "status" => "Статус", "author" => "Автор", "iduser" => "Ответственный", "workers" => "Исполнители", "fid" => "Файлы", "identity" => ""]

ICONSPROJECT

public mixed ICONSPROJECT = [0 => 'icon-lamp', 1 => 'icon-tools', 2 => 'icon-check', 3 => 'icon-cancel-circled', 4 => 'icon-pause']

ICONSWORK

public mixed ICONSWORK = [0 => 'icon-lamp', 1 => 'icon-tools', 2 => 'icon-jobsearch', 3 => 'icon-pause', 4 => 'icon-check', 5 => 'icon-cancel-circled']

STATUSPROJECT

public mixed STATUSPROJECT = [0 => 'Новый', 1 => 'В работе', 2 => 'Выполнен', 3 => 'Отменен', 4 => 'Пауза']

STATUSWORK

public mixed STATUSWORK = [0 => 'Новая', 1 => 'В работе', 2 => 'Проверка', 3 => 'Пауза', 4 => 'Выполнена', 5 => 'Отменена']

Properties

$response

public mixed $response = []

Methods

delete()

Удаление проекта

public static delete(int $id) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор записи проекта
Tags
example

$Project = \Salesman\Project::delete($id);

Return values
array<string|int, mixed> —

good result - [result] = Успешно удален - [data] = id

error result - [result] = result - [error][code] - [error][text]

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

deleteTemplate()

Удаление шаблона проекта

public static deleteTemplate(int $id) : int
Parameters
$id : int
Return values
int —

deleteType()

Удаление типа работы

public static deleteType(int $id, int $newid) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор типа
$newid : int
  • тип работ, который устанавливаем
Tags
example

$Type = \Salesman\Project::deleteType($id, $newid);

Return values
array<string|int, mixed> —

good result - [result] = Успешно удален - [data] = id

error result - [result] = result - [error][code] - [error][text]

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

deleteWork()

Удаление работы

public static deleteWork(int $id) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор записи работы
Tags
example

$Work = \Salesman\Project::deleteWork($id);

Return values
array<string|int, mixed> —

good result - [result] = Успешно удалено - [data] = id

error result - [result] = result - [error][code] - [error][text]

code: 403 - Работа с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id работы

edit()

Добавление/изменение проекта

public static edit(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор записи проекта
$params : array<string|int, mixed> = []

[name] - название [catid] - категория проекта [content] - описание [datum] - дата создания проекта [date_start] - дата принятия в работу [date_end] - плановая дата завершения [datum_fact] - фактическая дата завершения [comment] - комментарий к закрытию [status] - статус проекта [did] - id сделки [clid] - id клиента [iduser] - создатель проекта

Tags
throws
Exception
throws
Exception
example

$Project = \Salesman\Project::edit($id,$params);

Return values
array<string|int, mixed> —

good result - [result] = Успешно добавлен/изменен - [data] = id

error result - [result] = result - [error][code] - [error][text]

code:

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

editType()

Добавление/изменение типа работы

public static editType(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор типа
$params : array<string|int, mixed> = []

[title] - наименования [dirdeal] - связанное направление сделки [content] - описание [active] - признак актуальности

Tags
example

$Type = \Salesman\Project::editType($id);

Return values
array<string|int, mixed> —

good result - [result] = Успешно добавлен/изменен - [data] = id

error result - [result] = result - [error][code] - [error][text]

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

getCancelStatuses()

Получение массива финальных статусов Работ

public static getCancelStatuses() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFinalStatuses()

Получение массива финальных статусов Проектов

public static getFinalStatuses() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getNextStatusProject()

Получение следующего статуса проекта

public static getNextStatusProject(string $status) : mixed|string
Parameters
$status : string
Return values
mixed|string —

getNextStatusWork()

Получение следующего статуса работы

public static getNextStatusWork(string $status) : mixed|string
Parameters
$status : string
Return values
mixed|string —

getStatusesProject()

Функция возвращает все статусы, в т.ч. кастомные

public static getStatusesProject([string|null $status = null ]) : array<string|int, mixed>
Parameters
$status : string|null = null
Return values
array<string|int, mixed> —

getStatusesWork()

Функция возвращает все статусы, в т.ч. кастомные

public static getStatusesWork([string|null $status = null ]) : array<string|int, mixed>
Parameters
$status : string|null = null
Return values
array<string|int, mixed> —

getTags()

Подготовка тегов для шаблонов email

public static getTags(int $id[, string $type = 'project' ]) : mixed
Parameters
$id : int
$type : string = 'project'
Return values
mixed —

getTemplate()

Шаблон проекта

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

getTemplates()

Список шаблонов проектов

public static getTemplates() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getWinStatuses()

Получение массива финальных статусов Работ

public static getWinStatuses() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getWorkInfo()

Получение данных о работе

public static getWorkInfo(int $id) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор работы
Tags
example

$Work = \Salesman\Work::info($id);

Return values
array<string|int, mixed> —

work

error result - [result] = result - [error][code] - [error][text]

code: 403 - Работа с указанным id не найден в пределах аккаунта 405 - Отсутствуют параметры - id работы

info()

Получение информации о проекте

public static info(int $id) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор проекта
Tags
example

$Project = \Salesman\Project::info($id);

Return values
array<string|int, mixed> —

"Project"

error result - [result] = result - [error][code] - [error][text]

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

listFull()

вывод списка проектов с работами для API. НЕ ДЛЯ ИНТЕРФЕЙСА

public static listFull([array<string|int, mixed> $filter = [] ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed> = []

array status - по статусу проекта array statusWork - по статусу работ int page - номер страницы int iduser - id куратора str order - сортировать по столбцу, def = datum str sort - порядок сотрировки, def = DESC str word - поиск по слову str da1 - фильтр по дате начала str da2 - поиск по дате конца

Return values
array<string|int, mixed> —

sendNotify()

Отправка уведомлений через систему Нотификации

public static sendNotify( $event[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$event :

project.add, project.edit, project.status work.add, work.edit, work.status

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

type - тип события: project, work [ обязательное] id - ID Проекта или Работы [обязательное ] title - Заголовок [ не обязательное ] content - Содержание [ желательное ]

Tags
throws
Exception
Return values
array<string|int, mixed> —

setTemplate()

Добавление/Обновление шаблона

public static setTemplate(int $id[, array<string|int, mixed> $params = [] ]) : int
Parameters
$id : int
$params : array<string|int, mixed> = []
Return values
int —

stateToggleTemplate()

Переключатель статуса активности шаблона

public static stateToggleTemplate(int $id) : int
Parameters
$id : int
Return values
int —

statusLog()

Вывод лога изменения статуса

public static statusLog(int $id[, string $type = 'project' ]) : array<string|int, mixed>
Parameters
$id : int
$type : string = 'project'
Return values
array<string|int, mixed> —

statusProject()

Изменение статуса Проекта

public static statusProject( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id :
$params : array<string|int, mixed> = []

int status - новый статус проекта date date_fact - текущая дата string comment - комментарий

Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - [result] = Успешно - [message] = Сообщения

error result - [result] = result - [error][code] - [error][text]

statusWork()

Изменение статуса Работы

public static statusWork( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id :
$params : array<string|int, mixed> = []

status date_fact comment

Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - [result] = Успешно - [message] = Сообщения

error result - [result] = result - [error][code] - [error][text]

taskEdit()

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

public static taskEdit(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id : int
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
array<string|int, mixed> —

taskInfo()

Информация по Задаче. Если 0, то подготавливает данные для формы Задачи для новой

public static taskInfo(int $id[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$id : int
$params : array<string|int, mixed> = []
  • idproject
  • idwork
Return values
mixed —

updateWork()

Добавление/изменение работы

public static updateWork(int $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id : int
  • идентификатор записи работы
$params : array<string|int, mixed> = []

[idproject] - id проекта [name] - наименование [type] - тип [datum] - дата добавления [content] - описание [date_start] - дата принятия в работу [date_end] - плановая дата завершения [date_fact] - фактическая дата завершения [comment] - комментарий при выполнении [status] - статус выполнения [clid] - id клиента [iduser] - создатель [workers] - исполнители

Tags
throws
Exception
example

$Work = \Salesman\Project::updateWork($id,$params);

Return values
array<string|int, mixed> —

good result - [result] = Успешно изменено - [data] = id

error result - [result] = result - [error][code] - [error][text]

code:

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

Search results