Documentation

Client
in package

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

Class Client

Tags
author

Vladislav Andreev v@salesman.pro

version
1.0

(06/09/2019)

Example:

$Client  = new Salesman\Client();
$result = $Client -> add($params);
$clid = $result['data'];

Table of Contents

$bankInfoField  : mixed
$db  : mixed
Различные параметры, в основном из GLOBALS
$doubleid  : mixed
$fpath  : mixed
Различные параметры, в основном из GLOBALS
$identity  : mixed
Различные параметры, в основном из GLOBALS
$iduser1  : mixed
Различные параметры, в основном из GLOBALS
$isdouble  : mixed
$ivc  : mixed
Различные параметры, в основном из GLOBALS
$opts  : mixed
Различные параметры, в основном из GLOBALS
$params  : array<string|int, mixed>
Передача различных параметров
$rootpath  : string
Абсолютный путь
$skey  : mixed
Различные параметры, в основном из GLOBALS
$sqlname  : mixed
Различные параметры, в основном из GLOBALS
$tmzone  : mixed
Различные параметры, в основном из GLOBALS
__construct()  : mixed
Работает только с объектом Подключает необходимые файлы, задает первоначальные параметры Currency constructor.
actions()  : array<string|int, mixed>
Разные действия с клиентом
add()  : array<string|int, mixed>
Добавление клиента
changeDostup()  : array<string|int, mixed>
Управление доступом в карточку
changeRelation()  : array<string|int, mixed>
Смена типа отношений
changeUser()  : array<string|int, mixed>
Смена ответственного
checkDouble()  : object
Проверка на дубли по 3-м параметрам - phone, fax - email - ИНН + КПП Возвращает массив с тремя параметрами, в которых найдены дубли в которых ключ = clid, значение = совпадающий параметр
delete()  : array<string|int, mixed>
Удаление клиента
deleteFull()  : array<string|int, mixed>
todo: Полное удаление всех следов Клиента, вклчая Контакты, Сделки и все связанные записи
fieldNames()  : array<string|int, mixed>
Вспомогательная функция Возвращает массив имен полей Клиента
Fields()  : array<string|int, mixed>
fullupdate()  : array<string|int, mixed>
Изменение информации по клиенту Обновляет ВСЕ поля по клиенту Позволяет очистить не нужные поля
getFiledType()  : string
ignoreDouble()  : string
Обработка дубля без слияния
info()  : array<string|int, mixed>
Инормация о клиенте
list()  : array<string|int, mixed>
mergeDouble()  : string
Слияние дублей
Tags()  : array<string|int, mixed>
Возвращает готовые данные по клиенту в которых идентификаторы заменены конечными значениями
update()  : array<string|int, mixed>
Изменение информации по клиенту Обновляет только указанные в массиве $params поля
checkMailerEmail()  : void
Привязка сообщений к записям клиента по email И добавление в историю активностей Может применяться после добавления/обновления записи

Properties

$bankInfoField

public mixed $bankInfoField = ['castUrName', 'castInn', 'castKpp', 'castBank', 'castBankKs', 'castBankRs', 'castBankBik', 'castOkpo', 'castOgrn', 'castDirName', 'castDirSignature', 'castDirStatus', 'castDirStatusSig', 'castDirOsnovanie', 'castUrAddr']

$db

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

public mixed $db

$doubleid

public mixed $doubleid

$fpath

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

public mixed $fpath

$identity

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

public mixed $identity

$iduser1

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

public mixed $iduser1

$isdouble

public mixed $isdouble = []

$ivc

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

public mixed $ivc

$opts

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

public mixed $opts

$params

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

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

$rootpath

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

public string $rootpath

$skey

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

public mixed $skey

$sqlname

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

public mixed $sqlname

$tmzone

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

public mixed $tmzone

Methods

__construct()

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

public __construct() : mixed
Return values
mixed —

actions()

Разные действия с клиентом

public actions( $clid,  $action) : array<string|int, mixed>
Parameters
$clid :
$action :
  • массив с параметрами
  • trash - в корзину
  • untrash - из корзины
  • cold - в холодные
  • uncold - из холодных
  • fav - в избранные
  • unfav - из избранных
Return values
array<string|int, mixed> —

good result - result = result

error result - result = Error - text

Example:

$Client = new Client;
$rezult = $Client -> actions($clid, 'fav');

add()

Добавление клиента

public add([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
  • массив данных ключ = значение (см. БД {PREFIX}clientcat)
  • recv - реквизиты
Return values
array<string|int, mixed> —

good result - result = Успешно - data = clid

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

code:

 - 405 - Отсутствуют парамтеры (пустой массив $param)
 - 406 - Найден существующий клиент - {ClientName} ({clid}). Запрос отклонен.
 - 407 - Отсутствуют параметры - Название клиента

Example:

$Client = new Client;
$rezult = $Client -> add($params);

changeDostup()

Управление доступом в карточку

public changeDostup( $clid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$clid :
$params : array<string|int, mixed> = []
  • массив с параметрами
  • userlist
Return values
array<string|int, mixed> —

good result - result = Ok - data

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

code:

 - 403 - Клиент не найден
 - 408 - Клиент не удален. Имеются связанные записи - Сделки
 - 405 - Отсутствуют параметры - clid клиента

Example:

$Client = new Client;
$rezult = $Client -> changeDostup($clid, [1,2,3,4,5]);

changeRelation()

Смена типа отношений

public changeRelation( $clid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$clid :
$params : array<string|int, mixed> = []
  • массив с параметрами
  • str tip_cmr - Тип отношений
  • str reason - Комментарий
Tags
throws
Exception
Return values
array<string|int, mixed> —
  • result => Сделано
    • des
    • error

Example:

$Client = new Client;
$rezult = $Client -> changeRelation($clid, ['tip_cmr' => 'Ключевой','reason' => 'В работу']);

changeUser()

Смена ответственного

public changeUser( $clid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$clid :
$params : array<string|int, mixed> = []
  • массив с параметрами
  • newuser - iduser нового ответственного
  • person_send - передавать Контакты = yes|no
  • dog_send - передавать Сделки = yes|no
  • reason - комментарий
Tags
throws
Exception
Return values
array<string|int, mixed> —
  • result
    • error

Example:

$Client = new Client;
$rezult = $Client -> changeUser($clid, ['newuser' => 20, reason = 'в работу']);

checkDouble()

Проверка на дубли по 3-м параметрам - phone, fax - email - ИНН + КПП Возвращает массив с тремя параметрами, в которых найдены дубли в которых ключ = clid, значение = совпадающий параметр

public checkDouble( $clid[, array<string|int, mixed> $params = [] ]) : object
Parameters
$clid :
$params : array<string|int, mixed> = []
  • массив с параметрами
  • nolog = 1 - результат не будет внесен в лог дублей
  • noNotify = true - уведомления Координаторам отключаем принудительно
  • multi = true - для проверки всей базы
Tags
throws
Exception
Return values
object —

  • isdouble - массив дублей

       - id
   - phone
   - clid
   - recv
       - inn
       - kpp
    • doubleid - id записи в таблице _doubles

Example:

$Client = new Client;
$rezult = $Client -> checkDouble($clid, ['nolog' => 0,'noNotify' => false]);

delete()

Удаление клиента

public delete(int $clid) : array<string|int, mixed>
Parameters
$clid : int
  • идентификатор записи клиента
Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = clid

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

code:

 - 408 - Клиент не удален. Имеются связанные записи - Сделки
 - 405 - Отсутствуют параметры - clid клиента

Example:

$Client = new Client;
$rezult = $Client -> delete($clid);

deleteFull()

todo: Полное удаление всех следов Клиента, вклчая Контакты, Сделки и все связанные записи

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

fieldNames()

Вспомогательная функция Возвращает массив имен полей Клиента

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

Fields()

public Fields([mixed $filter = "" ]) : array<string|int, mixed>
Parameters
$filter : mixed = ""
Return values
array<string|int, mixed> —

fullupdate()

Изменение информации по клиенту Обновляет ВСЕ поля по клиенту Позволяет очистить не нужные поля

public fullupdate(int $clid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$clid : int
  • идентификатор записи клиента
$params : array<string|int, mixed> = []
  • массив данных ключ = значение (см. БД {PREFIX}clientcat)
  • recv - реквизиты
Tags
throws
Exception
Return values
array<string|int, mixed> —

good result - result = Успешно - data = clid

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

code:

 - 403 - Клиент с указанным clid не найден в пределах аккаунта
 - 405 - Отсутствуют параметры - clid клиента

Example:

$Client = new Client;
$rezult = $Client -> update($clid, $params);

getFiledType()

public static getFiledType( $field) : string
Parameters
$field :
Return values
string —

ignoreDouble()

Обработка дубля без слияния

public ignoreDouble( $id[, array<string|int, mixed> $params = [] ]) : string
Parameters
$id :
$params : array<string|int, mixed> = []
  • массив с параметрами
  • array more
  • des
Return values
string —

= ok

Example:

$Client = new Client;
$rezult = $Client -> ignoreDouble($id, $params);

info()

Инормация о клиенте

public static info(int $clid) : array<string|int, mixed>
Parameters
$clid : int
  • идентификатор записи клиента
Return values
array<string|int, mixed> —

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

  • client

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

    • str uid - идентификатор из внешних систем

    • str clientUID - идентификатор из внешних систем

    • int iduser - аккаунт-менеджер

    • str title - название клиента

    • str des - описание

    • int idcategory - отрасль, id

    • str category - отрасль, название

    • str phone - телефон

    • str fax - факс

    • str site_url - сайт

    • str mail_url - почта

    • str address - адрес

    • int pid - основной контакт, id

    • str fav - признак ключевого клиента yes|no

    • str trash - признак организации в корзине yes|no

    • int head_clid - головная организация, id

    • str head - головная организация

    • str scheme - схема принятия решений

    • str tip_cmr - тип отношений

    • str relation - тип отношений

    • int territory - территория, id

    • str territoryname - территория

    • int creatorID - пользователь, создавший организацию, iduser

    • str creator - пользователь, создавший организацию

    • date date_create - дата создания

    • int editorID - пользователь, изменивший организацию, iduser

    • str editor - пользователь, изменивший организацию

    • date date_edit - дата изменения

    • array dostup - массив iduser, у которых есть доступ к карточке

    • str clientpath - источник клиента

    • int clientpath2 - источник клиента

    • str type = client - тип клиента

    • str priceLevel = price_2 - уровень цен

    • str input1...xxx - дополнительные поля

    • array recv - реквизиты клиента

      • int clid - id клиента
      • str castUrName - полное юр.название
      • str castUrNameShort - краткое юр.название
      • str castName - краткое название
      • str castInn - ИНН
      • str castKpp - КПП
      • str castBank - название банка
      • str castBankKs - корреспондирующий счет
      • str castBankRs - расчетный счет
      • str castBankBik - БИК банка
      • str castOkpo - ОКПО
      • str castOgrn - ОГРН
      • str castDirName - ФИО Директора, родит.падеж ( Андреева Владислава Германовича )
      • str castDirSignature - Подпись Директора ( Андреев В.Г. )
      • str castDirStatus - Должность Директора, родит.падеж ( Генерального директора )
      • str castDirStatusSig - Должность Директора ( Генеральный директор )
      • str castDirOsnovanie - Устава
      • str castUrAddr - юр. адрес
      • str castFacAddr - фактический адрес
      • str castType - client ( person, parnter, contractor, concurent )

    • array person - данные основного контакта

      • int pid - id основного контакта
      • str title - ФИО
      • str post - Должность
      • str phone - номер телефона
      • str mob - номер мобильного
      • str email - email

возвращает массив или ошибку:

good result - result = Ok - client - recv - person

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

Example:

$Client = \Salesman\Client::info($clid);

list()

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

mergeDouble()

Слияние дублей

public mergeDouble( $id[, array<string|int, mixed> $params = [] ]) : string
Parameters
$id :
  • запись, в которую будем сливать
$params : array<string|int, mixed> = []

  • массив с параметрами - list - одномерный массив записей, которые будем вливать в главную - main - главная запись, в которую будемсливать остальные - more - доп.опции

  • trash - не удалять сливаемых, а поместить в корзину

  • newuser - назначить главную запись на сотрудника

  • merge - слить данные: телефоны, email

  • log - добавить в лог данные сливаемых записей

  • notify - уведомить сотрудников о слиянии

  • ignored - строка с id, которые исключили из слияния

Tags
throws
Exception

Example:

$Client = new Client;
$rezult = $Client -> mergeDouble($id, $params);
Return values
string —

= ok

Tags()

Возвращает готовые данные по клиенту в которых идентификаторы заменены конечными значениями

public Tags( $params) : array<string|int, mixed>
Parameters
$params :
  • входные данные по клиенту в виде массива, который выдает функция info
Return values
array<string|int, mixed> —
  • ключ = имя поля, значение = конечное значение

update()

Изменение информации по клиенту Обновляет только указанные в массиве $params поля

public update(int $clid[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$clid : int
  • идентификатор записи клиента
$params : array<string|int, mixed> = []
  • массив данных ключ = значение (см. БД {PREFIX}clientcat)
  • recv - реквизиты
Tags
throws
Exception

Example:

$Client = new Client;
$rezult = $Client -> update($clid, $params);
Return values
array<string|int, mixed> —

good result - result = Успешно - data = clid

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

code:

 - 403 - Клиент с указанным clid не найден в пределах аккаунта
 - 405 - Отсутствуют параметры - clid клиента

checkMailerEmail()

Привязка сообщений к записям клиента по email И добавление в историю активностей Может применяться после добавления/обновления записи

private checkMailerEmail( $mail_url,  $clid) : void
Parameters
$mail_url :
$clid :
Tags
throws
Exception
Return values
void —

Search results