1. class
  2. Lan
  3. \
  4. Ebs
  5. \
  6. Sdk
  7. \
  8. Report

Report

class Report implements Common

SDK для общих отчетов

Constants

GROUP_BY_DAY

Группировка по дням
GROUP_BY_MONTH

Группировка по месяцам
GROUP_BY_YEAR

Группировка по годам

Methods

__construct(Client $client)

Конструктор общего отчета

mixed
getBooksViewsStatistics(string $groupBy, string $periodFrom, string $periodTo)

Общая статистика чтения книг

array
getUrl(string $method, array $params = [])

Получение данных для запроса через API

mixed
getJournalsViewsStatistics(string $groupBy, string $periodFrom, string $periodTo)

Общая статистика чтения журналов

mixed
getUsersVisitsStatistics(string $groupBy, string $periodFrom, string $periodTo)

Статистика посещаемости

mixed
getAvailablePackets()

Доступные пакеты книг

mixed
getAvailableBooks(int $pdKey)

Доступные книги в пакете

mixed
getAvailableJournals()

Доступные журналы

Details

at line 62
__construct(Client $client)

Конструктор общего отчета

Экземпляр класса Report нужен для осуществления запросов к API для получения отчетных данных ЭБС Лань.

Parameters

Client $client Инстанс клиента

Пример:

     $token = '7c0c2193d27108a509abd8ea84a8750c82b3a520'; // токен для тестового подписчика

     $client = new Client($token); // инициализация клиента

     $report = new Report($client):

Exceptions

Exception

at line 84
mixed getBooksViewsStatistics(string $groupBy, string $periodFrom, string $periodTo)

Общая статистика чтения книг

Parameters

string $groupBy Группировка ('day|month|year')
string $periodFrom Период с (формат Y-m-d, например 2017-07-01)
string $periodTo Период с (формат Y-m-d, например 2017-08-28)

Return Value

mixed

Exceptions

Exception

at line 106
array getUrl(string $method, array $params = [])

Получение данных для запроса через API

Parameters

string $method Http-метод запроса
array $params Параметры для формирования урла

Return Value

array

Exceptions

Exception

at line 161
mixed getJournalsViewsStatistics(string $groupBy, string $periodFrom, string $periodTo)

Общая статистика чтения журналов

Parameters

string $groupBy Группировка ('day|month|year')
string $periodFrom Период с (формат Y-m-d, например 2017-07-01)
string $periodTo Период с (формат Y-m-d, например 2017-08-28)

Return Value

mixed

Exceptions

Exception

at line 184
mixed getUsersVisitsStatistics(string $groupBy, string $periodFrom, string $periodTo)

Статистика посещаемости

Parameters

string $groupBy Группировка ('day|month|year')
string $periodFrom Период с (формат Y-m-d, например 2017-07-01)
string $periodTo Период с (формат Y-m-d, например 2017-08-28)

Return Value

mixed

Exceptions

Exception

at line 203
mixed getAvailablePackets()

Доступные пакеты книг

Return Value

mixed

Exceptions

Exception

at line 217
mixed getAvailableBooks(int $pdKey)

Доступные книги в пакете

Parameters

int $pdKey Идентификатор пакета

Return Value

mixed

Exceptions

Exception

at line 229
mixed getAvailableJournals()

Доступные журналы

Return Value

mixed

Exceptions

Exception