Documentation

Statistic
in package

Класс для получения статистических данных

Class Statistic

Tags
author

Vladislav Andreev v@salesman.pro

version
1.0

(06/09/2019)

Example:

$statistic = new Salesman\Statistic();
$result = $statistic -> clients($params);
$count = $result['count'];
$period

Table of Contents

$period  : mixed
$periods  : mixed
$response  : mixed
all()  : array<string|int, mixed>
Вывод полной статистики по всем показателям
clients()  : array<string|int, mixed>
Информация о новых клиентах
CreateDiagram()  : string
Создание диаграммы
dealsClose()  : array<string|int, mixed>
Информация о закрытых сделках
dealsNew()  : array<string|int, mixed>
Информация о новых сделках
invoices()  : array<string|int, mixed>
Информация о новых выставленных счетах
payments()  : array<string|int, mixed>
Информация об оплаченных счетах

Properties

$periods

public static mixed $periods = ["today", "yestoday", "week", "calendarweek", "calendarweekprev", "month", "monthprev", "prevmonth", "quart", "quartprev", "year", "yearprev"]

Methods

all()

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

public static all(string $period[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$period : string
  • период отчетности
$params : array<string|int, mixed> = []
  • массив параметров
Tags
throws
Exception
example

$Statistic = \Salesman\Statistic::all($period,$params);

Return values
array<string|int, mixed> —

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

good result - [result] = Ok - [title] - [count] - [info]

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

clients()

Информация о новых клиентах

public static clients(string $period[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$period : string
  • период отчетности
$params : array<string|int, mixed> = []
  • массив параметров
Tags
throws
Exception
example

$NewClients = \Salesman\Statistic::clients($period,$params);

Return values
array<string|int, mixed> —

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

good result - [result] = Ok - [title] - [count] - [info]

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

CreateDiagram()

Создание диаграммы

public static CreateDiagram(array<string|int, mixed> $data, int $period, string $method) : string
Parameters
$data : array<string|int, mixed>
  • массив данных
$period : int
  • период отчетности
$method : string
  • показатель
Tags
throws
Exception
Return values
string —

Возвращает ссылку на изображение

dealsClose()

Информация о закрытых сделках

public static dealsClose(string $period[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$period : string
  • период отчетности
$params : array<string|int, mixed> = []
  • массив параметров
Tags
throws
Exception
example

$CloseDeals = \Salesman\Statistic::dealsClose($period,$params);

Return values
array<string|int, mixed> —

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

good result - [result] = Ok - [title] - [count] - [info]

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

dealsNew()

Информация о новых сделках

public static dealsNew(string $period[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$period : string
  • период отчетности
$params : array<string|int, mixed> = []
  • массив параметров
Tags
throws
Exception
example

$NewDeals = \Salesman\Statistic::dealsNew($period,$params);

Return values
array<string|int, mixed> —

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

good result - [result] = Ok - [title] - [count] - [info]

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

invoices()

Информация о новых выставленных счетах

public static invoices(string $period[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$period : string
  • период отчетности
$params : array<string|int, mixed> = []
  • массив параметров
Tags
throws
Exception
example

$Invoices = \Salesman\Statistic::invoices($period,$params);

Return values
array<string|int, mixed> —

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

good result - [result] = Ok - [title] - [count] - [info]

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

payments()

Информация об оплаченных счетах

public static payments(string $period[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$period : string
  • период отчетности
$params : array<string|int, mixed> = []
  • массив параметров
Tags
throws
Exception
example

$Invoices = \Salesman\Statistic::payments($period,$params);

Return values
array<string|int, mixed> —

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

good result - [result] = Ok - [title] - [count] - [info] p error result - [result] = Error - [error][code] - [error][text]

Search results