1. class
  2. Lan
  3. \
  4. Ebs
  5. \
  6. Sdk
  7. \
  8. Collection
  9. \
  10. BookCollection

BookCollection

class BookCollection extends Collection

Коллекция книг

Methods

__construct(Client $client, array $fields = [], int $limit = 10, int $offset)

Конструктор коллекции

$this
setLimit(int $limit)

Установка лимита выборки

from Collection
$this
load(bool $force = false)

Загрузка коллекции

from Collection
$this
setOffset(int $offset)

Установка смещения выборки

from Collection
int
getFullCount()

Получение количества всех элементов без учета лимита

from Collection
CollectionIterator
getIterator()

Получение нового инстанса итератора коллекции

from Collection
int
count()

Количество моделей в коллекции

from Collection
array
getData()

Получение коллекции в виде массива

from Collection
Model
reset()

Получение первой модели в коллекции

from Collection
Model
createModel(array $data = null)

Создание модели по переданным данным

from Collection
Model
end()

Получение последней модели в коллекции

from Collection
Client
getClient()

Получение инстанса клиента

from Collection
int
getLimit()

Получение текущего лимита коллекции

from Collection
int
getOffset()

Получение текущего смещения коллекции

from Collection
float
getPages()

Общее количество страниц при заданом лимиите на страницу

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

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

Details

at line 36
__construct(Client $client, array $fields = [], int $limit = 10, int $offset)

Конструктор коллекции

Parameters

Client $client Инстанс клиента
array $fields Поля для выборки
int $limit Лимит выборки
int $offset Смещение выборки

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 5, 10); // инициализация коллекции книг

Exceptions

Exception

in Collection at line 155
$this setLimit(int $limit)

Установка лимита выборки

Установка/изменение лимита выборки коллекции. Вызывет перезагрузку коллекции если значение лимита изменилось

Parameters

int $limit Значение лимита выборки

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 5, 100); // инициализация коллекции книг

     $bookCollection->setLimit(100); // изменение лимита с 5 до 100

Return Value

$this Пример:

     echo $bookCollection->setLimit(100)->count(); // Выведет количество элементов коллекции

Exceptions

Exception

in Collection at line 206
$this load(bool $force = false)

Загрузка коллекции

Загрузка осуществляется только после вызова зависимого метода (ленивая загрузка)

Parameters

bool $force Заново загружать коллекцию даже если она загружена ранее

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 5, 100); // инициализация коллекции книг

     // Вызова метода загрузки еще небыло.. коллекция пустая
     $bookCollection->load(); // загрузка коллекции данными
     // Запрос к API выполнен.. коллекция загружена

Return Value

$this Вернет текущую коллекцию

Пример:

      echo $bookCollection->load()->count(); // Выведет количество элементов коллекции

Exceptions

Exception

See also

Collection::setLimit()
Collection::setOffset()
Collection::getFullCount()
Collection::getCount()
Collection::getData()
Collection::reset()
Collection::end()
CollectionIterator::rewind()

in Collection at line 261
$this setOffset(int $offset)

Установка смещения выборки

Установка/изменение смещения выборки коллекции. Вызывет перезагрузку коллекции если значение смещения изменилось

Parameters

int $offset Значение смещения выборки

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 5, 100); // инициализация коллекции книг

     $bookCollection->setOffset(1000); // изменение смещения со 100 до 1000

Return Value

$this Вернет текущую коллекцию

Пример:

     echo $bookCollection->setOffset(1000)->count(); // Выведет количество элементов коллекции

Exceptions

Exception

in Collection at line 301
int getFullCount()

Получение количества всех элементов без учета лимита

Вернет общее количество элементов необходимое, например, для вычисления постраничной выборки

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 5, 100); // инициализация коллекции книг

     echo $bookCollection->getFullCount(); // Вернет количество элементов без учета лимита

Return Value

int Пример:

     echo $bookCollection>getFullCount(); // Вернет, например, 286
     echo $bookCollection->сount(); // Вернет, например, 5
     // Итого получаем ceil($bookCollection>getFullCount() /  $bookCollection>getLimit()) = 58 страниц

Exceptions

Exception

in Collection at line 315
CollectionIterator getIterator()

Получение нового инстанса итератора коллекции

Итератор для реализации итерируемой коллекции

Return Value

CollectionIterator Вернет экзепляря итератора текущей коллекции

in Collection at line 345
int count()

Количество моделей в коллекции

Фактическое число моделей в коллекции

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 5, 100); // инициализация коллекции книг

     echo $bookCollection>getFullCount(); // Вернет количество элементов без учета лимита

Return Value

int Пример:

     echo $bookCollection->сount(); // Вернет, например, 5 (но не больше 5 - фактическое количество)

Exceptions

Exception

in Collection at line 381
array getData()

Получение коллекции в виде массива

Выгрузка коллекции в массив

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 1, 10); // инициализация коллекции книг

     print_r($bookCollection->getData()); // Вернет количество элементов без учета лимита

Return Value

array Пример:

[
     'id' => 22445,
     'name' => 'Свадьба. Сцена в одном действии',
     'authors' => 'Чехов А.П.'
]

Exceptions

Exception

in Collection at line 397
Model reset()

Получение первой модели в коллекции

Вернет первую модель коллекции.

Return Value

Model

Exceptions

Exception

in Collection at line 432
Model createModel(array $data = null)

Создание модели по переданным данным

Создает модель по ее данным

Пример:

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

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

     $bookCollection = new BookCollection($client, [], '\Lan\Ebs\Sdk\Model\Book', 1, 10); // инициализация коллекции книг

     $bookData = [
         'id' => 22445,
         'name' => 'Свадьба. Сцена в одном действии',
         'authors' => 'Чехов А.П.'
     ];

     $book = $bookCollection->createModel($bookData);

Parameters

array $data Данные для создания модели

Return Value

Model Вернет модель на основе данных

Exceptions

Exception

in Collection at line 455
Model end()

Получение последней модели в коллекции

Вернет полделнюю модель коллекции.

Return Value

Model

Exceptions

Exception

in Collection at line 467
protected Client getClient()

Получение инстанса клиента

Return Value

Client

in Collection at line 477
int getLimit()

Получение текущего лимита коллекции

Return Value

int

in Collection at line 488
int getOffset()

Получение текущего смещения коллекции

Return Value

int

in Collection at line 499
float getPages()

Общее количество страниц при заданом лимиите на страницу

Return Value

float

Exceptions

Exception

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

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

Метод возвращает данные по запросу к апи (урл, метод запроса, код ответа успешного ответа)

Parameters

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

Return Value

array

Exceptions

Exception