Cetera\Iterator\DbObject | Fastsite CMS API

abstract class DbObject extends Base

Итератор объектов

Traits

DbConnection

Используется в классах, которым необходимо работать с БД.

Methods

void

__construct()

Конструктор

__toString()

No description

from Base

getElements()

No description

array

idArray()

Массив идентификаторов объектов

from Base

array

asArray()

Возвращает итератор в виде массива объектов с указанными полями

from Base

findIndexById($id)

No description

from Base

findById($id)

No description

from Base

int

count()

Количество объектов в итераторе

from Base

int

getCountAll()

Полное количество объектов

void

rewind()

Отмотать итератор к первому элементу

from Base

FSObject

current()

Возвращает текущий элемент

from Base

int

key()

Возвращает текущую позицию

from Base

void

next()

Переход к следующему элементу

from Base

bool

valid()

Текущий элемент существует?

from Base

Object

append($obj, $check = true)

Добавляет элемент

from Base

add($obj, $check = true)

No description

from Base

int

getFirstIndex()

Порядковый номер первого элемента

from Base

int

getLastIndex()

Порядковый номер последнего элемента

from Base

setItemCountPerPage($itemCountPerPage = null)

No description

setCurrentPageNumber($pageNumber)

No description

setOffset($offset)

No description

getPageCount()

No description

from Base

getCurrentPageNumber()

No description

from Base

Object

reverse()

Сортирует в обратном порядке

from Base

void

offsetSet($offset, $value)

Нельзя изменять содержимое

from Base

bool

offsetExists($offset)

Существует ли элемент на данной позиции

from Base

void

offsetUnset($offset)

Нельзя изменять содержимое

from Base

FSObject

offsetGet($offset)

Получить элемент на данной позиции

from Base

string

implode(mixed $element = 'name', string $filter = false)

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

from Base

Filter

createFilter(string $name)

Создает новый фильтр для этого итератора

from Base

clone()

No description

from Base

static Connection

getDbConnection()

Возвращает активное соединение с БД в рамках приложения

from DbConnection

static void

configSet(string $key, miced $value)

Сохраняет пару ключ/значение в БД

from DbConnection

static mixed

configGet(string $key)

Возвращает значение связанное с ключем из БД

from DbConnection

static mixed

configGetAll()

Возвращает все ключи/значения из БД

from DbConnection

static void

configUnset(string $key)

Удаляет пару ключ/значение из БД

from DbConnection

__clone()

No description

fetchElements()

No description

getQuery()

No description

setParameter($key, $value, $type = null)

No description

setParameters(array $params, array $types = array())

No description

select($select = null)

No description

where($where, $combination = 'AND')

No description

orderBy($order, $sort = null, $add = false)

No description

groupBy($groupBy, $add = true)

No description

Details

at line 34
`void __construct()`

Конструктор

Return Value

void

in Base at line 44
`__toString()`

at line 120
`getElements()`

in Base at line 66
`array idArray()`

Массив идентификаторов объектов

Return Value

array

in Base at line 77
`array asArray()`

Возвращает итератор в виде массива объектов с указанными полями

Return Value

array

in Base at line 109
`findIndexById($id)`

Parameters

$id

in Base at line 115
`findById($id)`

Parameters

$id

in Base at line 127
`int count()`

Количество объектов в итераторе

Return Value

int

at line 97
`int getCountAll()`

Полное количество объектов

Return Value

int

in Base at line 147
`void rewind()`

Отмотать итератор к первому элементу

Return Value

void

in Base at line 173
`FSObject current()`

Возвращает текущий элемент

Return Value

FSObject

in Base at line 183
`int key()`

Возвращает текущую позицию

Return Value

int

in Base at line 193
`void next()`

Переход к следующему элементу

Return Value

void

in Base at line 203
`bool valid()`

Текущий элемент существует?

Return Value

bool

in Base at line 221
`Object append($obj, $check = true)`

Добавляет элемент

Parameters

	$obj
	$check

Return Value

Object

in Base at line 228
`add($obj, $check = true)`

Parameters

	$obj
	$check

in Base at line 237
`int getFirstIndex()`

Порядковый номер первого элемента

Return Value

int

in Base at line 248
`int getLastIndex()`

Порядковый номер последнего элемента

Return Value

int

at line 125
`setItemCountPerPage($itemCountPerPage = null)`

Parameters

$itemCountPerPage

at line 131
`setCurrentPageNumber($pageNumber)`

Parameters

$pageNumber

at line 137
`setOffset($offset)`

Parameters

$offset

in Base at line 278
`getPageCount()`

in Base at line 289
`getCurrentPageNumber()`

in Base at line 300
`Object reverse()`

Сортирует в обратном порядке

Return Value

Object

in Base at line 310
`void offsetSet($offset, $value)`

Нельзя изменять содержимое

Parameters

	$offset
	$value

Return Value

void

in Base at line 321
`bool offsetExists($offset)`

Существует ли элемент на данной позиции

Parameters

$offset

Return Value

bool

in Base at line 331
`void offsetUnset($offset)`

Нельзя изменять содержимое

Parameters

$offset

Return Value

void

in Base at line 342
`FSObject offsetGet($offset)`

Получить элемент на данной позиции

Parameters

$offset

Return Value

FSObject

in Base at line 355
`string implode(mixed $element = 'name', string $filter = false)`

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

Parameters

mixed	$element	свойство объекта, которое использовать для формирования строки или функция, которая возвращает строку
string	$filter	функция фильтрации элементов, должна возвращать false, если элемент следует пропустить

Return Value

string

in Base at line 410
`Filter createFilter(string $name)`

Создает новый фильтр для этого итератора

Parameters

string

$name

имя фильтра

Return Value

Filter

in Base at line 414
`clone()`

in DbConnection at line 22
`final static Connection getDbConnection()`

Возвращает активное соединение с БД в рамках приложения

Return Value

Connection

in DbConnection at line 35
`static void configSet(string $key, miced $value)`

Сохраняет пару ключ/значение в БД

Parameters

string	$key	ключ
miced	$value	значение

Return Value

void

in DbConnection at line 47
`static mixed configGet(string $key)`

Возвращает значение связанное с ключем из БД

Parameters

string

$key

ключ

Return Value

mixed

in DbConnection at line 60
`static mixed configGetAll()`

Возвращает все ключи/значения из БД

Return Value

mixed

in DbConnection at line 78
`static void configUnset(string $key)`

Удаляет пару ключ/значение из БД

Parameters

string

$key

ключ

Return Value

void

at line 42
`__clone()`

at line 49
`fetchElements()`

at line 87
`getQuery()`

at line 143
`setParameter($key, $value, $type = null)`

Parameters

	$key
	$value
	$type

at line 150
`setParameters(array $params, array $types = array())`

Parameters

array	$params
array	$types

at line 158
`select($select = null)`

Parameters

$select

at line 167
`where($where, $combination = 'AND')`

Parameters

	$where
	$combination

at line 184
`orderBy($order, $sort = null, $add = false)`

Parameters

	$order
	$sort
	$add

at line 193
`groupBy($groupBy, $add = true)`

Parameters

	$groupBy
	$add

DbObject

Traits

Methods

Details

at line 34 void __construct()

Return Value

in Base at line 44 __toString()

at line 120 getElements()

in Base at line 66 array idArray()

Return Value

in Base at line 77 array asArray()

Return Value

in Base at line 109 findIndexById($id)

Parameters

in Base at line 115 findById($id)

Parameters

in Base at line 127 int count()

Return Value

at line 97 int getCountAll()

Return Value

in Base at line 147 void rewind()

Return Value

in Base at line 173 FSObject current()

Return Value

in Base at line 183 int key()

Return Value

in Base at line 193 void next()

Return Value

in Base at line 203 bool valid()

Return Value

in Base at line 221 Object append($obj, $check = true)

Parameters

Return Value

in Base at line 228 add($obj, $check = true)

Parameters

in Base at line 237 int getFirstIndex()

Return Value

in Base at line 248 int getLastIndex()

Return Value

at line 125 setItemCountPerPage($itemCountPerPage = null)

Parameters

at line 131 setCurrentPageNumber($pageNumber)

Parameters

at line 137 setOffset($offset)

Parameters

in Base at line 278 getPageCount()

in Base at line 289 getCurrentPageNumber()

in Base at line 300 Object reverse()

Return Value

in Base at line 310 void offsetSet($offset, $value)

Parameters

Return Value

in Base at line 321 bool offsetExists($offset)

Parameters

Return Value

in Base at line 331 void offsetUnset($offset)

Parameters

Return Value

in Base at line 342 FSObject offsetGet($offset)

Parameters

Return Value

in Base at line 355 string implode(mixed $element = 'name', string $filter = false)

Parameters

Return Value

in Base at line 410 Filter createFilter(string $name)

Parameters

Return Value

in Base at line 414 clone()

in DbConnection at line 22 final static Connection getDbConnection()

Return Value

in DbConnection at line 35 static void configSet(string $key, miced $value)

Parameters

Return Value

in DbConnection at line 47 static mixed configGet(string $key)

Parameters

Return Value

in DbConnection at line 60 static mixed configGetAll()

Return Value

in DbConnection at line 78 static void configUnset(string $key)

Parameters

at line 34
`void __construct()`

in Base at line 44
`__toString()`

at line 120
`getElements()`

in Base at line 66
`array idArray()`

in Base at line 77
`array asArray()`

in Base at line 109
`findIndexById($id)`

in Base at line 115
`findById($id)`

in Base at line 127
`int count()`

at line 97
`int getCountAll()`

in Base at line 147
`void rewind()`

in Base at line 173
`FSObject current()`

in Base at line 183
`int key()`

in Base at line 193
`void next()`

in Base at line 203
`bool valid()`

in Base at line 221
`Object append($obj, $check = true)`

in Base at line 228
`add($obj, $check = true)`

in Base at line 237
`int getFirstIndex()`

in Base at line 248
`int getLastIndex()`

at line 125
`setItemCountPerPage($itemCountPerPage = null)`

at line 131
`setCurrentPageNumber($pageNumber)`

at line 137
`setOffset($offset)`

in Base at line 278
`getPageCount()`

in Base at line 289
`getCurrentPageNumber()`

in Base at line 300
`Object reverse()`

in Base at line 310
`void offsetSet($offset, $value)`

in Base at line 321
`bool offsetExists($offset)`

in Base at line 331
`void offsetUnset($offset)`

in Base at line 342
`FSObject offsetGet($offset)`

in Base at line 355
`string implode(mixed $element = 'name', string $filter = false)`

in Base at line 410
`Filter createFilter(string $name)`

in Base at line 414
`clone()`

in DbConnection at line 22
`final static Connection getDbConnection()`

in DbConnection at line 35
`static void configSet(string $key, miced $value)`

in DbConnection at line 47
`static mixed configGet(string $key)`

in DbConnection at line 60
`static mixed configGetAll()`

in DbConnection at line 78
`static void configUnset(string $key)`

at line 42
`__clone()`

at line 49
`fetchElements()`

at line 87
`getQuery()`

at line 143
`setParameter($key, $value, $type = null)`

at line 150
`setParameters(array $params, array $types = array())`

at line 158
`select($select = null)`

at line 167
`where($where, $combination = 'AND')`

at line 184
`orderBy($order, $sort = null, $add = false)`

at line 193
`groupBy($groupBy, $add = true)`