1. class
  2. Cetera
  3. \
  4. Iterator
  5. \
  6. Catalog
  7. \
  8. Path

Path

class Path extends Catalog implements RecursiveIterator

Итератор разделов от корня до заданного

Traits

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

Methods

void
__construct($parent = null)

Конструктор

__toString()

No description

from Catalog
getElements()

No description

from DbObject
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()

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

from DbObject
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

from DbObject
setCurrentPageNumber($pageNumber)

No description

from DbObject
setOffset($offset)

No description

from DbObject
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 = '\\Cetera\\Iterator\\Catalog\\Catalog::SlashedNames', string $filter = '\\Cetera\\Iterator\\Catalog\\Catalog::RootExcludeFilter')

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

from Catalog
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

from DbObject
fetchElements()

No description

getQuery()

No description

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

No description

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

No description

from DbObject
select($select = null)

No description

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

No description

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

No description

from DbObject
groupBy($groupBy, $add = true)

No description

from DbObject
join($fieldName, $direct)

No description

from DynamicObject
joinReverse($od, $fieldName, $direct)

No description

from DynamicObject
filterInclude($fieldName, $condition, $combination = 'AND')

No description

from DynamicObject
filterExclude($fieldName, $condition, $combination = 'AND')

No description

from DynamicObject
getObjectDefinition()

No description

from DynamicObject
bool
hasChildren()

Имеет ли текущий раздел дочерние разделы

from Catalog
Catalog_Iterator
getChildren()

Возвращает дочерние разделы текущего раздела

from Catalog
bool
has(Catalog $catalog)

Проверяет, имеется ли раздел в итераторе

from Catalog
static string
SlashedNames($catalog, $index, $first, $last, $total)

Cтандартный фильтр для метода implode. Исключает корневой раздел.

from Catalog
static bool
RootExcludeFilter($catalog)

Cтандартный фильтр для метода implode. Исключает корневой раздел.

from Catalog

Details

at line 26
void __construct($parent = null)

Конструктор

Parameters

$parent

Return Value

void

in Catalog at line 121
__toString()

in DbObject 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

in DbObject 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

in DbObject at line 125
setItemCountPerPage($itemCountPerPage = null)

Parameters

$itemCountPerPage

in DbObject at line 131
setCurrentPageNumber($pageNumber)

Parameters

$pageNumber

in DbObject 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 Catalog at line 92
string implode(mixed $element = '\\Cetera\\Iterator\\Catalog\\Catalog::SlashedNames', string $filter = '\\Cetera\\Iterator\\Catalog\\Catalog::RootExcludeFilter')

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

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

in DbObject at line 42
__clone()

at line 43
fetchElements()

in DbObject at line 87
getQuery()

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

Parameters

$key
$value
$type

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

Parameters

array $params
array $types

in DbObject at line 158
select($select = null)

Parameters

$select

in DynamicObject at line 143
where($where, $combination = 'AND')

Parameters

$where
$combination

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

Parameters

$order
$sort
$add

in DbObject at line 193
groupBy($groupBy, $add = true)

Parameters

$groupBy
$add

in DynamicObject at line 68
join($fieldName, $direct)

Parameters

$fieldName
$direct

in DynamicObject at line 94
joinReverse($od, $fieldName, $direct)

Parameters

$od
$fieldName
$direct

in DynamicObject at line 129
filterInclude($fieldName, $condition, $combination = 'AND')

Parameters

$fieldName
$condition
$combination

in DynamicObject at line 136
filterExclude($fieldName, $condition, $combination = 'AND')

Parameters

$fieldName
$condition
$combination

in DynamicObject at line 160
getObjectDefinition()

in Catalog at line 66
bool hasChildren()

Имеет ли текущий раздел дочерние разделы

Return Value

bool

in Catalog at line 77
Catalog_Iterator getChildren()

Возвращает дочерние разделы текущего раздела

Return Value

Catalog_Iterator

in Catalog at line 104
bool has(Catalog $catalog)

Проверяет, имеется ли раздел в итераторе

Parameters

Catalog $catalog раздел для проверки

Return Value

bool

in Catalog at line 132
static string SlashedNames($catalog, $index, $first, $last, $total)

Cтандартный фильтр для метода implode. Исключает корневой раздел.

Parameters

$catalog
$index
$first
$last
$total

Return Value

string

See also

implode

in Catalog at line 143
static bool RootExcludeFilter($catalog)

Cтандартный фильтр для метода implode. Исключает корневой раздел.

Parameters

$catalog

Return Value

bool

See also

implode