Docs For Class MyModule

MyModule

Description

Абстрактный класс определяющий базовую функциональность модулей ITWEB.

abstract:

Located in /itweb/lib/class.mymodule.php (line 17)

Direct descendents

Class	Description
Advert	Базовый класс модуля "Рекламные акции"
Backup	Базовый класс модуля "Резервные копии"
Catalog	Базовый класс модуля "Каталог товаров/услуг"
Clients	Базовый класс модуля "Клиенты"
Content	Базовый класс модуля "Материалы сайта"
Enum	Абстрактный класс определяющий базовую функциональность модулей ITWEB.
FileManager	Абстрактный класс определяющий базовую функциональность модулей ITWEB.
Forms	Абстрактный класс определяющий базовую функциональность модулей ITWEB.
Gallery	Базовый класс модуля "Фотогалерея"
History	Базовый класс модуля "Журнал событий"
HtmlExport	Базовый класс модуля "HTML Экспорт"
Modules	Базовый класс модуля "Каталог товаров/услуг"
News	Базовый класс модуля "Новости"
Order	Базовый класс модуля "Заказы"
Orderstat	Базовый класс модуля "Отчёты по продажам"
Spam	Базовый класс модуля "Почтовые рассылки"
Structure	Базовый класс модуля "Страницы и структура"
Support	Базовый класс модуля "Техническая поддержка"
Template	Базовый класс модуля "Шаблоны дизайна"
Update	Базовый класс модуля "Обновления"
Users	Базовый класс модуля "Пользователи"
Vacancy	Базовый класс модуля "Вакансии"
Views	Базовый класс модуля "Виды модулей"

Variable Summary

string $connectionID

string $name

string $oITWEB

object $oMyCatalog

object $prps

string $view_php_funcPrefix

Method Summary

MyModule MyModule ()

void AddCategoriesPropertiesTables ()

int 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)

void AddItemsPropertiesTables ()

boolean 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 = ''])

void BuildPropertyTypesMap ()

void CheckDelResourceProperty (mixed $ptypeID)

void CheckElementResources (bool $bItem, array &$properties)

void CheckModifyResourceProperty (integer &$ptypeID, string &$name, integer &$dtypeID, integer &$inherit, integer &$item, integer &$system, integer &$required, integer &$multiple, integer &$separate, string &$default, string &$condition, string &$extended, string &$comment, string &$group, array &$options, bool 15, array 16)

void ClearCategoriesPropertiesCache ()

array CopyCategory (integer $new_cID, boolean $bMove)

boolean CopyFileProperties (bool $bItem)

array CopyItem ([integer $new_cID = ""], boolean $bMove)

integer CountItems (boolean $bWithSubCategories)

integer CurrentCategory ([integer $cID = "get"])

integer CurrentItem ([integer $iID = "get"], [integer $bChangeCategory = 1])

boolean CurrentModule ([integer $mID = 'get'])

void DelCategoriesPropertiesTables ()

integer DelCategory ()

void DelDataType (integer $dtypeID)

void DelElementResources (bool $bItem)

boolean DelItem ()

void DelItemsPropertiesTables ()

void DelPropertiesTables ()

boolean DelPropertyType (integer $ptypeID)

array GetCachedCategories ()

string GetCacheDir ()

array GetCachedItems ()

array GetCategories ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $CntItems)

string GetCategoriesFilter ()

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

object объект &GetCurrentModule ([mixed $bClean = false])

array GetDataType (integer $dtypeID)

void GetDataTypes ()

string GetFileDir (boolean $bRelative, [string $fileDir = ''])

string GetFilter (bool $bItem)

integer GetFirstChild ()

string GetImgDir (boolean $bRelative, [string $imgDir = ''])

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

object объект GetModuleProperties (integer $mID, [string $modName = ''])

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)

void Init (object объект &$oITWEB, object объект &$oMyCatalog)

boolean isCategoryContainsCategory (int $cID_parent, int $cID_child)

integer isCategoryExist (string $name, [boolean $bAll = 1])

bool isCategoryLeaf ()

integer isCategoryPropertyTypeExist (string $ptypeName)

bool isCategorySearch ()

bool isCategorySystem ()

integer isDataTypeExist (string $name)

integer isItemExist (string $name, boolean $bWithSubCategories)

integer isItemPropertyTypeExist (string $ptypeName)

integer isPropertyTypeExist (boolean $bItem, string $ptypeName)

object объект &LoadModule (string $name, integer $mID, [boolean $bStatic = 1])

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 = ''])

int MoveCategory (integer $new_cID)

array MoveItem ([integer $new_cID = ""], mixed $bMove)

array PopUp (integer $cID)

void ResetCachedItems ()

booleand ResetCategoriesFilter ()

boolean ResetFilter (bool $bItem)

boolean ResetItemsFilter ()

void ResetItemsSorting ()

integer RootCategory ([integer $cID = "get"])

void SaveStatus ()

void SetCachedCategories (mixed &$ctgrs)

void SetCachedItems (mixed &$items)

boolean SetCategoriesFilter (string $ptypeName, string $value, [booleand $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)

boolean SetItemsRange ([array $arr_iIDs = ""])

void SetItemsSearchFilter ()

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)

boolean ShowHiddenCategories ([boolean $bAction = "GET"])

boolean ShowSystemProperties ([boolean $bAction = "GET"])

Variables

string $connectionID (line 30)

Идентификатор соединения с MyCatalog

string $name (line 48)

Имя модуля

Redefined in descendants as:

Advert::$name : Имя модуля
Backup::$name : Имя модуля
Catalog::$name : Имя модуля
Clients::$name : Имя модуля
Content::$name : Имя модуля
Enum::$name : Имя модуля
FileManager::$name
Forms::$name
Gallery::$name : Имя модуля
History::$name : Имя модуля
HtmlExport::$name : Имя модуля
Modules::$name : Имя модуля
News::$name : Имя модуля
Order::$name : Имя модуля
Orderstat::$name : Имя модуля
Spam::$name : Имя модуля
Structure::$name : Имя модуля
Support::$name : Имя модуля
Template::$name : Имя модуля
Update::$name : Имя модуля
Users::$name : Имя модуля
Vacancy::$name : Имя модуля
Views::$name : Имя модуля

string $oITWEB (line 36)

Объект класса ITWEB или наследованного от ITWEB

object $oMyCatalog (line 24)

Объект класса MyCatalog

object $prps = array() (line 42)

Свойства модуля

string $view_php_funcPrefix = 'GetTemplate_' (line 54)

Префикс имени функций PHP процесса вывода модуля в FrontOffice

Methods

Constructor MyModule (line 61)

Конструктор.

MyModule MyModule ()

AddCategoriesPropertiesTables (line 596)

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

void AddCategoriesPropertiesTables ()

AddCategory (line 693)

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

return: Идентификатор новой категории

int AddCategory ([string $name = ""], boolean $isNewLevel, boolean $isHidden, boolean $isSearch, integer $ncID)

string $name: Наименование категории
boolean $isNewLevel: Флаг подкатегории текущеу категории
boolean $isHidden: Флаг скрытой ктаегории
boolean $isSearch: Флаг категории поиска
integer $ncID: Идентификатор создаваемой категории

Redefined in descendants as:

AdminEnum::AddCategory() : Добавить новую категорию

AddDataType (line 1626)

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

return: идентификатор нового типа данных

integer AddDataType (string $name, string $storage, string $code, [string $extra = ""])

string $name: название типа данных
string $storage: название таблицы или идентификатор категории, в которой будет храниться тип данных
string $code: код типа данных
string $extra: дополнительные сведения

AddItem (line 1014)

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

return: Идентификатор элемента

integer AddItem ([string $name = ""], integer $iID)

string $name: Наименование элемента
integer $iID: Идентификатор элемента

Redefined in descendants as:

Order::AddItem() : Добавить новый элемент

AddItemsPropertiesTables (line 608)

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

void AddItemsPropertiesTables ()

AddPropertiesTables (line 584)

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

return: результат выполнения операции

boolean AddPropertiesTables ()

AddPropertyType (line 1404)

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

return: идентификатор свойства

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: массив дополнительных параметров свойства

BuildPropertyTypesMap (line 1608)

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

void BuildPropertyTypesMap ()

CheckDelResourceProperty (line 422)

void CheckDelResourceProperty (mixed $ptypeID)

CheckElementResources (line 201)

При изменении свойств элемента/категории - проверка на изменение значений свойств типа файл/изображение

void CheckElementResources (bool $bItem, array &$properties)

bool $bItem: флаг 1 - элемент, 0 - категория
array &$properties: массив свойств

CheckModifyResourceProperty (line 300)

При изменении параметров свойства типа изображение/файл - обновление относящихся к нему элементов/категорий

bool 15: флаг 1 - элемент, 0 - категория
array 16: массив свойств
integer &$ptypeID: ID свойства
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 2199)

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

void ClearCategoriesPropertiesCache ()

CopyCategory (line 760)

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

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

array CopyCategory (integer $new_cID, boolean $bMove)

integer $new_cID: идентификатор новой категории предка
boolean $bMove: флаг перемещения категории

Redefined in descendants as:

AdminCatalog::CopyCategory() : Скопировать категорию

CopyFileProperties (line 775)

Скопировать свойства элемента типа данных файл/изображение

return: результат выполнения операции

boolean CopyFileProperties (bool $bItem)

bool $bItem: Флаг копирования свойств элемента

CopyItem (line 1221)

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

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

array CopyItem ([integer $new_cID = ""], boolean $bMove)

integer $new_cID: идентификатор новой категории предка
boolean $bMove: флаг перемещения элемента

CountItems (line 1205)

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

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

integer CountItems (boolean $bWithSubCategories)

boolean $bWithSubCategories: включая подкатегории (0 - только в текущей категории, 1 - включая подкатегории текущей категории)

CurrentCategory (line 806)

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

return: идентификатор категории или FALSE в случае неудачи

integer CurrentCategory ([integer $cID = "get"])

integer $cID: идентификатор категории

CurrentItem (line 1082)

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

return: идентификатор элемента или FALSE в случае неудачи

integer CurrentItem ([integer $iID = "get"], [integer $bChangeCategory = 1])

integer $iID: идентификатор элемента
integer $bChangeCategory: изменять категорию, которой принадлежит данный элемент

CurrentModule (line 128)

Установить текущий модуль

return: результат выполнения операции

boolean CurrentModule ([integer $mID = 'get'])

integer $mID: ID модуля

DelCategoriesPropertiesTables (line 633)

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

void DelCategoriesPropertiesTables ()

DelCategory (line 707)

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

return: Идентификатор новой категории

integer DelCategory ()

DelDataType (line 1640)

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

void DelDataType (integer $dtypeID)

integer $dtypeID: идентификатор типа данных

DelElementResources (line 156)

Удалить все файлы свойств типа изображение/файла текущего элемента/категории

void DelElementResources (bool $bItem)

bool $bItem: флаг 1 - элемент, 0 - категория

DelItem (line 1028)

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

return: результат операции удаления

boolean DelItem ()

Redefined in descendants as:

AdminBackup::DelItem() : Удалить текущий элемент

DelItemsPropertiesTables (line 645)

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

void DelItemsPropertiesTables ()

DelPropertiesTables (line 621)

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

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

void DelPropertiesTables ()

DelPropertyType (line 1453)

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

return: результат выполнения операции

boolean DelPropertyType (integer $ptypeID)

integer $ptypeID: идентификатор типа свойства

GetCachedCategories (line 2131)

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

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

array GetCachedCategories ()

GetCacheDir (line 2179)

Возвращает папку кэша для текущего сайта

return: путь папки кэша для текущего сайта

string GetCacheDir ()

GetCachedItems (line 2142)

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

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

array GetCachedItems ()

GetCategories (line 868)

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

return: массив идентификаторов выбранных элементов

array GetCategories ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $CntItems)

integer $type
: тип выборки
1. - выбрать категории текущего уровня
2. - выбрать все подкатегории текущей категории (включая текущую категорию)
3. - выбрать все категории и подкатегории, начиная с корневой
integer $getPrps
: тип выборки свойств элементов
1. - массив элементов со всеми свойствами
2. - массив идентификаторов элементов
3. - массив элементов с ограниченным набором свойств, заданным в $ptypeNames
string $ptypeNames: строка наименований типов свойств, разделённая запятыми
boolean $bExtractMultipleValues: флаг извлечения многозначных свойств (замедляет работу)
boolean $CntItems: флаг подсчёта элементов категорий

Redefined in descendants as:

Modules::GetCategories() : Сделать выборку категорий

GetCategoriesFilter (line 999)

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

return: фильр категорий

string GetCategoriesFilter ()

GetCategory (line 823)

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

return: массив свойств категории

array GetCategory (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)

GetCategoryID (line 1736)

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

return: идентификатора категории

integer GetCategoryID (integer $lft)

integer $lft: значение левого идентификатора

GetCategoryLight (line 839)

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

return: массив свойств категории (краткий)

array GetCategoryLight (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)

GetCategoryProperties (line 908)

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

return: массив свойств категории

array GetCategoryProperties (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)

GetCategoryPropertiesLight (line 923)

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

return: массив свойств категории (краткий)

array GetCategoryPropertiesLight (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств категории в кратком формате(в виде ассоциативного массива)

GetCategoryProperty (line 938)

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

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

mixed GetCategoryProperty (string $name)

string $name: наименование свойства

GetCategoryPropertyTypes (line 1540)

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

array GetCategoryPropertyTypes (integer $getPrps)

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

GetCategoryPropertyTypesLight (line 1558)

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

array GetCategoryPropertyTypesLight (integer $getPrps)

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

GetCurrentLevel (line 1708)

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

return: уровень категории

integer GetCurrentLevel ()

GetCurrentModule (line 114)

Вернуть объект класса текущего модуля

return: текущего модуля

object объект &GetCurrentModule ([mixed $bClean = false])

GetDataType (line 1655)

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

return: массив свойств типа данных

array GetDataType (integer $dtypeID)

integer $dtypeID: идентификатор типа данных

GetDataTypes (line 1667)

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

void GetDataTypes ()

GetFileDir (line 532)

Получить путь к папке файлов модуля

return: путь к папке файлов модуля

string GetFileDir (boolean $bRelative, [string $fileDir = ''])

boolean $bRelative: TRUE - относительный, FALSE - абсолютный
string $fileDir: устанавливае путь к папке файлов модуля

Redefined in descendants as:

AdminFileManager::GetFileDir()
AdminHtmlExport::GetFileDir() : Получить путь к папке файлов модуля
Views::GetFileDir() : Получить путь к папке файлов модуля

GetFilter (line 2118)

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

return: условие для выборки

string GetFilter (bool $bItem)

bool $bItem: флаг фильтра выборки элементов

GetFirstChild (line 881)

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

return: идентификатор первой подкатегории текущей категории

integer GetFirstChild ()

GetImgDir (line 514)

Получить путь к папке изображений модуля

return: путь к папке изображений модуля

string GetImgDir (boolean $bRelative, [string $imgDir = ''])

boolean $bRelative: TRUE - относительный, FALSE - абсолютный
string $imgDir: устанавливае путь к папке изображений модуля

Redefined in descendants as:

AdminModules::GetImgDir() : Возвращает путь к изображению.

GetItem (line 1156)

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

return: массив элемент с полным перечнем его свойств

array GetItem (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)

GetItemLight (line 1171)

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

return: массив элемент с полным перечнем его свойств

array GetItemLight (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)

GetItemPosition (line 1305)

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

integer GetItemPosition ()

GetItemProperties (line 1096)

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

return: массив свойств элемента

array GetItemProperties (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)

GetItemPropertiesLight (line 1110)

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

return: массив свойств элемента (краткий)

array GetItemPropertiesLight (boolean $bAssociative)

boolean $bAssociative: флаг выввода свойств элемента в кратком формате(в виде ассоциативного массива)

GetItemProperty (line 1126)

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

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

mixed GetItemProperty (string $name)

string $name: наименование свойства

GetItemPropertyEx (line 1141)

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

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

mixed GetItemPropertyEx (string $name)

string $name: наименование свойства

GetItemPropertyTypes (line 1576)

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

array GetItemPropertyTypes (integer $getPrps)

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

GetItemPropertyTypesLight (line 1594)

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

array GetItemPropertyTypesLight (integer $getPrps)

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

GetItems (line 1190)

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

return: массив идентификаторов выбранных элементов

array GetItems (integer $bWithSubCategories, integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues)

integer $bWithSubCategories: флаг выборки элементов, включая подкатегории текущей ктаегории
integer $getPrps: (не используется)
string $ptypeNames: (не используется)
boolean $bExtractMultipleValues: флаг извлечения многозначных свойств

Redefined in descendants as:

Catalog::GetItems() : GetItems Сделать выборку элементов
Support::GetItems() : GetItems Сделать выборку элементов

GetItemsFilter (line 1292)

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

return: фильтр выборки элементов

string GetItemsFilter ()

GetItemsLimit (line 2025)

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

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

integer GetItemsLimit ()

GetItemsOffset (line 2052)

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

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

integer GetItemsOffset ()

GetItemsRange (line 1997)

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

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

array GetItemsRange ()

GetItemsSorting (line 2168)

void GetItemsSorting ()

GetMaxCategory (line 1750)

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

return: правый идентификатор категории

integer GetMaxCategory ()

GetMaxCategoryID (line 1764)

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

return: идентификатор последней категории в каталоге

integer GetMaxCategoryID ()

GetMaxItem (line 1792)

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

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

integer GetMaxItem ()

GetMaxLevel (line 1721)

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

return: уровень максимальной вложенности каталога

integer GetMaxLevel ()

GetMinItem (line 1778)

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

return: позиция первого элемента в текущей категории

integer GetMinItem ()

GetModuleProperties (line 143)

Получить свойства модуля

return: модуля

object объект GetModuleProperties (integer $mID, [string $modName = ''])

integer $mID: ID модуля
string $modName: имя модуля

Redefined in descendants as:

Modules::GetModuleProperties() : Получить свойства модуля

GetParentCategory (line 893)

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

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

integer GetParentCategory ()

GetProperties (line 1321)

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

return: массив свойств

array GetProperties (boolean $bItem, boolean $bAssociative, boolean $bLight)

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

GetPropertyByName (line 1341)

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

array GetPropertyByName (boolean $bItem, string $ptypeName, boolean $bExtented)

boolean $bItem: флаг элемента
string $ptypeName: наименование свойства
boolean $bExtented: флаг расширенных параметров свойства

GetPropertyMultipleValue (line 1358)

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

return: значение множественного свойства

array GetPropertyMultipleValue (integer $ptypeID, integer $ID)

integer $ptypeID: Идентификатор типа свойства
integer $ID: Идентификатор категории/элемента

GetPropertyType (line 1470)

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

return: массив свойст свойства

array GetPropertyType (integer $ptypeID)

integer $ptypeID: идентификатор типа свойства

GetPropertyTypeGroups (line 1507)

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

array GetPropertyTypeGroups (boolean $bItem, boolean $bAssociative, [boolean $bExplode = 1])

boolean $bItem: флаг типов свойств элементов текущей категории
boolean $bAssociative: использовать в качестве ключей массива наименование типов свойств
boolean $bExplode: разбивать группы свойств на погдруппы

GetPropertyTypes (line 1490)

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

array GetPropertyTypes (boolean $bItem, integer $getPrps, boolean $bLight)

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

Redefined in descendants as:

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

GetRootCategory (line 674)

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

return: идентификатор установленной корневой категории

integer GetRootCategory (integer 0)

integer 0: установливаемый идентификатор корневой категории

Init (line 73)

Инициализация модуля

void Init (object объект &$oITWEB, object объект &$oMyCatalog)

object объект &$oITWEB: класса ITWEB или наследованного от ITWEB
object объект &$oMyCatalog: класса MyCatalog

isCategoryContainsCategory (line 1698)

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

return: результат выполнения операции

boolean isCategoryContainsCategory (int $cID_parent, int $cID_child)

int $cID_parent: идентификатор родительской категории
int $cID_child: идентификатор дочерней категории

isCategoryExist (line 1808)

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

return: Идентификатор категории или false

integer isCategoryExist (string $name, [boolean $bAll = 1])

string $name: Наименование категории
boolean $bAll: Флаг поиска по всем категориям

isCategoryLeaf (line 1839)

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

bool isCategoryLeaf ()

isCategoryPropertyTypeExist (line 1896)

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

return: идентификатор типа свойства или false

integer isCategoryPropertyTypeExist (string $ptypeName)

string $ptypeName: имя типа свойства

isCategorySearch (line 1866)

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

bool isCategorySearch ()

isCategorySystem (line 1853)

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

bool isCategorySystem ()

isDataTypeExist (line 1926)

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

return: идентификатор типа данных

integer isDataTypeExist (string $name)

string $name: имя типа данных

isItemExist (line 1824)

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

return: Идентификатор элемента или false

integer isItemExist (string $name, boolean $bWithSubCategories)

string $name: Наименование элемента
boolean $bWithSubCategories: Флаг поиска по подкатегориям текущей категории

isItemPropertyTypeExist (line 1911)

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

return: идентификатор типа свойства или false

integer isItemPropertyTypeExist (string $ptypeName)

string $ptypeName: имя типа свойства

isPropertyTypeExist (line 1882)

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

return: идентификатор типа свойства или false

integer isPropertyTypeExist (boolean $bItem, string $ptypeName)

boolean $bItem: флаг типа свойства элемента
string $ptypeName: имя типа свойства

LoadModule (line 101)

Загрузка модуля

return: загруженного модуля

object объект &LoadModule (string $name, integer $mID, [boolean $bStatic = 1])

string $name: имя модуля
integer $mID: идентификатор модуля
boolean $bStatic: очищать загружаемый модуль

Redefined in descendants as:

Modules::LoadModule() : Загрузка модуля

LoadStatus (line 1970)

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

void LoadStatus ()

ModifyCategory (line 725)

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

return: результат

boolean ModifyCategory (array $properties)

array $properties: массив новых свойств категории

Redefined in descendants as:

AdminViews::ModifyCategory() : Изменить категорию

ModifyItem (line 1047)

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

return: результат выполнения операции

boolean ModifyItem (array $properties, [integer $pos = null])

array $properties: массив свойств элемента
integer $pos: позиция элемента

Redefined in descendants as:

Clients::ModifyItem() : Изменить элемент
Order::ModifyItem() : Изменить элемент
AdminViews::ModifyItem() : Изменить элемент

ModifyPropertyType (line 1433)

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

return: результат опреации

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 744)

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

return: идентификатор перемещённой категории

int MoveCategory (integer $new_cID)

integer $new_cID: идентификатор новой категории предка

MoveItem (line 1236)

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

return: массив идентификаторов перемещённых категорий

array MoveItem ([integer $new_cID = ""], mixed $bMove)

integer $new_cID: идентификатор новой категории предка

PopUp (line 1681)

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

array PopUp (integer $cID)

integer $cID: идентификатор категории

ResetCachedItems (line 2188)

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

void ResetCachedItems ()

ResetCategoriesFilter (line 986)

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

return: результат сброса фильтра

booleand ResetCategoriesFilter ()

ResetFilter (line 2103)

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

return: результат сброса фильтра

boolean ResetFilter (bool $bItem)

bool $bItem: флаг фильтра выборки элементов

ResetItemsFilter (line 1279)

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

return: результат сброса фильтра

boolean ResetItemsFilter ()

ResetItemsSorting (line 570)

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

void ResetItemsSorting ()

RootCategory (line 659)

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

return: идентификатор установленной корневой категории

integer RootCategory ([integer $cID = "get"])

integer $cID: идентификатор категории

SaveStatus (line 1983)

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

void SaveStatus ()

SetCachedCategories (line 2152)

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

void SetCachedCategories (mixed &$ctgrs)

SetCachedItems (line 2162)

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

void SetCachedItems (mixed &$items)

SetCategoriesFilter (line 974)

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

return: результат операции установки фильтра

boolean SetCategoriesFilter (string $ptypeName, string $value, [booleand $bExact = 1], [string $condition = ""], [string $operand = ""])

string $ptypeName: наименование типа свойства
string $value: значение свойства
booleand $bExact: флаг точного совпадения значения свойства
string $condition: условие отбора
string $operand: операнд следующего условия отбора

SetFilter (line 2088)

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

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 1255)

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

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 2039)

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

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

integer SetItemsLimit (integer $new)

integer $new: максимальное число выборки элементов категории

SetItemsOffset (line 2066)

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

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

integer SetItemsOffset (bool $new)

bool $new: максимальный сдвиг выборки элементов

SetItemsRandomSorting (line 560)

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

void SetItemsRandomSorting (bool $random)

bool $random: установка флага случайной сортировки

SetItemsRange (line 2012)

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

return: результат выполнения операции

boolean SetItemsRange ([array $arr_iIDs = ""])

array $arr_iIDs: массив идентификаторов элементов

SetItemsSearchFilter (line 1266)

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

void SetItemsSearchFilter ()

SetItemsSorting (line 549)

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

return: результат выполнения операции

boolean SetItemsSorting ([string $ptypeName = ''], [string $direction = ''])

string $ptypeName: имя типа свойства
string $direction: направление сортировки (DESC, ASC)

SetPropertyMultipleValue (line 1375)

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

return: результат выполнения операции

boolean SetPropertyMultipleValue (integer $ptypeID, integer $ID, array $value)

integer $ptypeID: Идентификатор типа свойства
integer $ID: Идентификатор категории/элемента
array $value: Массив значений свойства

ShiftCategory (line 790)

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

return: Результат

boolean ShiftCategory (integer $bDirectionUp)

integer $bDirectionUp: флаг направления перемещения ( 0 - вниз, 1 - вверх)

ShiftItem (line 1066)

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

return: результат выполнения операции

boolean ShiftItem (integer $bDirectionUp)

integer $bDirectionUp: направление перемещения (1 - перемещение вверх,0 - перемещение вверх)

ShiftPropertyType (line 1522)

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

void ShiftPropertyType (integer $ptypeID, integer $bDirectionUp)

integer $ptypeID: идентификатор типа свойств
integer $bDirectionUp: направление сдвика (0 - вниз, 1 - вверх)

ShowHiddenCategories (line 1943)

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

return: установленный флаг

boolean ShowHiddenCategories ([boolean $bAction = "GET"])

boolean $bAction: устанавливаемый флаг (1 - показывать,0 - не показывать)

ShowSystemProperties (line 1958)

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

return: установленный флаг

boolean ShowSystemProperties ([boolean $bAction = "GET"])

boolean $bAction: устанавливаемый флаг (1 - показывать,0 - не показывать)

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