Инициализация Каталога
MyCatalog
MyCatalog
([array $arrConfigParametrs = ""])
-
array
$arrConfigParametrs: массив дополнительных настроек
Создать таблицу для хранения свойств текущей категории и её подкатегорий
void
AddCategoriesPropertiesTables
()
Добавить новую категорию
integer
AddCategory
([string $name = ''], boolean $isNewLevel, boolean $isHidden, boolean $isSearch, integer $ncID)
-
string
$name: Наименование категории
-
boolean
$isNewLevel: Флаг подкатегории текущеу категории
-
boolean
$isHidden: Флаг скрытой ктаегории
-
boolean
$isSearch: Флаг категории поиска
-
integer
$ncID: Идентификатор создаваемой категории
Добавить новый тип данных
integer
AddDataType
(string $name, string $storage, string $code, [string $extra = ""])
-
string
$name: название типа данных
-
string
$storage: название таблицы или идентификатор категории, в которой будет храниться тип данных
-
string
$code: код типа данных
-
string
$extra: дополнительные сведения
Добавить новый элемент
integer
AddItem
([string $name = ""], integer $iID)
-
string
$name: Наименование элемента
-
integer
$iID: Идентификатор элемента
Создать таблицу для хранения элементов текущей категории и её подкатегорий
void
AddItemsPropertiesTables
()
Создать таблиц для хранения свойств текущей категории и её подкатегорий
и таблицы для хранения элементов данных категорий
void
AddPropertiesTables
()
Добавить новое свойство категории/элеменета
integer
AddPropertyType
(string $name, integer $dtypeID, [integer $inherit = 1], integer $item, integer $system, integer $required, integer $multiple, integer $separate, [string $default = ''], [string $condition = ''], string $extended, [string $comment = ''], [string $group = ''], [array $options = ''])
-
string
$name: название свойства
-
integer
$dtypeID: идентификатор тип данных свойства
-
integer
$inherit: флаг наследования свойства
-
integer
$item: флаг свойства элемента
-
integer
$system: флаг служебного свойства
-
integer
$required: флаг обязательного значения свойства
-
integer
$multiple: флаг не уникального значения свойства (свойство может иметь несколько значений)
-
integer
$separate: флаг разделяемого свойства
-
string
$default: значение свойства по умолчанию
-
string
$condition: условия проверки REGEXP
-
string
$extended: флаг расширенного свойства
-
string
$comment: комментарий свойства
-
string
$group: наименование группы свойства
-
array
$options: массив дополнительных параметров свойства
Очищает закешированные свойства категорий
void
ClearCategoriesPropertiesCache
()
Закрывает (удаляет) соединение
bool
CloseConnection
(integer $connectionID)
-
integer
$connectionID: ID соединения
Скопировать категорию
array
CopyCategory
(integer $new_cID, boolean $bMove)
-
integer
$new_cID: идентификатор новой категории предка
-
boolean
$bMove: флаг перемещения категории
Скопировать элемент
array
CopyItem
([integer $new_cID = ""], boolean $bMove)
-
integer
$new_cID: идентификатор новой категории предка
-
boolean
$bMove: флаг перемещения элемента
Возвращает кол-во элементов текущей категории
integer
CountItems
(boolean $bWithSubCtgrs)
-
boolean
$bWithSubCtgrs: включая подкатегории (0 - только в текущей категории, 1 - включая подкатегории текущей категории)
Создает новое соединение и возвращает его ID
integer
CreateConnection
([boolean $bSetActive = 1])
-
boolean
$bSetActive: сделать новое соединение активным
Создать необходимые таблицы, категории
void
CreateDataStorage
()
Установить/получить текущую категорию
integer
CurrentCategory
([integer $cID = "get"])
-
integer
$cID: идентификатор категории
Установить/получить текущую элемент
integer
CurrentItem
([integer $iID = "get"], [integer $bChangeCategory = 1])
-
integer
$iID: идентификатор элемента
-
integer
$bChangeCategory: изменять категорию, которой принадлежит данный элемент
Удалить таблицу для хранения элементов текущей категории и её подкатегорий
void
DelCategoriesPropertiesTables
()
Удалить текущую категорию
integer
DelCategory
()
Удалить тип данных
void
DelDataType
(integer $dtypeID)
-
integer
$dtypeID: идентификатор типа данных
Удалить текущий элемент
boolean
DelItem
()
Удалить таблицу для хранения свойств текущей категории и её подкатегорий
void
DelItemsPropertiesTables
()
Удалить таблицу, в которых хранятся свойства текущей категории(включая подкатегории),
и таблицу, в которой храняться элементы данных категорий
void
DelPropertiesTables
()
Удалить тип свойства
boolean
DelPropertyType
(integer $ptypeID)
-
integer
$ptypeID: идентификатор типа свойства
Получить массив закешированных для текущего соединения категорий
array
GetCachedCategories
()
Получить массив закешированных для текущего соединения элементов
array
GetCachedItems
()
Сделать выборку категорий
array
GetCategories
([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
-
integer
$type: тип выборки
- - выбрать категории текущего уровня
- - выбрать все подкатегории текущей категории (включая текущую категорию)
- - выбрать все категории и подкатегории, начиная с корневой
-
integer
$getPrps: тип выборки свойств категорий
- - массив категорий со всеми свойствами
- - массив идентификаторов категорий
- - массив категорий с ограниченным набором свойств, заданным в $ptypeNames
-
string
$ptypeNames: строка наименований типов свойств, разделённая запятыми
-
boolean
$bExtractMultipleValues: флаг извлечения многозначных свойств (замедляет работу)
-
boolean
$bCntItems: флаг подсчёта элементов категорий
Получить условие для выборки категорий
string
GetCategoriesFilter
()
Сделать выборку категорий
array
GetCategories__
([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
-
integer
$type: тип выборки
- - выбрать категории текущего уровня
- - выбрать все подкатегории текущей категории (включая текущую категорию)
- - выбрать все категории и подкатегории, начиная с корневой
-
integer
$getPrps: тип выборки свойств элементов
- - массив элементов со всеми свойствами
- - массив идентификаторов элементов
- - массив элементов с ограниченным набором свойств, заданным в $ptypeNames
-
string
$ptypeNames: строка наименований типов свойств, разделённая запятыми
-
boolean
$bExtractMultipleValues: флаг извлечения многозначных свойств (замедляет работу)
-
boolean
$bCntItems: флаг подсчёта элементов категорий
Получить текущую категорию с полным перечнем её свойств
array
GetCategory
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
Возвращает идентификатор категории по значению левого идентификатора
integer
GetCategoryID
(integer $lft)
-
integer
$lft: значение левого идентификатора
Получить текущую категорию с кратким перечнем её свойств
array
GetCategoryLight
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
Получить полный перечень свойств категории
array
GetCategoryProperties
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
Получить краткий перечень свойств категории
array
GetCategoryPropertiesLight
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
Получить значение дополнительного свойства текущей категории
mixed
GetCategoryProperty
(string $name)
-
string
$name: наименование свойства
Получить полный перечнь типов свойств текущей категории
array
GetCategoryPropertyTypes
(integer $getPrps)
-
integer
$getPrps: тип извлекаемых параметров типа свойств
- - извлечь все параметры типа свойств
- - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
- - извлечь массив идентификаторов типов свойств
Получить краткий перечнь типов свойств текущей категории
array
GetCategoryPropertyTypesLight
(integer $getPrps)
-
integer
$getPrps: тип извлекаемых параметров типа свойств
- - извлечь все параметры типа свойств
- - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
- - извлечь массив идентификаторов типов свойств
Возвращает уровень текущей категории
integer
GetCurrentLevel
()
Получить тип данных категорий/элеменетов по идентификатору
array
GetDataType
(integer $dtypeID)
-
integer
$dtypeID: идентификатор типа данных
Получить стандартные типы данных
void
GetDataTypes
()
Получить фильтр выборки
string
GetFilter
(bool $bItem)
-
bool
$bItem: флаг фильтра выборки элементов
Получить идентификатор первой подкатегории текущей категории
integer
GetFirstChild
()
Получить текущего элемент с полным перечнем его свойств
array
GetItem
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)
Получить текущего элемент с кратким перечнем его свойств
array
GetItemLight
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)
Получить порядковый номер текущего элемента
integer
GetItemPosition
()
Получить полный перечень свойств элемента
array
GetItemProperties
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств элементав виде ассоциативного массива
Получить краткий перечень свойств элемента
array
GetItemPropertiesLight
(boolean $bAssociative)
-
boolean
$bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)
Получить значение свойства текущего элемента
mixed
GetItemProperty
(string $name)
-
string
$name: наименование свойства
Получить дополнительное свойство текущего элемента
mixed
GetItemPropertyEx
(string $name)
-
string
$name: наименование свойства
Получить полный перечнь типов свойств элементов текущей категории
array
GetItemPropertyTypes
(integer $getPrps)
-
integer
$getPrps: тип извлекаемых параметров типа свойств
- - извлечь все параметры типа свойств
- - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
- - извлечь массив идентификаторов типов свойств
Получить краткий перечнь типов свойств элементов текущей категории
array
GetItemPropertyTypesLight
(integer $getPrps)
-
integer
$getPrps: тип извлекаемых параметров типа свойств
- - извлечь все параметры типа свойств
- - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
- - извлечь массив идентификаторов типов свойств
Сделать выборку элементов
array
GetItems
(integer $bWithSubCategories, integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues)
-
integer
$bWithSubCategories: флаг выборки элементов, включая подкатегории текущей ктаегории
-
integer
$getPrps: (не используется)
-
string
$ptypeNames: (не используется)
-
boolean
$bExtractMultipleValues: флаг извлечения многозначных свойств
Получить условие для выборки элементов
string
GetItemsFilter
()
Получить максимальное число выборки элементов категории
integer
GetItemsLimit
()
Получить максимальный сдвиг выборки элементов категории
integer
GetItemsOffset
()
Получить массив множества идентификаторов элементов доступных для выборки
array
GetItemsRange
()
Возвращает позицию последней подкатегории в каталоге для текущей категории
integer
GetMaxCategory
()
Возвращает идентификатор последней категории в каталоге
integer
GetMaxCategoryID
()
Возвращает позицию последнего элемента в текущей категории
integer
GetMaxItem
()
Вычисляет максимальную вложенность каталога
integer
GetMaxLevel
()
Возвращает позицию первого элемента в текущей категории
integer
GetMinItem
()
Получить идентификатор предка текущей категории
integer
GetParentCategory
()
Получить дополнительные свойства категории/элемента
array
GetProperties
(boolean $bItem, boolean $bAssociative, boolean $bLight)
-
boolean
$bItem: флаг свойств элемента
-
boolean
$bAssociative: флаг краткого формата вывода свойств (в виде ассоциативного массива)
-
boolean
$bLight: флаг краткого перечня вывода свойств (не включая расширенные свойства)
Получить значение дополнительного свойства категории/элемента
array
GetPropertyByName
(boolean $bItem, string $ptypeName, boolean $bExtented)
-
boolean
$bItem: флаг элемента
-
string
$ptypeName: наименование свойства
-
boolean
$bExtented: флаг расширенных параметров свойства
Вернуть массив значений множетсвенного свойства
array
GetPropertyMultipleValue
(integer $ptypeID, integer $ID)
-
integer
$ptypeID: Идентификатор типа свойства
-
integer
$ID: Идентификатор категории/элемента
Получить тип свойств категорий/элементов по идентификатору /**
array
GetPropertyType
(integer $ptypeID)
-
integer
$ptypeID: идентификатор типа свойства
Получить список групп свойств для текущей категории/элемента
array
GetPropertyTypeGroups
(boolean $bItem, boolean $bAssociative, [boolean $bExplode = 1])
-
boolean
$bItem: флаг типов свойств элементов текущей категории
-
boolean
$bAssociative: использовать в качестве ключей массива наименование типов свойств
-
boolean
$bExplode: разбивать группы свойств на погдруппы
Получить типы свойств для текущей категории/элемента
array
GetPropertyTypes
(boolean $bItem, integer $getPrps, boolean $bLight)
-
boolean
$bItem: флаг типов свойств элементов текущей категории
-
integer
$getPrps: тип извлекаемых параметров типа свойств
- - извлечь все параметры типа свойств
- - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
- - извлечь массив идентификаторов типов свойств
-
boolean
$bLight: флаг краткого перечня типов свойств
Установить/получить текущую корневую категорию
integer
GetRootCategory
(integer 0)
-
integer
0: установливаемый идентификатор корневой категории
Проверяет содержит ли категория подкатегории
boolean
isCategoryContainsCategory
(int $cID_parent, int $cID_child)
-
int
$cID_parent: идентификатор родительской категории
-
int
$cID_child: идентификатор дочерней категории
Найти идентификатор категории по имени
integer
isCategoryExist
(string $name, [boolean $bAll = 1])
-
string
$name: Наименование категории
-
boolean
$bAll: Флаг поиска по всем категориям
Проверить является ли текущая категория листом
bool
isCategoryLeaf
()
Проверить существует ли тип свойства для текущей категории
integer
isCategoryPropertyTypeExist
(string $ptypeName)
-
string
$ptypeName: имя типа свойства
Проверить является ли текущая категория категорией поиска
bool
isCategorySearch
()
Проверить является ли текущая категория системной
bool
isCategorySystem
()
Проверить существует ли тип данных
integer
isDataTypeExist
(string $name, [mixed $extra = ''])
-
string
$name: имя типа данных
Найти идентификатор элемента по имени
integer
isItemExist
(string $name, boolean $bWithSubCategories)
-
string
$name: Наименование элемента
-
boolean
$bWithSubCategories: Флаг поиска по подкатегориям текущей категории
Проверить существует ли тип свойства для текущего элемента
integer
isItemPropertyTypeExist
(string $ptypeName)
-
string
$ptypeName: имя типа свойства
Проверить существует ли тип свойства для текущей категории/элемента
integer
isPropertyTypeExist
(boolean $bItem, string $ptypeName)
-
boolean
$bItem: флаг типа свойства элемента
-
string
$ptypeName: имя типа свойства
Загружает дерево категорий
void
LoadCategoriesTree
([boolean $bLoadTypes = 1])
-
boolean
$bLoadTypes: Загружать карты типов свойств
Получить все типы свойств категории/элементов
void
LoadDataTypes
()
Получить все типы свойств категории/элементов
void
LoadPropertiesTypes
()
Восстановить состояние модуля
void
LoadStatus
()
Изменить категорию
boolean
ModifyCategory
(array $properties)
-
array
$properties: массив новых свойств категории
Изменить элемент
boolean
ModifyItem
(array $properties, [integer $pos = null])
-
array
$properties: массив свойств элемента
-
integer
$pos: позиция элемента
Изменить тип свойства
boolean
ModifyPropertyType
(integer $ptypeID, string $name, integer $dtypeID, boolean $inherit, boolean $item, boolean $system, boolean $required, boolean $multiple, boolean $separate, string $default, string $condition, string $extended, string $comment, string $group, [array $options = ''])
-
integer
$ptypeID: идентификатор типа свойства
-
string
$name: название свойства
-
integer
$dtypeID: идентификатор типа данных свойства
-
boolean
$inherit: флаг наследования свойства
-
boolean
$item: флаг свойства элемента
-
boolean
$system: флаг служебного свойства
-
boolean
$required: флаг обязательного значения свойства
-
boolean
$multiple: флаг многозначности свойста
-
boolean
$separate: флаг разделяемого свойства
-
string
$default: значение по умолчанию
-
string
$condition: строка условия проверки REGEXP
-
string
$extended: флаг расширенного свойства
-
string
$comment: комментарий
-
string
$group: наименование группы свойства
-
array
$options: массив дополнительных параметров свойства
Переместить категорию
integer
MoveCategory
(integer $new_cID)
-
integer
$new_cID: идентификатор новой категории предка
Переместить элемент
array
MoveItem
([integer $new_cID = ""], mixed $bMove)
-
integer
$new_cID: идентификатор новой категории предка
Всплывать по категориям к корню
array
PopUp
(integer $cID)
-
integer
$cID: идентификатор категории
Экранировать свойства для записи в БД
void
PrepareProperties
(array &$properties)
-
array
&$properties: массив свойств
Экранировать значение свойства для записи в БД
void
PrepareProperty
(mixed &$value, integer $ptypeID)
-
mixed
&$value: значение свойства (строка/массив)
-
integer
$ptypeID: ptypeID
Очистить массив закешированных для текущего соединения элементов
void
ResetCachedItems
()
Сбросить фильтер выборки категорий
boolean
ResetCategoriesFilter
()
Сбрасывает все параметры указанного соединения
bool
ResetConnection
(integer $connectionID)
-
integer
$connectionID: ID соединения
Сбросить фильтер выборки
boolean
ResetFilter
(bool $bItem)
-
bool
$bItem: флаг фильтра выборки элементов
Сбросить фильтер выборки элементов
boolean
ResetItemsFilter
()
Сбрасывает фильтр сортировки для выборки элементов
void
ResetItemsSorting
()
Сбросить параметры статуса соединения
void
ResetStatusParams
(array &$status)
-
array
&$status: массив статуса соединения
Установить/получить текущую корневую категорию
integer
RootCategory
([integer $cID = "get"])
-
integer
$cID: идентификатор категории
Сохранить состояние модуля
void
SaveStatus
()
Устанавливает активное соединение
bool
SetActiveConnection
(integer $connectionID)
-
integer
$connectionID: ID соединения
Установить массив закешированных для текущего соединения категорий
void
SetCachedCategories
(mixed &$ctgrs)
Установить массив закешированных для текущего соединения элементов
void
SetCachedItems
(mixed &$items)
Установить фильтер выборки для категорий
boolean
SetCategoriesFilter
(string $ptypeName, string $value, [bool $bExact = 1], [string $condition = ""], [string $operand = ""])
-
string
$ptypeName: наименование типа свойства
-
string
$value: значение свойства
-
bool
$bExact: флаг точного совпадения значения свойства
-
string
$condition: условие отбора
-
string
$operand: операнд следующего условия отбора
Установить фильтер выборки для категорий/элементов
boolean
SetFilter
(boolean $bItem, string $ptypeName, string $value, [boolean $bExact = 1], [string $condition = ""], [string $operand = ""])
-
boolean
$bItem: флаг фильтра выборки элементов
-
string
$ptypeName: наименование типа свойства
-
string
$value: значение свойства
-
boolean
$bExact: флаг точного совпадения значения свойства
-
string
$condition: условие отбора
-
string
$operand: операнд следующего условия отбора (И,ИЛИ)
Установить фильтр выборки для элементов
boolean
SetItemsFilter
(string $ptypeName, string $value, [boolean $bExact = 1], [string $condition = ""], [string $operand = ""])
-
string
$ptypeName: наименование типа свойства
-
string
$value: значение свойства
-
boolean
$bExact: флаг точного совпадения значения свойства
-
string
$condition: условие отбора
-
string
$operand: операнд следующего условия
Установить максимальное число выборки элементов категории
integer
SetItemsLimit
(integer $new)
-
integer
$new: максимальное число выборки элементов категории
Установить максимальный сдвиг выборки элементов категории
integer
SetItemsOffset
(bool $new)
-
bool
$new: максимальный сдвиг выборки элементов
Случайная сортировка эелментов
void
SetItemsRandomSorting
([bool $random = true])
-
bool
$random: установка флага случайной сортировки
Установить массив множества идентификаторов элементов доступных для выборки
boolean
SetItemsRange
([array $arr_iIDs = ''])
-
array
$arr_iIDs: массив идентификаторов элементов
Установить фильтры выборки для элементов категории поиска
void
SetItemsSearchFilter
()
Добавляет фильтр сортировки для выборки элементов
boolean
SetItemsSorting
([string $ptypeName = ''], [string $direction = ''])
-
string
$ptypeName: Имя типа свойства
-
string
$direction: Направление сортировки (DESC, ASC)
Установить массив значений множетсвенного свойства
boolean
SetPropertyMultipleValue
(integer $ptypeID, integer $ID, array $value)
-
integer
$ptypeID: Идентификатор типа свойства
-
integer
$ID: Идентификатор категории/элемента
-
array
$value: Массив значений свойства
Передвинуть категорию вверх/вниз по списку
boolean
ShiftCategory
(integer $bDirectionUp)
-
integer
$bDirectionUp: флаг направления перемещения ( 0 - вниз, 1 - вверх)
Перемесить товар вверх/вниз по списку
boolean
ShiftItem
(integer $bDirectionUp)
-
integer
$bDirectionUp: направление перемещения (1 - перемещение вверх,0 - перемещение вверх)
Сдвиг типа свойств
void
ShiftPropertyType
(integer $ptypeID, [integer $bDirectionUp = 1])
-
integer
$ptypeID: идентификатор типа свойств
-
integer
$bDirectionUp: направление сдвика (0 - вниз, 1 - вверх)
Показывать скрытые категории
boolean
ShowHiddenCategories
([boolean $bAction = 'GET'])
-
boolean
$bAction: устанавливаемый флаг (1 - показывать,0 - не показывать)
Показывать системные свойства
boolean
ShowSystemProperties
([boolean $bAction = 'GET'])
-
boolean
$bAction: устанавливаемый флаг (1 - показывать,0 - не показывать)
Обновить параметры статусов всех действующих соединений
void
UpdateAllConnections
()
Добавляет/обновляет тип свойства в массиве из базы
void
UpdatePType
(object объекта &$db, integer $ptypeID)
-
object объекта
&$db: класса доступа к базе данных
-
integer
$ptypeID: ID типа свойств