Class MyCatalog

Description

Класс обстрактного доступа к мета-структуре данных типа Каталог.

Located in /itweb/lib/class.mycatalog.php (line 18)


	
			
Variable Summary
 integer $cID
 integer $cID_lft
 integer $cID_parent
 integer $cID_rgt
 integer $cID_root
 integer $connectionCnt
 array $connections
 array $ctgFilter
 array $ctgrs
 string $dbType
 array $dtypes
 integer $idLength
 integer $iID
 array $items
 integer $itemsLimit
 integer $itemsOffset
 array $itemsRange
 array $itmFilter
 array $ptypes
 array $sortby
 array $sortby_def
 array $status
 string $tbCategories
 string $tbCtgPrps
 string $tbDTypes
 string $tbItmPrps
 string $tblPrefix
 string $tbPTypes
Method Summary
 MyCatalog MyCatalog ([array $arrConfigParametrs = ""])
 integer AddCategory ([string $name = ''], boolean $isNewLevel, boolean $isHidden, boolean $isSearch, integer $ncID)
 integer AddDataType (string $name, string $storage, string $code, [string $extra = ""])
 integer AddItem ([string $name = ""], integer $iID)
 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 = ''])
 bool CloseConnection (integer $connectionID)
 array CopyCategory (integer $new_cID, boolean $bMove)
 array CopyItem ([integer $new_cID = ""], boolean $bMove)
 integer CountItems (boolean $bWithSubCtgrs)
 integer CreateConnection ([boolean $bSetActive = 1])
 integer CurrentCategory ([integer $cID = "get"])
 integer CurrentItem ([integer $iID = "get"], [integer $bChangeCategory = 1])
 integer DelCategory ()
 void DelDataType (integer $dtypeID)
 boolean DelItem ()
 boolean DelPropertyType (integer $ptypeID)
 array GetCachedItems ()
 array GetCategories ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
 array GetCategories__ ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
 array GetCategory (boolean $bAssociative)
 integer GetCategoryID (integer $lft)
 array GetCategoryLight (boolean $bAssociative)
 array GetCategoryProperties (boolean $bAssociative)
 array GetCategoryPropertiesLight (boolean $bAssociative)
 mixed GetCategoryProperty (string $name)
 array GetCategoryPropertyTypes (integer $getPrps)
 array GetCategoryPropertyTypesLight (integer $getPrps)
 integer GetCurrentLevel ()
 array GetDataType (integer $dtypeID)
 void GetDataTypes ()
 string GetFilter (bool $bItem)
 integer GetFirstChild ()
 array GetItem (boolean $bAssociative)
 array GetItemLight (boolean $bAssociative)
 integer GetItemPosition ()
 array GetItemProperties (boolean $bAssociative)
 array GetItemPropertiesLight (boolean $bAssociative)
 mixed GetItemProperty (string $name)
 mixed GetItemPropertyEx (string $name)
 array GetItemPropertyTypes (integer $getPrps)
 array GetItemPropertyTypesLight (integer $getPrps)
 array GetItems (integer $bWithSubCategories, integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues)
 string GetItemsFilter ()
 integer GetItemsLimit ()
 integer GetItemsOffset ()
 array GetItemsRange ()
 void GetItemsSorting ()
 integer GetMaxCategory ()
 integer GetMaxCategoryID ()
 integer GetMaxItem ()
 integer GetMaxLevel ()
 integer GetMinItem ()
 integer GetParentCategory ()
 array GetProperties (boolean $bItem, boolean $bAssociative, boolean $bLight)
 array GetPropertyByName (boolean $bItem, string $ptypeName, boolean $bExtented)
 array GetPropertyMultipleValue (integer $ptypeID, integer $ID)
 array GetPropertyType (integer $ptypeID)
 array GetPropertyTypeGroups (boolean $bItem, boolean $bAssociative, [boolean $bExplode = 1])
 array GetPropertyTypes (boolean $bItem, integer $getPrps, boolean $bLight)
 integer GetRootCategory (integer 0)
 boolean isCategoryContainsCategory (int $cID_parent, int $cID_child)
 integer isCategoryExist (string $name, [boolean $bAll = 1])
 bool isCategoryLeaf ()
 integer isCategoryPropertyTypeExist (string $ptypeName)
 integer isDataTypeExist (string $name, [mixed $extra = ''])
 integer isItemExist (string $name, boolean $bWithSubCategories)
 integer isItemPropertyTypeExist (string $ptypeName)
 integer isPropertyTypeExist (boolean $bItem, string $ptypeName)
 void LoadCategoriesTree ([boolean $bLoadTypes = 1])
 void LoadDataTypes ()
 void LoadStatus ()
 boolean ModifyCategory (array $properties)
 boolean ModifyItem (array $properties, [integer $pos = null])
 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 MoveCategory (integer $new_cID)
 array MoveItem ([integer $new_cID = ""], mixed $bMove)
 array PopUp (integer $cID)
 void PrepareProperties (array &$properties)
 void PrepareProperty (mixed &$value, integer $ptypeID)
 bool ResetConnection (integer $connectionID)
 boolean ResetFilter (bool $bItem)
 boolean ResetItemsFilter ()
 void ResetStatusParams (array &$status)
 integer RootCategory ([integer $cID = "get"])
 void SaveStatus ()
 bool SetActiveConnection (integer $connectionID)
 void SetCachedCategories (mixed &$ctgrs)
 void SetCachedItems (mixed &$items)
 boolean SetCategoriesFilter (string $ptypeName, string $value, [bool $bExact = 1], [string $condition = ""], [string $operand = ""])
 boolean SetFilter (boolean $bItem, string $ptypeName, string $value, [boolean $bExact = 1], [string $condition = ""], [string $operand = ""])
 boolean SetItemsFilter (string $ptypeName, string $value, [boolean $bExact = 1], [string $condition = ""], [string $operand = ""])
 integer SetItemsLimit (integer $new)
 integer SetItemsOffset (bool $new)
 void SetItemsRandomSorting ([bool $random = true])
 boolean SetItemsRange ([array $arr_iIDs = ''])
 boolean SetItemsSorting ([string $ptypeName = ''], [string $direction = ''])
 boolean SetPropertyMultipleValue (integer $ptypeID, integer $ID, array $value)
 boolean ShiftCategory (integer $bDirectionUp)
 boolean ShiftItem (integer $bDirectionUp)
 void ShiftPropertyType (integer $ptypeID, [integer $bDirectionUp = 1])
 boolean ShowHiddenCategories ([boolean $bAction = 'GET'])
 boolean ShowSystemProperties ([boolean $bAction = 'GET'])
 void UpdatePType (object объекта &$db, integer $ptypeID)
Variables
integer $activeConnectionID = -1 (line 226)

Идентификатор текущего соединения

integer $cID = 0 (line 110)

Текущая категория

integer $cID_lft = 1 (line 116)

Левый идентификтор текущей категории

integer $cID_parent = null (line 128)

Идентификтор предка текущей категории

integer $cID_rgt = 2 (line 122)

Правый идентификтор текущей категории

integer $cID_root = 0 (line 104)

Корневая категория каталога

integer $connectionCnt = -1 (line 220)

Количество соединения

array $connections = array() (line 214)

Массив соединений

array $ctgFilter = null (line 159)

Фильтр выборки категорий

array $ctgPTypesMap = array() (line 91)

Карта соотвествия типов данных категорий идентификаторам категорий

array $ctgrs = array() (line 73)

Массив категорий

string $dbType (line 25)

Тип используемой базы данных

array $dtypes = null (line 85)

Массив типов данных

integer $idLength = 11 (line 67)

Длина индексов в таблицах

integer $iID = 0 (line 134)

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

array $items = array() (line 207)

Массив элементов

integer $itemsLimit = 0 (line 177)

Максимальное количество элементов в выборке

integer $itemsOffset = 0 (line 171)

Порядковый номер смещения при выборке элементов

bool $itemsRandom = false (line 153)

Флаг случайной сортировки элементов

array $itemsRange = "" (line 183)

Множество идентификаторов элементов доступных для выборки

array $itmFilter = null (line 165)

Фильтр выборки элементов

array $itmPTypesMap = array() (line 97)

Карта соотвествия типов данных элементов идентификаторам категорий

array $ptypes = null (line 79)

Массив типов свойств категорий/элементов

bool $showHiddenCategories = 0 (line 189)

Показывать скрытые категории

bool $showSystemProperties = 0 (line 195)

Показывать системные свойства

array $sortby = array() (line 147)

Массив установок для сортировки

array $sortby_def = array() (line 141)

Массив установок по умолчанию для сортировки

array $status = array() (line 201)

Стэк состояний каталога

string $tbCategories (line 37)

Таблица категорий каталога

string $tbCtgPrps (line 43)

Таблица свойств категорий каталога

string $tbDTypes (line 55)

Таблица типов данных

string $tbItmPrps (line 49)

Таблица свойств элементов каталога

string $tblPrefix = 'itw_' (line 31)

Префикс таблиц базы данных

string $tbPTypes (line 61)

Таблица типов свойств категорий и элементов

Methods
Constructor MyCatalog (line 235)

Инициализация Каталога

MyCatalog MyCatalog ([array $arrConfigParametrs = ""])
  • array $arrConfigParametrs: массив дополнительных настроек
AddCategoriesPropertiesTables (line 627)

Создать таблицу для хранения свойств текущей категории и её подкатегорий

void AddCategoriesPropertiesTables ()
AddCategory (line 801)

Добавить новую категорию

  • return: Идентификатор новой категории
integer AddCategory ([string $name = ''], boolean $isNewLevel, boolean $isHidden, boolean $isSearch, integer $ncID)
  • string $name: Наименование категории
  • boolean $isNewLevel: Флаг подкатегории текущеу категории
  • boolean $isHidden: Флаг скрытой ктаегории
  • boolean $isSearch: Флаг категории поиска
  • integer $ncID: Идентификатор создаваемой категории
AddDataType (line 3665)

Добавить новый тип данных

  • return: идентификатор нового типа данных
integer AddDataType (string $name, string $storage, string $code, [string $extra = ""])
  • string $name: название типа данных
  • string $storage: название таблицы или идентификатор категории, в которой будет храниться тип данных
  • string $code: код типа данных
  • string $extra: дополнительные сведения
AddItem (line 2051)

Добавить новый элемент

  • return: Идентификатор элемента
integer AddItem ([string $name = ""], integer $iID)
  • string $name: Наименование элемента
  • integer $iID: Идентификатор элемента
AddItemsPropertiesTables (line 649)

Создать таблицу для хранения элементов текущей категории и её подкатегорий

void AddItemsPropertiesTables ()
AddPropertiesTables (line 617)

Создать таблиц для хранения свойств текущей категории и её подкатегорий

и таблицы для хранения элементов данных категорий

void AddPropertiesTables ()
AddPropertyType (line 3086)

Добавить новое свойство категории/элеменета

  • return: идентификатор свойства
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: массив дополнительных параметров свойства
ClearCategoriesPropertiesCache (line 4212)

Очищает закешированные свойства категорий

void ClearCategoriesPropertiesCache ()
CloseConnection (line 402)

Закрывает (удаляет) соединение

bool CloseConnection (integer $connectionID)
  • integer $connectionID: ID соединения
CopyCategory (line 1249)

Скопировать категорию

  • return: массив идентификаторов скопированных категорий
array CopyCategory (integer $new_cID, boolean $bMove)
  • integer $new_cID: идентификатор новой категории предка
  • boolean $bMove: флаг перемещения категории
CopyItem (line 2593)

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

  • return: массив идентификаторов скопированных категорий
array CopyItem ([integer $new_cID = ""], boolean $bMove)
  • integer $new_cID: идентификатор новой категории предка
  • boolean $bMove: флаг перемещения элемента
CountItems (line 1849)

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

  • return: кол-во элементов текущей категории
integer CountItems (boolean $bWithSubCtgrs)
  • boolean $bWithSubCtgrs: включая подкатегории (0 - только в текущей категории, 1 - включая подкатегории текущей категории)
CreateConnection (line 284)

Создает новое соединение и возвращает его ID

  • return: ID нового соединения
integer CreateConnection ([boolean $bSetActive = 1])
  • boolean $bSetActive: сделать новое соединение активным
CreateDataStorage (line 528)

Создать необходимые таблицы, категории

void CreateDataStorage ()
CurrentCategory (line 1398)

Установить/получить текущую категорию

  • return: идентификатор категории или FALSE в случае неудачи
integer CurrentCategory ([integer $cID = "get"])
  • integer $cID: идентификатор категории
CurrentItem (line 2240)

Установить/получить текущую элемент

  • return: идентификатор элемента или FALSE в случае неудачи
integer CurrentItem ([integer $iID = "get"], [integer $bChangeCategory = 1])
  • integer $iID: идентификатор элемента
  • integer $bChangeCategory: изменять категорию, которой принадлежит данный элемент
DelCategoriesPropertiesTables (line 710)

Удалить таблицу для хранения элементов текущей категории и её подкатегорий

void DelCategoriesPropertiesTables ()
DelCategory (line 1004)

Удалить текущую категорию

  • return: Идентификатор новой категории
integer DelCategory ()
DelDataType (line 3697)

Удалить тип данных

void DelDataType (integer $dtypeID)
  • integer $dtypeID: идентификатор типа данных
DelItem (line 2099)

Удалить текущий элемент

  • return: результат операции удаления
boolean DelItem ()
DelItemsPropertiesTables (line 723)

Удалить таблицу для хранения свойств текущей категории и её подкатегорий

void DelItemsPropertiesTables ()
DelPropertiesTables (line 698)

Удалить таблицу, в которых хранятся свойства текущей категории(включая подкатегории),

и таблицу, в которой храняться элементы данных категорий

void DelPropertiesTables ()
DelPropertyType (line 3325)

Удалить тип свойства

  • return: результат выполнения операции
boolean DelPropertyType (integer $ptypeID)
  • integer $ptypeID: идентификатор типа свойства
GetCachedCategories (line 4556)

Получить массив закешированных для текущего соединения категорий

  • return: массив закешированных для текущего соединения категорий
array GetCachedCategories ()
GetCachedItems (line 4576)

Получить массив закешированных для текущего соединения элементов

  • return: массив закешированных для текущего соединения элементов
array GetCachedItems ()
GetCategories (line 1712)

Сделать выборку категорий

  • return: массив идентификаторов выбранных категорий
array GetCategories ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
  • integer $type: тип выборки
    1. - выбрать категории текущего уровня
    2. - выбрать все подкатегории текущей категории (включая текущую категорию)
    3. - выбрать все категории и подкатегории, начиная с корневой
  • integer $getPrps: тип выборки свойств категорий
    1. - массив категорий со всеми свойствами
    2. - массив идентификаторов категорий
    3. - массив категорий с ограниченным набором свойств, заданным в $ptypeNames
  • string $ptypeNames: строка наименований типов свойств, разделённая запятыми
  • boolean $bExtractMultipleValues: флаг извлечения многозначных свойств (замедляет работу)
  • boolean $bCntItems: флаг подсчёта элементов категорий
GetCategoriesFilter (line 2036)

Получить условие для выборки категорий

  • return: фильр категорий
string GetCategoriesFilter ()
GetCategories__ (line 1550)

Сделать выборку категорий

  • return: массив идентификаторов выбранных элементов
array GetCategories__ ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
  • integer $type: тип выборки
    1. - выбрать категории текущего уровня
    2. - выбрать все подкатегории текущей категории (включая текущую категорию)
    3. - выбрать все категории и подкатегории, начиная с корневой
  • integer $getPrps: тип выборки свойств элементов
    1. - массив элементов со всеми свойствами
    2. - массив идентификаторов элементов
    3. - массив элементов с ограниченным набором свойств, заданным в $ptypeNames
  • string $ptypeNames: строка наименований типов свойств, разделённая запятыми
  • boolean $bExtractMultipleValues: флаг извлечения многозначных свойств (замедляет работу)
  • boolean $bCntItems: флаг подсчёта элементов категорий
GetCategory (line 1455)

Получить текущую категорию с полным перечнем её свойств

  • return: массив свойств категории
array GetCategory (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
GetCategoryID (line 3849)

Возвращает идентификатор категории по значению левого идентификатора

  • return: идентификатора категории
integer GetCategoryID (integer $lft)
  • integer $lft: значение левого идентификатора
GetCategoryLight (line 1472)

Получить текущую категорию с кратким перечнем её свойств

  • return: массив свойств категории (краткий)
array GetCategoryLight (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
GetCategoryProperties (line 1951)

Получить полный перечень свойств категории

  • return: массив свойств категории
array GetCategoryProperties (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
GetCategoryPropertiesLight (line 1965)

Получить краткий перечень свойств категории

  • return: массив свойств категории (краткий)
array GetCategoryPropertiesLight (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)
GetCategoryProperty (line 1979)

Получить значение дополнительного свойства текущей категории

  • return: значение дополнительного свойства текущей категории
mixed GetCategoryProperty (string $name)
  • string $name: наименование свойства
GetCategoryPropertyTypes (line 3597)

Получить полный перечнь типов свойств текущей категории

array GetCategoryPropertyTypes (integer $getPrps)
  • integer $getPrps: тип извлекаемых параметров типа свойств
    1. - извлечь все параметры типа свойств
    2. - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
    3. - извлечь массив идентификаторов типов свойств
GetCategoryPropertyTypesLight (line 3614)

Получить краткий перечнь типов свойств текущей категории

array GetCategoryPropertyTypesLight (integer $getPrps)
  • integer $getPrps: тип извлекаемых параметров типа свойств
    1. - извлечь все параметры типа свойств
    2. - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
    3. - извлечь массив идентификаторов типов свойств
GetCurrentLevel (line 3815)

Возвращает уровень текущей категории

  • return: уровень категории
integer GetCurrentLevel ()
GetDataType (line 3728)

Получить тип данных категорий/элеменетов по идентификатору

  • return: массив свойств типа данных
array GetDataType (integer $dtypeID)
  • integer $dtypeID: идентификатор типа данных
GetDataTypes (line 485)

Получить стандартные типы данных

void GetDataTypes ()
GetFilter (line 4474)

Получить фильтр выборки

  • return: условие для выборки
string GetFilter (bool $bItem)
  • bool $bItem: флаг фильтра выборки элементов
GetFirstChild (line 1914)

Получить идентификатор первой подкатегории текущей категории

  • return: идентификатор первой подкатегории текущей категории
integer GetFirstChild ()
GetItem (line 2349)

Получить текущего элемент с полным перечнем его свойств

  • return: массив элемент с полным перечнем его свойств
array GetItem (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)
GetItemLight (line 2376)

Получить текущего элемент с кратким перечнем его свойств

  • return: массив элемент с полным перечнем его свойств
array GetItemLight (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)
GetItemPosition (line 2751)

Получить порядковый номер текущего элемента

integer GetItemPosition ()
GetItemProperties (line 2293)

Получить полный перечень свойств элемента

  • return: массив свойств элемента
array GetItemProperties (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств элементав виде ассоциативного массива
GetItemPropertiesLight (line 2307)

Получить краткий перечень свойств элемента

  • return: массив свойств элемента (краткий)
array GetItemPropertiesLight (boolean $bAssociative)
  • boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)
GetItemProperty (line 2321)

Получить значение свойства текущего элемента

  • return: значение свойства текущего элемента
mixed GetItemProperty (string $name)
  • string $name: наименование свойства
GetItemPropertyEx (line 2335)

Получить дополнительное свойство текущего элемента

  • return: значение дополнительного свойства текущего элемента
mixed GetItemPropertyEx (string $name)
  • string $name: наименование свойства
GetItemPropertyTypes (line 3631)

Получить полный перечнь типов свойств элементов текущей категории

array GetItemPropertyTypes (integer $getPrps)
  • integer $getPrps: тип извлекаемых параметров типа свойств
    1. - извлечь все параметры типа свойств
    2. - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
    3. - извлечь массив идентификаторов типов свойств
GetItemPropertyTypesLight (line 3648)

Получить краткий перечнь типов свойств элементов текущей категории

array GetItemPropertyTypesLight (integer $getPrps)
  • integer $getPrps: тип извлекаемых параметров типа свойств
    1. - извлечь все параметры типа свойств
    2. - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
    3. - извлечь массив идентификаторов типов свойств
GetItems (line 2480)

Сделать выборку элементов

  • return: массив идентификаторов выбранных элементов
array GetItems (integer $bWithSubCategories, integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues)
  • integer $bWithSubCategories: флаг выборки элементов, включая подкатегории текущей ктаегории
  • integer $getPrps: (не используется)
  • string $ptypeNames: (не используется)
  • boolean $bExtractMultipleValues: флаг извлечения многозначных свойств
GetItemsFilter (line 2739)

Получить условие для выборки элементов

  • return: фильтр выборки элементов
string GetItemsFilter ()
GetItemsLimit (line 4337)

Получить максимальное число выборки элементов категории

  • return: максимальное число выборки элементов категории
integer GetItemsLimit ()
GetItemsOffset (line 4363)

Получить максимальный сдвиг выборки элементов категории

  • return: максимальный сдвиг выборки элементов
integer GetItemsOffset ()
GetItemsRange (line 4296)

Получить массив множества идентификаторов элементов доступных для выборки

  • return: массив множества идентификаторов элементов доступных для выборки
array GetItemsRange ()
GetItemsSorting (line 2442)
void GetItemsSorting ()
GetMaxCategory (line 3865)

Возвращает позицию последней подкатегории в каталоге для текущей категории

  • return: правый идентификатор категории
integer GetMaxCategory ()
GetMaxCategoryID (line 3881)

Возвращает идентификатор последней категории в каталоге

  • return: идентификатор последней категории в каталоге
integer GetMaxCategoryID ()
GetMaxItem (line 3916)

Возвращает позицию последнего элемента в текущей категории

  • return: позиция последнего элемента в текущей категории
integer GetMaxItem ()
GetMaxLevel (line 3830)

Вычисляет максимальную вложенность каталога

  • return: уровень максимальной вложенности каталога
integer GetMaxLevel ()
GetMinItem (line 3898)

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

  • return: позиция первого элемента в текущей категории
integer GetMinItem ()
GetParentCategory (line 1937)

Получить идентификатор предка текущей категории

  • return: идентификатор предка текущей категории
integer GetParentCategory ()
GetProperties (line 2770)

Получить дополнительные свойства категории/элемента

  • return: массив свойств
array GetProperties (boolean $bItem, boolean $bAssociative, boolean $bLight)
  • boolean $bItem: флаг свойств элемента
  • boolean $bAssociative: флаг краткого формата вывода свойств (в виде ассоциативного массива)
  • boolean $bLight: флаг краткого перечня вывода свойств (не включая расширенные свойства)
GetPropertyByName (line 2902)

Получить значение дополнительного свойства категории/элемента

array GetPropertyByName (boolean $bItem, string $ptypeName, boolean $bExtented)
  • boolean $bItem: флаг элемента
  • string $ptypeName: наименование свойства
  • boolean $bExtented: флаг расширенных параметров свойства
GetPropertyMultipleValue (line 2973)

Вернуть массив значений множетсвенного свойства

  • return: значение множественного свойства
array GetPropertyMultipleValue (integer $ptypeID, integer $ID)
  • integer $ptypeID: Идентификатор типа свойства
  • integer $ID: Идентификатор категории/элемента
GetPropertyType (line 3429)

Получить тип свойств категорий/элементов по идентификатору /**

  • return: массив свойст свойства
array GetPropertyType (integer $ptypeID)
  • integer $ptypeID: идентификатор типа свойства
GetPropertyTypeGroups (line 3516)

Получить список групп свойств для текущей категории/элемента

array GetPropertyTypeGroups (boolean $bItem, boolean $bAssociative, [boolean $bExplode = 1])
  • boolean $bItem: флаг типов свойств элементов текущей категории
  • boolean $bAssociative: использовать в качестве ключей массива наименование типов свойств
  • boolean $bExplode: разбивать группы свойств на погдруппы
GetPropertyTypes (line 3473)

Получить типы свойств для текущей категории/элемента

array GetPropertyTypes (boolean $bItem, integer $getPrps, boolean $bLight)
  • boolean $bItem: флаг типов свойств элементов текущей категории
  • integer $getPrps: тип извлекаемых параметров типа свойств
    1. - извлечь все параметры типа свойств
    2. - извлечь ассоциативный массив соотвествия наименований идентификаторам типов свойств
    3. - извлечь массив идентификаторов типов свойств
  • boolean $bLight: флаг краткого перечня типов свойств
GetRootCategory (line 769)

Установить/получить текущую корневую категорию

  • return: идентификатор установленной корневой категории
integer GetRootCategory (integer 0)
  • integer 0: установливаемый идентификатор корневой категории
isCategoryContainsCategory (line 3796)

Проверяет содержит ли категория подкатегории

  • return: результат выполнения операции
boolean isCategoryContainsCategory (int $cID_parent, int $cID_child)
  • int $cID_parent: идентификатор родительской категории
  • int $cID_child: идентификатор дочерней категории
isCategoryExist (line 3937)

Найти идентификатор категории по имени

  • return: Идентификатор категории или false
integer isCategoryExist (string $name, [boolean $bAll = 1])
  • string $name: Наименование категории
  • boolean $bAll: Флаг поиска по всем категориям
isCategoryLeaf (line 4069)

Проверить является ли текущая категория листом

bool isCategoryLeaf ()
isCategoryPropertyTypeExist (line 4136)

Проверить существует ли тип свойства для текущей категории

  • return: идентификатор типа свойства или false
integer isCategoryPropertyTypeExist (string $ptypeName)
  • string $ptypeName: имя типа свойства
isCategorySearch (line 4095)

Проверить является ли текущая категория категорией поиска

bool isCategorySearch ()
isCategorySystem (line 4080)

Проверить является ли текущая категория системной

bool isCategorySystem ()
isDataTypeExist (line 4164)

Проверить существует ли тип данных

  • return: идентификатор типа данных
integer isDataTypeExist (string $name, [mixed $extra = ''])
  • string $name: имя типа данных
isItemExist (line 4012)

Найти идентификатор элемента по имени

  • return: Идентификатор элемента или false
integer isItemExist (string $name, boolean $bWithSubCategories)
  • string $name: Наименование элемента
  • boolean $bWithSubCategories: Флаг поиска по подкатегориям текущей категории
isItemPropertyTypeExist (line 4150)

Проверить существует ли тип свойства для текущего элемента

  • return: идентификатор типа свойства или false
integer isItemPropertyTypeExist (string $ptypeName)
  • string $ptypeName: имя типа свойства
isPropertyTypeExist (line 4113)

Проверить существует ли тип свойства для текущей категории/элемента

  • return: идентификатор типа свойства или false
integer isPropertyTypeExist (boolean $bItem, string $ptypeName)
  • boolean $bItem: флаг типа свойства элемента
  • string $ptypeName: имя типа свойства
LoadCategoriesTree (line 424)

Загружает дерево категорий

void LoadCategoriesTree ([boolean $bLoadTypes = 1])
  • boolean $bLoadTypes: Загружать карты типов свойств
LoadDataTypes (line 469)

Получить все типы свойств категории/элементов

void LoadDataTypes ()
LoadPropertiesTypes (line 500)

Получить все типы свойств категории/элементов

void LoadPropertiesTypes ()
LoadStatus (line 4225)

Восстановить состояние модуля

void LoadStatus ()
ModifyCategory (line 1141)

Изменить категорию

  • return: Результат
boolean ModifyCategory (array $properties)
  • array $properties: массив новых свойств категории
ModifyItem (line 2132)

Изменить элемент

  • return: результат выполнения операции
boolean ModifyItem (array $properties, [integer $pos = null])
  • array $properties: массив свойств элемента
  • integer $pos: позиция элемента
ModifyPropertyType (line 3251)

Изменить тип свойства

  • return: результат опреации
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: массив дополнительных параметров свойства
MoveCategory (line 1197)

Переместить категорию

  • return: идентификатор перемещённой категории
integer MoveCategory (integer $new_cID)
  • integer $new_cID: идентификатор новой категории предка
MoveItem (line 2647)

Переместить элемент

  • return: массив идентификаторов перемещённых категорий
array MoveItem ([integer $new_cID = ""], mixed $bMove)
  • integer $new_cID: идентификатор новой категории предка
PopUp (line 3742)

Всплывать по категориям к корню

array PopUp (integer $cID)
  • integer $cID: идентификатор категории
PrepareProperties (line 4618)

Экранировать свойства для записи в БД

void PrepareProperties (array &$properties)
  • array &$properties: массив свойств
PrepareProperty (line 4630)

Экранировать значение свойства для записи в БД

void PrepareProperty (mixed &$value, integer $ptypeID)
  • mixed &$value: значение свойства (строка/массив)
  • integer $ptypeID: ptypeID
ResetCachedItems (line 4608)

Очистить массив закешированных для текущего соединения элементов

void ResetCachedItems ()
ResetCategoriesFilter (line 2024)

Сбросить фильтер выборки категорий

  • return: результат сброса фильтра
boolean ResetCategoriesFilter ()
ResetConnection (line 306)

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

bool ResetConnection (integer $connectionID)
  • integer $connectionID: ID соединения
ResetFilter (line 4449)

Сбросить фильтер выборки

  • return: результат сброса фильтра
boolean ResetFilter (bool $bItem)
  • bool $bItem: флаг фильтра выборки элементов
ResetItemsFilter (line 2727)

Сбросить фильтер выборки элементов

  • return: результат сброса фильтра
boolean ResetItemsFilter ()
ResetItemsSorting (line 2462)

Сбрасывает фильтр сортировки для выборки элементов

void ResetItemsSorting ()
ResetStatusParams (line 927)

Сбросить параметры статуса соединения

void ResetStatusParams (array &$status)
  • array &$status: массив статуса соединения
RootCategory (line 737)

Установить/получить текущую корневую категорию

  • return: идентификатор установленной корневой категории
integer RootCategory ([integer $cID = "get"])
  • integer $cID: идентификатор категории
SaveStatus (line 4263)

Сохранить состояние модуля

void SaveStatus ()
SetActiveConnection (line 350)

Устанавливает активное соединение

bool SetActiveConnection (integer $connectionID)
  • integer $connectionID: ID соединения
SetCachedCategories (line 4585)

Установить массив закешированных для текущего соединения категорий

void SetCachedCategories (mixed &$ctgrs)
SetCachedItems (line 4598)

Установить массив закешированных для текущего соединения элементов

void SetCachedItems (mixed &$items)
SetCategoriesFilter (line 2013)

Установить фильтер выборки для категорий

  • return: результат операции установки фильтра
boolean SetCategoriesFilter (string $ptypeName, string $value, [bool $bExact = 1], [string $condition = ""], [string $operand = ""])
  • string $ptypeName: наименование типа свойства
  • string $value: значение свойства
  • bool $bExact: флаг точного совпадения значения свойства
  • string $condition: условие отбора
  • string $operand: операнд следующего условия отбора
SetFilter (line 4399)

Установить фильтер выборки для категорий/элементов

  • return: результат операции установки фильтра
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: операнд следующего условия отбора (И,ИЛИ)
SetItemsFilter (line 2665)

Установить фильтр выборки для элементов

  • return: результат операции установки фильтра
boolean SetItemsFilter (string $ptypeName, string $value, [boolean $bExact = 1], [string $condition = ""], [string $operand = ""])
  • string $ptypeName: наименование типа свойства
  • string $value: значение свойства
  • boolean $bExact: флаг точного совпадения значения свойства
  • string $condition: условие отбора
  • string $operand: операнд следующего условия
SetItemsLimit (line 4350)

Установить максимальное число выборки элементов категории

  • return: максимальное число выборки элементов категории
integer SetItemsLimit (integer $new)
  • integer $new: максимальное число выборки элементов категории
SetItemsOffset (line 4377)

Установить максимальный сдвиг выборки элементов категории

  • return: максимальный сдвиг выборки элементов
integer SetItemsOffset (bool $new)
  • bool $new: максимальный сдвиг выборки элементов
SetItemsRandomSorting (line 2434)

Случайная сортировка эелментов

void SetItemsRandomSorting ([bool $random = true])
  • bool $random: установка флага случайной сортировки
SetItemsRange (line 4310)

Установить массив множества идентификаторов элементов доступных для выборки

  • return: результат выполнения операции
boolean SetItemsRange ([array $arr_iIDs = ''])
  • array $arr_iIDs: массив идентификаторов элементов
SetItemsSearchFilter (line 2675)

Установить фильтры выборки для элементов категории поиска

void SetItemsSearchFilter ()
SetItemsSorting (line 2404)

Добавляет фильтр сортировки для выборки элементов

boolean SetItemsSorting ([string $ptypeName = ''], [string $direction = ''])
  • string $ptypeName: Имя типа свойства
  • string $direction: Направление сортировки (DESC, ASC)
SetPropertyMultipleValue (line 3004)

Установить массив значений множетсвенного свойства

  • return: результат выполнения операции
boolean SetPropertyMultipleValue (integer $ptypeID, integer $ID, array $value)
  • integer $ptypeID: Идентификатор типа свойства
  • integer $ID: Идентификатор категории/элемента
  • array $value: Массив значений свойства
ShiftCategory (line 1329)

Передвинуть категорию вверх/вниз по списку

  • return: Результат
boolean ShiftCategory (integer $bDirectionUp)
  • integer $bDirectionUp: флаг направления перемещения ( 0 - вниз, 1 - вверх)
ShiftItem (line 2199)

Перемесить товар вверх/вниз по списку

  • return: результат выполнения операции
boolean ShiftItem (integer $bDirectionUp)
  • integer $bDirectionUp: направление перемещения (1 - перемещение вверх,0 - перемещение вверх)
ShiftPropertyType (line 3546)

Сдвиг типа свойств

void ShiftPropertyType (integer $ptypeID, [integer $bDirectionUp = 1])
  • integer $ptypeID: идентификатор типа свойств
  • integer $bDirectionUp: направление сдвика (0 - вниз, 1 - вверх)
ShowHiddenCategories (line 4181)

Показывать скрытые категории

  • return: установленный флаг
boolean ShowHiddenCategories ([boolean $bAction = 'GET'])
  • boolean $bAction: устанавливаемый флаг (1 - показывать,0 - не показывать)
ShowSystemProperties (line 4198)

Показывать системные свойства

  • return: установленный флаг
boolean ShowSystemProperties ([boolean $bAction = 'GET'])
  • boolean $bAction: устанавливаемый флаг (1 - показывать,0 - не показывать)
UpdateAllConnections (line 942)

Обновить параметры статусов всех действующих соединений

void UpdateAllConnections ()
UpdatePType (line 3047)

Добавляет/обновляет тип свойства в массиве из базы

void UpdatePType (object объекта &$db, integer $ptypeID)
  • object объекта &$db: класса доступа к базе данных
  • integer $ptypeID: ID типа свойств

Documentation generated on Wed, 21 Mar 2007 17:35:20 +0300 by phpDocumentor 1.3.0RC3