API Documentation
\
Bazalt
ORM
Adapter
Connection
Exception
Generator
Plugin
Query
Relation

\Bazalt\ORMCollection

Summary

Methods
Properties
Constants
__construct()
getPagesCount()
getCount()
count()
countPerPage()
page()
getPage()
fetchPage()
getItemOrder()
getNext()
getPrev()
toArray()
orderBy()
addOrderBy()
fetchAll()
__call()
getQuery()
No public properties found
No constants found
getOrderQuery()
$query
$currentPage
$countPerPage
$pagesCount
$count
N/A
No private methods found
No private properties found
N/A

Properties

$currentPage

$currentPage : integer

Номер поточної сторінки

Type

integer

$countPerPage

$countPerPage : integer

К-ть записів на сторінку

Type

integer

$pagesCount

$pagesCount : integer

К-ть сторінок

Type

integer

$count

$count : integer

К-ть записів

Type

integer

Methods

__construct()

__construct(\Bazalt\ORM\Query  $query)

Construct

Parameters

\Bazalt\ORM\Query $query

Поточний запит

getPagesCount()

getPagesCount() : integer

Повертає к-ть сторінок

Returns

integer —

К-ть сторінок

getCount()

getCount() : integer

Повертає к-ть записів

Returns

integer —

К-ть записів

count()

count(integer|null  $count = null) : integer

Повертає або встановлює к-ть записів

Parameters

integer|null $count

К-ть записів

Returns

integer —

К-ть записів

countPerPage()

countPerPage(integer|null  $countPerPage = null) : integer

Повертає або встановлює к-ть записів на сторінку

Parameters

integer|null $countPerPage

К-ть записів на сторінку

Returns

integer —

К-ть записів на сторінку

page()

page(integer|null  $page = null) : integer

Повертає або встановлює номер поточної сторінки

Parameters

integer|null $page

Номер поточної сторінки

Returns

integer —

Номер поточної сторінки

getPage()

getPage(integer  $page = 1, integer  $countPerPage = 10) : array

Встановлює $this->currentPage, $this->countPerPage і робить вибірку данних для поточного запиту

Parameters

integer $page

Поточна сторінка
integer $countPerPage

К-ть записів на сторінку

Returns

array —

Результат вибірки

fetchPage()

fetchPage(  $className = null) : array

Робить вибірку данних для поточного запиту на основі $this->currentPage, $this->countPerPage і заповнює $this->count

Parameters

$className

Returns

array —

Результат вибірки

getItemOrder()

getItemOrder(\Bazalt\ORM\Record  $item) : integer|null

Дізнається позицію елементу у колекції

Parameters

\Bazalt\ORM\Record $item

Елемент

Returns

integer|null —

Позиція елементу у колекції

getNext()

getNext(\Bazalt\ORM\Record  $item, integer  $limit = 1) : \Bazalt\ORM\Record|array

Повертає елемент або масив елементів, який знаходиться після заданого елементу

Parameters

\Bazalt\ORM\Record $item

Елемент
integer $limit

К-сть елементів в результатів

Returns

\Bazalt\ORM\Record|array —

Наступний елемент(и)

getPrev()

getPrev(\Bazalt\ORM\Record  $item, integer  $limit = 1) : \Bazalt\ORM\Record|array

Повертає елемент або масив елементів, який знаходиться перед заданим елементом

Parameters

\Bazalt\ORM\Record $item

Елемент
integer $limit

К-сть елементів в результатів

Returns

\Bazalt\ORM\Record|array —

Попередній елемент(и)

toArray()

toArray(string  $field1, string|null  $field2 = null) : array

Повертає масив, або асоціований масив зі значень $field1 або $field1 => $field2

Parameters

string $field1

Назва поля
string|null $field2

Назва поля

Example: CMS_Model_User::getCollection()->toArray('id') --> array(1, 2, 3...) CMS_Model_User::getCollection()->toArray('id', 'login') --> array(1 => 'test1', 2 => 'test2', 3 => 'test3'...)

Returns

array —

Результат

orderBy()

orderBy(string  $fields) : \Bazalt\ORM\Query

Проксі метод для запиту, прокидає виклик orderBy в об'єкт $this->query

Parameters

string $fields

Список полів для ORDER BY

Returns

\Bazalt\ORM\Query —

Поточний запит

addOrderBy()

addOrderBy(string  $fields) : \Bazalt\ORM\Query

Проксі метод для запиту, прокидає виклик addOrderBy в об'єкт $this->query

Parameters

string $fields

Список полів для ORDER BY

Returns

\Bazalt\ORM\Query —

Поточний запит

fetchAll()

fetchAll() : array

Проксі метод для запиту, прокидає виклик fetchAll в об'єкт $this->query

Returns

array —

Результат вибірки

__call()

__call(string  $name, array  $arguments = array()) : \Bazalt\ORM\Query

Проксі метод для запиту, прокидає виклик $name в об'єкт $this->query

Parameters

string $name

Ім'я методу
array $arguments

Список аргументів

Returns

\Bazalt\ORM\Query —

Поточний запит

getQuery()

getQuery() : \Bazalt\ORM\Query

Rerurn current ORM query

Returns

\Bazalt\ORM\Query —

Поточний запит

getOrderQuery()

getOrderQuery() : \Bazalt\ORM\Query

Формує запит, що рахує позиції елементів

Returns

\Bazalt\ORM\Query —

Запит