Menu

## Metrics
in package

Metrics.php : 24

Класс для работы с KPI

Class Metrics

##### Tags

author

  Vladislav Andreev v@salesman.pro

version
  1.0

  (06/09/2019)

### Table of Contents

$db : mixed
  Различные параметры, в основном из GLOBALS
$error : mixed
$fpath : mixed
  Различные параметры, в основном из GLOBALS
$identity : mixed
  Различные параметры, в основном из GLOBALS
$iduser1 : mixed
  Различные параметры, в основном из GLOBALS
$opts : mixed
  Различные параметры, в основном из GLOBALS
$other : mixed
  Различные параметры, в основном из GLOBALS
$otherSettings : false|string
$params : array<string|int, mixed>
  Передача различных параметров
$response : array<string|int, mixed>
  Расширенный ответ
$rootpath : mixed
  Различные параметры, в основном из GLOBALS
$sqlname : mixed
  Различные параметры, в основном из GLOBALS
$tmzone : mixed
  Различные параметры, в основном из GLOBALS
__construct() : mixed
  Работает только с объектом Подключает необходимые файлы, задает первоначальные параметры Chats constructor
calculateFact() : float|int
  Расчет показателей по типу
calculateKPI() : int
  Расчет параметров для конкретного пользователя для конкретного показателя
deleteKPI() : string
  Удаление показателя сотрудника
deleteKPIbase() : string
  Удаление базового показателя
getElements() : array<string|int, mixed>
  Возвращает элементы справочников по типу
getKPIs() : array<string|int, mixed>
  Возвращает список базовых KPI
getKPIUsers() : array<string|int, mixed>
  Возвращает список сотрудников у которых есть KPI с указанным id
getPlanDo() : array<string|int, mixed>
  Расчет выполнения плана сотрудником
getSeason() : array<string|int, mixed>
  Выводит массив коэффициентов на указанный год
getUserKPI() : array<string|int, mixed>
  Возвращает список KPI сотрудника по iduser или значения конкретного KPI по id записи
metricEdizm() : array<string|int, mixed>
  Возвращает список названий единиц измерения метрик
MetricList() : array<string|int, mixed>
  Возвращает список названий метрик
MetricSubList() : array<string|int, mixed>
  Дополнительные фильтры для параметра
saveKPI() : array<string|int, mixed>
  Сохраняет KPI для сотрудника
saveKPIbase() : array<string|int, mixed>
  Сохраняет базовый KPI
setSeason() : string
  Сохраняет коэффициенты сезонности

### Properties

#### $db

Metrics.php : 31

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

`public mixed $db`

#### $error

Metrics.php : 47
`public mixed $error`

#### $fpath

Metrics.php : 31

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

`public mixed $fpath`

#### $identity

Metrics.php : 31

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

`public mixed $identity`

#### $iduser1

Metrics.php : 31

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

`public mixed $iduser1`

#### $opts

Metrics.php : 31

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

`public mixed $opts`

#### $other

Metrics.php : 31

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

`public mixed $other`

#### $otherSettings

Metrics.php : 51
`public false|string $otherSettings`

#### $params

Metrics.php : 38

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

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

#### $response

Metrics.php : 45

Расширенный ответ

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

#### $rootpath

Metrics.php : 31

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

`public mixed $rootpath`

#### $sqlname

Metrics.php : 31

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

`public mixed $sqlname`

#### $tmzone

Metrics.php : 31

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

`public mixed $tmzone`

### Methods

#### __construct()

Metrics.php : 58

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

`public __construct() : mixed`

##### Return values

mixed —

#### calculateFact()

Metrics.php : 1385

Расчет показателей по типу

`public calculateFact(int $iduser[, string $tip = '' ][, array<string|int, mixed> $params = [] ]) : float|int`

##### Parameters

$iduser : int
$tip : string = ''
  - MetricList()
$params : array<string|int, mixed> = []
  - параметры
  - str period - именованный период
  - date datum - конкретная дата или массив дат (начало, конец периода)
  - str values - массив значений для выборки
  - str subvalues - массив уточненных значений для выборки
  - bool personal - признак учета персональных результатов

##### Return values

float|int —

#### calculateKPI()

Metrics.php : 700

Расчет параметров для конкретного пользователя для конкретного показателя

`public calculateKPI(int $iduser, int $id[, string $period = 'month' ][, string|array<string|int, mixed> $datum = NULL ]) : int`

##### Parameters

$iduser : int
  - id сотрудника
$id : int
  - id показателя ( см. getKPIs() или getUserKPI() )
$period : string = 'month'
  - период, DEFAULT = month
$datum : string|array<string|int, mixed> = NULL
  - дата, DEFAULT = ''

##### Return values

int —

$result

#### deleteKPI()

Metrics.php : 671

Удаление показателя сотрудника

`public deleteKPI(int $id) : string`

##### Parameters

$id : int
  - id записи KPI

##### Return values

string —

- ответ
- good result = Удалено
- error result = Не указан ID параметра

#### deleteKPIbase()

Metrics.php : 575

Удаление базового показателя

`public deleteKPIbase(int $id) : string`

##### Parameters

$id : int

##### Return values

string —

$result

#### getElements()

Metrics.php : 282

Возвращает элементы справочников по типу

`public static getElements([string $type = '' ]) : array<string|int, mixed>`

##### Parameters

$type : string = ''

##### Return values

array<string|int, mixed> —

#### getKPIs()

Metrics.php : 337

Возвращает список базовых KPI

`public static getKPIs([int|null $id = NULL ]) : array<string|int, mixed>`

##### Parameters

$id : int|null = NULL
  - если указан, выводит параметры конкретного KPI

##### Return values

array<string|int, mixed> —

- ответ
- int id - id записи
- str title - название параметра
- str tip - тип параметра ( см. MetricList() )
- str tipTitle - расшифровка параметра
- str values - значения, разделенные (,)
- str subvalues - дополнительные значения, разделенные (,)

#### getKPIUsers()

Metrics.php : 481

Возвращает список сотрудников у которых есть KPI с указанным id

`public static getKPIUsers(int $id[, string|null $element = NULL ]) : array<string|int, mixed>`

##### Parameters

$id : int
$element : string|null = NULL
  - возвращает указанное поле в качестве значения или iduser (если не указано)

##### Return values

array<string|int, mixed> —

#### getPlanDo()

Metrics.php : 1936

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

`public getPlanDo(int $iduser[, int|null $syear = NULL ][, int|null $month = NULL ][, bool $ignorePersonal = false ]) : array<string|int, mixed>`

##### Parameters

$iduser : int
  - id сотрудника
$syear : int|null = NULL
  - год расчета или текущий
$month : int|null = NULL
  - месяц расчета или текущий
$ignorePersonal : bool = false

##### Return values

array<string|int, mixed> —

- ответ
- float summa - оборот факт
- float summaPlan - оборот плановый
- float summaPercent - процент выполнения
- float marga - маржа факт
- float margaPlan - маржа плановый
- float margaPercent - процент выполнения
- int|array users - число или массив с iduser

#### getSeason()

Metrics.php : 2153

Выводит массив коэффициентов на указанный год

`public getSeason(string $year) : array<string|int, mixed>`

##### Parameters

$year : string

##### Return values

array<string|int, mixed> —

#### getUserKPI()

Metrics.php : 402

Возвращает список KPI сотрудника по iduser или значения конкретного KPI по id записи

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

##### Parameters

$params : array<string|int, mixed> = []
  - параметры
  - int id - id записи KPI
  - int kpi - id показателя
  - int iduser - id пользователя
  - str year - год
  - bool as_money - форматирование значение показателя в сумму (разделители разрядов)

##### Return values

array<string|int, mixed> —

- ответ
- int id - id записи
- int kpi - id записи KPI
- str kpititle - название базового параметра
- str year - год
- str value - значение
- int iduser - id сотрудника
- str tip - тип параметра ( см. MetricList() )
- str tipTitle - расшифровка параметра
- str edizm - единица измерения
- isPersonal - признак персонального показателя
- period - обозначение периода ( day, week, month, quartal, year )
- str periodname - расшифровка периода

#### metricEdizm()

Metrics.php : 245

Возвращает список названий единиц измерения метрик

`public static metricEdizm() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

- массив параметров, где
- ключ - обозначение параметра ( см. MetricList() )
- значение - единица измерения

#### MetricList()

Metrics.php : 153

Возвращает список названий метрик

`public static MetricList() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

- массив параметров, где
- ключ - обозначение параметра
- значение - расшифровка

#### MetricSubList()

Metrics.php : 192

Дополнительные фильтры для параметра

`public static MetricSubList([string $main = '' ]) : array<string|int, mixed>`

##### Parameters

$main : string = ''
  - название параметра

##### Return values

array<string|int, mixed> —

- массив параметров, где
- ключ - обозначение параметра ( см. MetricList() )
- значение - массив возможных суб.парметров

#### saveKPI()

Metrics.php : 613

Сохраняет KPI для сотрудника

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

##### Parameters

$id : int
$params : array<string|int, mixed> = []
  - параметры
  - int kpi - id показателя
  - str year - год
  - str period - период расчета ( day, week, month, quartal, year )
  - int iduser - id сотрудника
  - str values - значение показателя
  - bool isPersonal - признак персонального показателя

##### Return values

array<string|int, mixed> —

- ответ
- str result = Изменено/Добавлено
- int data = id

#### saveKPIbase()

Metrics.php : 519

Сохраняет базовый KPI

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

##### Parameters

$id : int
$params : array<string|int, mixed> = []
  - параметры

##### Return values

array<string|int, mixed> —

- ответ
- str result = Изменено/Добавлено
- int data = id

#### setSeason()

Metrics.php : 2103

Сохраняет коэффициенты сезонности

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

##### Parameters

$year : int
$params : array<string|int, mixed> = []
  - array rate - массив коэффициентов месяц => коэффициент
  - int kpi - отношение к конкретному показателю ( не применяется )

##### Return values

string —

## Search results